package httpsfv

Import Path
	github.com/dunglas/httpsfv (on go.dev)

Dependency Relation
	imports 12 packages, and imported by one package

Involved Source Files

	    bareitem.go
	    binary.go
	    boolean.go
	    date.go
	    decimal.go
	    decode.go
	    dictionary.go
	    displaystring.go
	  d encode.go
		Package httpsfv implements serializing and parsing
		of Structured Field Values for HTTP as defined in RFC 9651.
		
		Structured Field Values are either lists, dictionaries or items. Dedicated types are provided for all of them.
		Dedicated types are also used for tokens, parameters and inner lists.
		Other values are stored in native types:
		
			int64, for integers
			float64, for decimals
			string, for strings
			byte[], for byte sequences
			bool, for booleans
		
		The specification is available at https://httpwg.org/specs/rfc9651.html.

	    innerlist.go
	    integer.go
	    item.go
	    key.go
	    list.go
	    member.go
	    params.go
	    string.go
	    token.go
	    utils.go
Code Examples

	Marshal
	  {
	  	p := List{NewItem("/member/*/author"), NewItem("/member/*/comments")}
	  
	  	v, err := Marshal(p)
	  	if err != nil {
	  		log.Fatalln("error: ", err)
	  	}
	  
	  	h := http.Header{}
	  	h.Set("Preload", v)
	  
	  	b := new(bytes.Buffer)
	  	_ = h.Write(b)
	  
	  	fmt.Println(b.String())
	  
	  }
	UnmarshalList
	  {
	  	h := http.Header{}
	  	h.Add("Preload", `"/member/*/author", "/member/*/comments"`)
	  
	  	v, err := UnmarshalList(h["Preload"])
	  	if err != nil {
	  		log.Fatalln("error: ", err)
	  	}
	  
	  	fmt.Println("authors selector: ", v[0].(Item).Value)
	  	fmt.Println("comments selector: ", v[1].(Item).Value)
	  
	  }

Package-Level Type Names (total 10)

	/* sort by: alphabet | popularity */
	 type Dictionary (struct)
		Dictionary is an ordered map of name-value pairs.
		See https://httpwg.org/specs/rfc9651.html#dictionary
		Values can be:
		  * Item (Section 3.3.)
		  * Inner List (Section 3.1.1.)

		Methods (total 4)
			(*Dictionary) Add(k string, v Member)
				Add appends a new member to the ordered list.

			(*Dictionary) Del(key string) bool
				Del removes a member from the ordered list.

			(*Dictionary) Get(k string) (Member, bool)
				Get retrieves a member.

			(*Dictionary) Names() []string
				Names retrieves the list of member names in the appropriate order.

		Implements (at least one exported)
			*Dictionary : StructuredFieldValue
		As Outputs Of (at least 2)
			func NewDictionary() *Dictionary
			func UnmarshalDictionary(v []string) (*Dictionary, error)

	 type DisplayString string (basic type)

		Implements (at least one exported)
			 DisplayString : StructuredFieldValue

	 type InnerList (struct)
		InnerList represents an inner list as defined in
		https://httpwg.org/specs/rfc9651.html#inner-list.

		Fields (total 2)
			Items []Item
			Params *Params
		Implements (at least 2)
			 InnerList : Member
			 InnerList : StructuredFieldValue

	 type Item (struct)
		Item is a bare value and associated parameters.
		See https://httpwg.org/specs/rfc9651.html#item.

		Fields (total 2)
			Params *Params
			Value interface{}
		Implements (at least 2)
			 Item : Member
			 Item : StructuredFieldValue
		As Outputs Of (at least 2)
			func NewItem(v interface{}) Item
			func UnmarshalItem(v []string) (Item, error)

	 type List ([])
		List contains items an inner lists.
		
		See https://httpwg.org/specs/rfc9651.html#list

		Implements (at least one exported)
			 List : StructuredFieldValue
		As Outputs Of (at least one exported)
			func UnmarshalList(v []string) (List, error)

	 type Member (interface)
		Member is a marker interface for members of dictionaries and lists.
		
		See https://httpwg.org/specs/rfc9651.html#list.

		Implemented By (at least 2)
			 InnerList
			 Item
		Implements (at least one exported)
			 Member : StructuredFieldValue
		As Outputs Of (at least one exported)
			func (*Dictionary).Get(k string) (Member, bool)
		As Inputs Of (at least one exported)
			func (*Dictionary).Add(k string, v Member)

	 type Params (struct)
		Params are an ordered map of key-value pairs that are associated with an item or an inner list.
		
		See https://httpwg.org/specs/rfc9651.html#param.

		Methods (total 4)
			(*Params) Add(k string, v interface{})
				Add appends a new parameter to the ordered list.
				If the key already exists, overwrite its value.

			(*Params) Del(key string) bool
				Del removes a parameter from the ordered list.

			(*Params) Get(k string) (interface{}, bool)
				Get retrieves a parameter.

			(*Params) Names() []string
				Names retrieves the list of parameter names in the appropriate order.

		Implements (at least one exported)
			*Params : StructuredFieldValue
		As Outputs Of (at least one exported)
			func NewParams() *Params

	 type StructuredFieldValue (interface)
		StructuredFieldValue represents a List, a Dictionary or an Item.

		Implemented By (at least 7)
			*Dictionary
			 DisplayString
			 InnerList
			 Item
			 List
			 Member (interface)
			*Params
		As Inputs Of (at least one exported)
			func Marshal(v StructuredFieldValue) (string, error)

	 type Token string (basic type)
		Token represents a token as defined in
		https://httpwg.org/specs/rfc9651.html#token.
		A specific type is used to distinguish tokens from strings.

	 type UnmarshalError (struct)
		UnmarshalError contains the underlying parsing error and the position at which it occurred.

		Methods (total 2)
			(*UnmarshalError) Error() string
			(*UnmarshalError) Unwrap() error
		Implements (at least 2)
			*UnmarshalError : error
			*UnmarshalError : golang.org/x/xerrors.Wrapper


Package-Level Functions (total 7)

	 func Marshal(v StructuredFieldValue) (string, error)
		Marshal returns the HTTP Structured Value serialization of v
		as defined in https://httpwg.org/specs/rfc9651.html#text-serialize.
		
		v must be a List, a Dictionary, an Item or an InnerList.

	 func NewDictionary() *Dictionary
		NewDictionary creates a new ordered map.

	 func NewItem(v interface{}) Item
		NewItem returns a new Item.

	 func NewParams() *Params
		NewParams creates a new ordered map.

	 func UnmarshalDictionary(v []string) (*Dictionary, error)
		UnmarshalDictionary parses a dictionary as defined in
		https://httpwg.org/specs/rfc9651.html#parse-dictionary.

	 func UnmarshalItem(v []string) (Item, error)
		UnmarshalItem parses an item as defined in
		https://httpwg.org/specs/rfc9651.html#parse-item.

	 func UnmarshalList(v []string) (List, error)
		UnmarshalList parses a list as defined in
		https://httpwg.org/specs/rfc9651.html#parse-list.


Package-Level Variables (total 20)

	  var ErrInvalidBareItem error
		ErrInvalidBareItem is returned when a bare item is invalid.

	  var ErrInvalidBinaryFormat error
		ErrInvalidBinaryFormat is returned when the binary format is invalid.

	  var ErrInvalidBooleanFormat error
		ErrInvalidBooleanFormat is returned when a boolean format is invalid.

	  var ErrInvalidDateFormat error
	  var ErrInvalidDecimal error
		ErrInvalidDecimal is returned when a decimal is invalid.

	  var ErrInvalidDecimalFormat error
		ErrInvalidDecimalFormat is returned when the decimal format is invalid.

	  var ErrInvalidDictionaryFormat error
		ErrInvalidDictionaryFormat is returned when a dictionary value is invalid.

	  var ErrInvalidDisplayString error
	  var ErrInvalidInnerListFormat error
		ErrInvalidInnerListFormat is returned when an inner list format is invalid.

	  var ErrInvalidKeyFormat error
		ErrInvalidKeyFormat is returned when the format of a parameter or dictionary key is invalid.

	  var ErrInvalidListFormat error
		ErrInvalidListFormat is returned when the format of a list is invalid.

	  var ErrInvalidParameterFormat error
		ErrInvalidParameterFormat is returned when the format of a parameter is invalid.

	  var ErrInvalidParameterValue error
		ErrInvalidParameterValue is returned when a parameter key is invalid.

	  var ErrInvalidStringFormat error
		ErrInvalidStringFormat is returned when a string format is invalid.

	  var ErrInvalidTokenFormat error
		ErrInvalidTokenFormat is returned when a token format is invalid.

	  var ErrMissingParameters error
		ErrMissingParameters is returned when the Params structure is missing from the element.

	  var ErrNotDigit error
		ErrNotDigit is returned when a character should be a digit but isn't.

	  var ErrNumberOutOfRange error
		ErrNumberOutOfRange is returned when the number is too large according to the specification.

	  var ErrUnexpectedEndOfString error
		ErrUnexpectedEndOfString is returned when the end of string is unexpected.

	  var ErrUnrecognizedCharacter error
		ErrUnrecognizedCharacter is returned when an unrecognized character in encountered.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.