flags

Documentation

Overview

SPDX-FileCopyrightText: 2026 Outscale SAS <opensource@outscale.com>

SPDX-License-Identifier: BSD-3-Clause

SPDX-FileCopyrightText: 2026 Outscale SAS <opensource@outscale.com>

SPDX-License-Identifier: BSD-3-Clause

Index

• Variables
• type Builder
  • func NewBuilder(cfg config.Config, opts ...Option) *Builder
  • func (b *Builder) Build(fs *FlagSet, arg reflect.Type, prefix string, allowRequired bool)
• type Enum
• type Flag
• type FlagSet
  • func (fs *FlagSet) Add(f Flag)
• type Normalize
• type Option
  • func RequiredFromPointer(required bool) Option
  • func WithNormalize(fn Normalize) Option

Variables

var NumEntriesInSlices = 1

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

func NewBuilder

func NewBuilder(cfg config.Config, opts ...Option) *Builder

func (*Builder) Build

func (b *Builder) Build(fs *FlagSet, arg reflect.Type, prefix string, allowRequired bool)

type Enum

type Enum interface {
	Values() []string
}

type Flag

type Flag struct {
	Name          string
	FieldPath     string
	Kind          reflect.Kind
	Slice         bool
	Help          string
	Required      bool
	AllowedValues []string
	FlagValue     pflag.Value
}

type FlagSet

type FlagSet []Flag

func (*FlagSet) Add

func (fs *FlagSet) Add(f Flag)

type Normalize

type Normalize func(string) string

type Option

type Option func(*Builder)

func RequiredFromPointer

func RequiredFromPointer(required bool) Option

func WithNormalize

func WithNormalize(fn Normalize) Option