form

form

import "github.com/kitsunium/sdk/pkg/v1/data/codec/form"

Package form registers the application/x-www-form-urlencoded codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134):

import _ "github.com/kitsunium/sdk/pkg/v1/data/codec/form"

The codec reads and writes the encoding every HTML form posts. Its native value is url.Values — map[string][]string and map[string]string are accepted too — because a repeated key is the only array syntax the format has: a body repeating a key decoded into a map[string]string is refused rather than reduced to one value. Through the codec package's Marshal any other value is carried as one JSON-mediated field.

Everything that dispatches through the registry by format name then reads and writes it: the codec package's Marshal and Unmarshal, config.FSSource and i18n.LoadFS. Importing github.com/kitsunium/sdk/pkg/v1/data/codec instead registers every format the SDK ships; this package links this one codec, the core package declaring its codes and the standard library, and nothing else. Importing both is harmless: a format is registered by the package that implements it, which Go initialises once however many packages import it.

Errors

Failures carry the range 0.3.40.*; match them with errs.HasCode, or the sentinels with errors.Is:

CodeValueInvalid     0.3.40.1  the value or the target is not url.Values-shaped
CodeUnmarshalFailed  0.3.40.2  a malformed escape, a ';' separator, or a decode bound exceeded
CodeMultiValue       0.3.40.3  a repeated key decoded into a map[string]string

There is no marshal failure: past the shape check, percent-escaping a map of strings cannot fail.

No error message quotes the input.

Index

• Constants
• Variables

Constants

const CodeMultiValue errs.Code = 206851

CodeMultiValue is 0.3.40.3: a repeated key decoded into a map[string]string.

Initialised with github.com/kitsunium/sdk/internal/core/data/codec/form.CodeFormMultiValue.

Code 0.3.40.3

const CodeSizeExceeded errs.Code = 206852

CodeSizeExceeded is 0.3.40.4: a body past maxFormBytes, or more pairs than maxFormPairs.

Initialised with github.com/kitsunium/sdk/internal/core/data/codec/form.CodeFormSizeExceeded.

Code 0.3.40.4

const CodeUnmarshalFailed errs.Code = 206850

CodeUnmarshalFailed is 0.3.40.2: a malformed escape, a ';' separator, or a decode bound exceeded.

Initialised with github.com/kitsunium/sdk/internal/core/data/codec/form.CodeFormUnmarshalFailed.

Code 0.3.40.2

const CodeValueInvalid errs.Code = 206849

CodeValueInvalid is 0.3.40.1: the value or the target is not url.Values-shaped.

Initialised with github.com/kitsunium/sdk/internal/core/data/codec/form.CodeFormValueInvalid.

Code 0.3.40.1

const Format = "form"

Format is the name the urlencoded form is registered under. It is an untyped constant, so it goes wherever a format name is taken — the codec package's Marshal, config.FSSource's string, i18n.LoadFS's codec.Format — without a conversion.

Variables

var MultiValue *errs.Error

MultiValue is the sentinel of CodeMultiValue.

Initialised with github.com/kitsunium/sdk/internal/core/data/codec/form.MultiValue.

Code 0.3.40.3 · reason MULTI_VALUE · public "form key carries multiple values"

var SizeExceeded *errs.Error

SizeExceeded is the sentinel of CodeSizeExceeded.

Initialised with github.com/kitsunium/sdk/internal/core/data/codec/form.SizeExceeded.

Code 0.3.40.4 · reason SIZE_EXCEEDED · public "Form input exceeds a size limit"

var UnmarshalFailed *errs.Error

UnmarshalFailed is the sentinel of CodeUnmarshalFailed.

Initialised with github.com/kitsunium/sdk/internal/core/data/codec/form.UnmarshalFailed.

Code 0.3.40.2 · reason UNMARSHAL_FAILED · public "form decoding failed"

var ValueInvalid *errs.Error

ValueInvalid is the sentinel of CodeValueInvalid.

Initialised with github.com/kitsunium/sdk/internal/core/data/codec/form.ValueInvalid.

Code 0.3.40.1 · reason VALUE_INVALID · public "form codec requires a url.Values-shaped value"

Generated from docs/api by tools/genindex.