requestflag

package
v0.1.0-alpha.65 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 22, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DateTimeValue

type DateTimeValue string

func (*DateTimeValue) Parse

func (d *DateTimeValue) Parse(s string) error

func (DateTimeValue) String

func (d DateTimeValue) String() string

type DateValue

type DateValue string

Time-related value types

func (*DateValue) Parse

func (d *DateValue) Parse(s string) error

Parse methods for time-related types

func (DateValue) String

func (d DateValue) String() string

String methods for time-related types

type Flag

type Flag[
	T []any | []DateTimeValue | []DateValue | []TimeValue | []string |
		[]float64 | []int64 | []bool | any | DateTimeValue | DateValue | TimeValue |
		string | float64 | int64 | bool,
] struct {
	Name        string        // name of the flag
	Category    string        // category of the flag, if any
	DefaultText string        // default text of the flag for usage purposes
	HideDefault bool          // whether to hide the default value in output
	Usage       string        // usage string for help output
	Required    bool          // whether the flag is required or not
	Hidden      bool          // whether to hide the flag in help output
	Default     T             // default value for this flag if not set by from any source
	Aliases     []string      // aliases that are allowed for this flag
	Validator   func(T) error // custom function to validate this flag value

	QueryPath  string // location in the request query string to put this flag's value
	HeaderPath string // location in the request header to put this flag's value
	BodyPath   string // location in the request body to put this flag's value
	BodyRoot   bool   // if true, then use this value as the entire request body
	// contains filtered or unexported fields
}

Flag [T] is a generic flag base which can be used to implement the most common interfaces used by urfave/cli. Additionally, it allows specifying where in an HTTP request the flag values should be placed (e.g. query, body, etc.).

func (*Flag[T]) Count

func (f *Flag[T]) Count() int

func (*Flag[T]) Get

func (f *Flag[T]) Get() any

func (Flag[T]) GetBodyPath

func (f Flag[T]) GetBodyPath() string

func (*Flag[T]) GetCategory

func (f *Flag[T]) GetCategory() string

func (*Flag[T]) GetDefaultText

func (f *Flag[T]) GetDefaultText() string

func (*Flag[T]) GetEnvVars

func (f *Flag[T]) GetEnvVars() []string

func (Flag[T]) GetHeaderPath

func (f Flag[T]) GetHeaderPath() string

func (Flag[T]) GetQueryPath

func (f Flag[T]) GetQueryPath() string

func (*Flag[T]) GetUsage

func (f *Flag[T]) GetUsage() string

func (*Flag[T]) GetValue

func (f *Flag[T]) GetValue() string

func (Flag[T]) IsBodyRoot

func (f Flag[T]) IsBodyRoot() bool

func (*Flag[T]) IsBoolFlag

func (f *Flag[T]) IsBoolFlag() bool

func (*Flag[T]) IsDefaultVisible

func (f *Flag[T]) IsDefaultVisible() bool

func (*Flag[T]) IsMultiValueFlag

func (f *Flag[T]) IsMultiValueFlag() bool

func (*Flag[T]) IsRequired

func (f *Flag[T]) IsRequired() bool

func (*Flag[T]) IsSet

func (f *Flag[T]) IsSet() bool

func (*Flag[T]) IsVisible

func (f *Flag[T]) IsVisible() bool

func (*Flag[T]) Names

func (f *Flag[T]) Names() []string

func (*Flag[T]) PostParse

func (f *Flag[T]) PostParse() error

func (*Flag[T]) PreParse

func (f *Flag[T]) PreParse() error

func (*Flag[T]) Set

func (f *Flag[T]) Set(_ string, val string) error

func (*Flag[T]) SetCategory

func (f *Flag[T]) SetCategory(c string)

func (*Flag[T]) String

func (f *Flag[T]) String() string

func (*Flag[T]) TakesValue

func (f *Flag[T]) TakesValue() bool

func (*Flag[T]) TypeName

func (f *Flag[T]) TypeName() string

type InRequest

type InRequest interface {
	GetQueryPath() string
	GetHeaderPath() string
	GetBodyPath() string
	IsBodyRoot() bool
}

InRequest interface for flags that should be included in HTTP requests

type RequestContents

type RequestContents struct {
	Queries map[string]any
	Headers map[string]any
	Body    any
}

The values that will be sent in different parts of a request.

func ExtractRequestContents

func ExtractRequestContents(cmd *cli.Command) RequestContents

Extract query parameters, headers, and body values from command flags.

type TimeValue

type TimeValue string

func (*TimeValue) Parse

func (t *TimeValue) Parse(s string) error

func (TimeValue) String

func (t TimeValue) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL