formpayload

package

v0.1.0-alpha.3 Latest Latest Go to latest Published: Sep 13, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Braidplane/cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ContractData(form *FormData) ([]string, []map[string]any)
type ContractField
- func ContractFields(form *FormData) []ContractField
type FormData
- func ParseMultipartFormBody(contentType string, body []byte, maxMemory int64) (*FormData, error)
- func ParseURLEncodedFormBody(body []byte) (*FormData, error)
- func (data *FormData) Clone() *FormData
type FormField
type FormFile

Constants ¶

View Source

const (
	// FormEncodingMultipart identifies multipart/form-data payloads.
	FormEncodingMultipart = "multipart/form-data"
	// FormEncodingURLEncoded identifies application/x-www-form-urlencoded payloads.
	FormEncodingURLEncoded = "application/x-www-form-urlencoded"
)

Variables ¶

This section is empty.

Functions ¶

func ContractData ¶

func ContractData(form *FormData) ([]string, []map[string]any)

ContractData returns a metadata-only row view suitable for contract validation.

Types ¶

type ContractField ¶

type ContractField struct {
	Name string
	Type model.ContractFieldType
}

ContractField describes the contract shape derived from one or more form parts.

func ContractFields ¶

func ContractFields(form *FormData) []ContractField

ContractFields summarizes form part names into contract fields.

type FormData ¶

type FormData struct {
	Encoding  string      `json:"encoding,omitempty"`
	Fields    []FormField `json:"fields,omitempty"`
	Files     []FormFile  `json:"files,omitempty"`
	SizeBytes int64       `json:"size_bytes,omitempty"`
}

FormData carries runtime form fields and file parts while serializing only safe metadata.

func ParseMultipartFormBody ¶

func ParseMultipartFormBody(contentType string, body []byte, maxMemory int64) (*FormData, error)

ParseMultipartFormBody converts a multipart/form-data HTTP body into payload metadata.

func ParseURLEncodedFormBody ¶

func ParseURLEncodedFormBody(body []byte) (*FormData, error)

ParseURLEncodedFormBody converts a URL-encoded HTTP form body into payload metadata.

func (*FormData) Clone ¶

func (data *FormData) Clone() *FormData

Clone returns a deep copy of form payload metadata and runtime-only values.

type FormField ¶

type FormField struct {
	Name        string   `json:"name"`
	ContentType string   `json:"content_type,omitempty"`
	ValueCount  int      `json:"value_count,omitempty"`
	SizeBytes   int64    `json:"size_bytes,omitempty"`
	Sensitive   bool     `json:"sensitive,omitempty"`
	Values      []string `json:"-" yaml:"-"`
}

FormField describes one named scalar form field.

type FormFile ¶

type FormFile struct {
	Name        string `json:"name"`
	Filename    string `json:"filename,omitempty"`
	ContentType string `json:"content_type,omitempty"`
	SizeBytes   int64  `json:"size_bytes,omitempty"`
	SHA256      string `json:"sha256,omitempty"`
	Content     []byte `json:"-" yaml:"-"`
}

FormFile describes one named file form part.

Source Files ¶

View all Source files

form.go

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