contenttype

Documentation

Index

• Variables
• type ContentType
  • func MustParse(name string) ContentType
  • func Parse(name string) ContentType
  • func (ct ContentType) MarshalJSON() ([]byte, error)
  • func (ct ContentType) String() string
  • func (ct *ContentType) UnmarshalJSON(b []byte) error
• type FormType
  • func (ft *FormType) Marshal(value any) (io.Reader, error)
  • func (ft *FormType) Unmarshal(r io.Reader, value any) error
• type HtmlType
  • func (ht *HtmlType) Marshal(value any) (io.Reader, error)
  • func (ht *HtmlType) Unmarshal(r io.Reader, value any) error
• type IContentType
• type JsonType
  • func (jt *JsonType) Marshal(value any) (io.Reader, error)
  • func (jt *JsonType) Unmarshal(r io.Reader, value any) error
• type MsgPackType
  • func (mt *MsgPackType) Marshal(value any) (io.Reader, error)
  • func (mt *MsgPackType) Unmarshal(r io.Reader, value any) error
• type TextType
  • func (tt *TextType) Marshal(value any) (io.Reader, error)
  • func (tt *TextType) Unmarshal(r io.Reader, value any) error
• type YamlType
  • func (yt *YamlType) Marshal(value any) (io.Reader, error)
  • func (yt *YamlType) Unmarshal(r io.Reader, value any) error

Variables

var (
	// Names is a map of content type names to content type values.
	Names = map[ContentType]string{
		Form:    "application/x-www-form-urlencoded",
		Html:    "text/html",
		Json:    "application/json",
		MsgPack: "application/msgpack",
		Text:    "text/plain",
		Yaml:    "application/yaml",
	}

	// Set is a map of content type values to content type marshal and unmarshal.
	Set = map[ContentType]IContentType{
		Form:    &FormType{},
		Html:    &HtmlType{},
		Json:    &JsonType{},
		MsgPack: &MsgPackType{},
		Text:    &TextType{},
		Yaml:    &YamlType{},
	}

	// ErrInvalid is returned when the content type is invalid.
	ErrInvalid = errors.New("invalid content type")
)

Types

type ContentType

type ContentType uint8

ContentType is a content type.

const (
	Invalid ContentType = iota
	Form
	Html
	Json
	MsgPack
	Text
	Yaml
)

func MustParse

func MustParse(name string) ContentType

MustParse parses content type string or panics.

func Parse

func Parse(name string) ContentType

Parse parses content type string.

func (ContentType) MarshalJSON

func (ct ContentType) MarshalJSON() ([]byte, error)

MarshalJSON content type to json

func (ContentType) String

func (ct ContentType) String() string

String content type to string

func (*ContentType) UnmarshalJSON

func (ct *ContentType) UnmarshalJSON(b []byte) error

UnmarshalJSON content type from json

type FormType

type FormType struct{}

FormType is a form type.

func (*FormType) Marshal

func (ft *FormType) Marshal(value any) (io.Reader, error)

Marshal returns a reader for the given value.

func (*FormType) Unmarshal

func (ft *FormType) Unmarshal(r io.Reader, value any) error

Unmarshal parses the given reader and stores the result in the value pointed to by value.

type HtmlType

type HtmlType struct{}

HtmlType is a html type.

func (*HtmlType) Marshal

func (ht *HtmlType) Marshal(value any) (io.Reader, error)

Marshal returns a reader for the given value.

func (*HtmlType) Unmarshal

func (ht *HtmlType) Unmarshal(r io.Reader, value any) error

Unmarshal parses the given reader and stores the result in the value pointed to by value.

type IContentType

type IContentType interface {
	// Marshal marshals the value to a reader.
	Marshal(any) (io.Reader, error)

	// Unmarshal unmarshals the reader to a value.
	Unmarshal(io.Reader, any) error
}

IContentType is a content type interface.

type JsonType

type JsonType struct{}

JsonType is a json type.

func (*JsonType) Marshal

func (jt *JsonType) Marshal(value any) (io.Reader, error)

Marshal returns a reader for the given value.

func (*JsonType) Unmarshal

func (jt *JsonType) Unmarshal(r io.Reader, value any) error

Unmarshal parses the given reader and stores the result in the value pointed to by value.

type MsgPackType

type MsgPackType struct{}

MsgPackType is a msgpack type.

func (*MsgPackType) Marshal

func (mt *MsgPackType) Marshal(value any) (io.Reader, error)

Marshal returns a reader for the given value.

func (*MsgPackType) Unmarshal

func (mt *MsgPackType) Unmarshal(r io.Reader, value any) error

Unmarshal parses the given reader and stores the result in the value pointed to by value.

type TextType

type TextType struct{}

TextType is a text type.

func (*TextType) Marshal

func (tt *TextType) Marshal(value any) (io.Reader, error)

Marshal returns a reader for the given value.

func (*TextType) Unmarshal

func (tt *TextType) Unmarshal(r io.Reader, value any) error

Unmarshal parses the given reader and stores the result in the value pointed to by value.

type YamlType

type YamlType struct{}

YamlType is a yaml type.

func (*YamlType) Marshal

func (yt *YamlType) Marshal(value any) (io.Reader, error)

Marshal returns a reader for the given value.

func (*YamlType) Unmarshal

func (yt *YamlType) Unmarshal(r io.Reader, value any) error

Unmarshal parses the given reader and stores the result in the value pointed to by value.