request

type BodyContentType ¶

type BodyContentType int

const (
	EmptyBody BodyContentType = iota
	MultipartFormEncoded
	ApplicationJSON
	ApplicationOctetStream
)

type EncodingHooks ¶

type EncodingHooks struct {
	PrepareMultipart func(map[string]any) error
	ObserveMultipart func(io.Closer)
	ValidateJSON     func([]byte) error
	ObserveJSON      []func([]byte)
}

EncodingHooks retains feature validation and observation at their existing serialization points without making shared request code depend on features.

type FileEmbedStyle ¶

type FileEmbedStyle int

FileEmbedStyle selects text substitution or streaming upload expansion.

const (
	// EmbedText reads referenced files fully into memory and substitutes the file's contents back into the
	// value as a string. Binary files are base64-encoded. Used for JSON request bodies and for headers and
	// query parameters, where the file contents need to be serialized inline.
	EmbedText FileEmbedStyle = iota

	// EmbedIOReader replaces file references with an io.Reader that streams the file's contents. Used for
	// `multipart/form-data` and `application/octet-stream` request bodies, where files are uploaded as binary
	// parts rather than embedded into a text value.
	EmbedIOReader
)

type FileInputSource ¶

type FileInputSource struct {
	Option string
	// contains filtered or unexported fields
}

FileInputSource follows declared request fields through file expansion. It never retains argument values or infers an option from a file path.

func (s FileInputSource) Failure(operation string, err error) error

func (s FileInputSource) OpenUpload(path string) (FileUpload, error)

func (s FileInputSource) ReadFile(path string) ([]byte, error)

type FilePathValue ¶

type FilePathValue string

FilePathValue is a string wrapper that marks a value as a file path whose contents should be read and embedded in the request. A FilePathValue is always interpreted as a file path without needing the "@" prefix.

type FileUpload ¶

type FileUpload struct {
	io.Reader // apiform checks for reader and reads its contents during encode
	FileName  string
	MediaType string
	Size      int64
	KnownSize bool
}

FileUpload wraps an io.Reader with filename and content-type metadata for use as a multipart form part. The apiform encoder detects the Filename and ContentType methods and uses them to populate the Content-Disposition filename and the Content-Type header on the part. The upload owns its Reader; KnownSize distinguishes an exact byte count from an unknown-length source.

func OpenFileUpload(path string) (FileUpload, error)

func (f FileUpload) Close() error

func (f FileUpload) ContentType() string

func (f FileUpload) Filename() string

type HeaderFlag ¶

type HeaderFlag struct {
	requestflag.Flag[[]string]
}

HeaderFlag is the root-owned repeatable flag for literal request headers.

func (*HeaderFlag) IsLocal() bool

type InputFileError ¶

type InputFileError struct {
	Option, Operation string
	// contains filtered or unexported fields
}

InputFileError retains the actual failure and only a declared option name. Its cause remains available through errors.Is, errors.As, and joined errors.

func (e *InputFileError) Error() string

func (e *InputFileError) Unwrap() error

type InputFileReader ¶

type InputFileReader struct {
	io.Reader
	Source FileInputSource
}

InputFileReader annotates read and close failures with a declared option.

func (r *InputFileReader) Close() error

func (r *InputFileReader) Read(p []byte) (int, error)

type MTLSClientFlag ¶

type MTLSClientFlag struct {
	cli.StringFlag
	// contains filtered or unexported fields
}

MTLSClientFlag permits one explicit value, independently of an environment default. The embedded PostParse applies sources without consuming the explicit allowance.

func (f *MTLSClientFlag) CLIStringFlag() *cli.StringFlag

func (f *MTLSClientFlag) PreParse() error

func (f *MTLSClientFlag) Set(name, value string) error

type MultipartScalarError ¶ added in v1.39.1

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

MultipartScalarError retains a scalar read failure behind its declared flag name.

func (e *MultipartScalarError) Error() string

func (e *MultipartScalarError) Unwrap() error

type OnceStdinReader ¶

type OnceStdinReader struct {
	Reader        io.Reader
	FailureReason string
}

OnceStdinReader wraps an io.Reader that can only be consumed once, used to ensure stdin is read by at most one parameter (or only for a body root parameter or only for YAML parameter input). If FailureReason is set, stdin is unavailable and Take() returns an error explaining why.

func (o *OnceStdinReader) ReadAll() ([]byte, error)

func (o *OnceStdinReader) Take() (io.Reader, error)

type PreparationHooks ¶

type PreparationHooks struct {
	PreflightMultipart  func(map[string]any) error
	ValidateCredentials func() error
	// ResolvedJSONOptions inspects finalized inputs before JSON observers run.
	// Literal headers retain precedence over every returned request option.
	ResolvedJSONOptions func(map[string]any, http.Header, []byte) []option.RequestOption
	// EmbedMultipart owns partial-result cleanup on failure. On success, shared
	// preparation takes responsibility for the returned uploads until encoding.
	EmbedMultipart func(map[string]any, *OnceStdinReader) (map[string]any, error)
	Encoding       EncodingHooks
}

PreparationHooks keeps feature validation and multipart specialization with assembly while shared request code owns input precedence and upload cleanup.

type RootRequestFlag ¶

type RootRequestFlag struct {
	*requestflag.Flag[string]
}

RootRequestFlag preserves request metadata while sharing root options with subcommands.

func (*RootRequestFlag) IsLocal() bool

func (f *RootRequestFlag) RequestFlag() *requestflag.Flag[string]

type StdinSecurity ¶

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

StdinSecurity tracks the origin of piped values for one request preparation.

func NewStdinSecurity() (*StdinSecurity, error)

func (s *StdinSecurity) Enabled() bool

func (s *StdinSecurity) ProtectFlagValues(contents *requestflag.RequestContents)

func (s *StdinSecurity) RecordBodyFlags(cmd *cli.Command, data map[string]any)

func (s *StdinSecurity) RecordFlag(flag cli.Flag)

type UntrustedStdinValue ¶

type UntrustedStdinValue string

UntrustedStdinValue preserves a string's origin until the shared file expansion boundary, where its contents are always interpreted literally.