package encode

Import Path
	go.pact.im/x/phcformat/encode (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 2 packages

Involved Source Files

	   #d encode.go
		Package encode provides value encoders for [go.pact.im/x/phcformat] package.
Package-Level Type Names (total 12, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Appender (interface)
		Appender represents an encodable value that uses append-style API.

		Methods (only one, which is exported)
			( Appender) Append(dst []byte) []byte
				Append appends the encoded value to the dst and returns the resulting
				slice.

		Implemented By (at least 10, all are exported)
			 Base64
			 Byte
			 Bytes
			 Concat
			 Empty
			 KV
			 List
			 Option
			 String
			 Uint

	 type Base64[T] (struct)

		Type Parameters:
			T: StringOrBytes

		Base64 is an Appender that encodes string or byte slice using
		base64.RawStdEncoding.

		Fields (only one, which is exported)
			Data T
				Data is the unencoded data.

		Methods (only one, which is exported)
			( Base64[T]) Append(dst []byte) []byte
				Append implements the Appender interface.

		Implements (at least one exported)
			 Base64 : Appender
		As Outputs Of (at least one exported)
			func NewBase64[T](data T) Base64[T]

	 type Byte byte (basic type)
		Byte is an Appender that appends a single byte.

		Methods (only one, which is exported)
			( Byte) Append(dst []byte) []byte
				Append implements the Appender interface.

		Implements (at least one exported)
			 Byte : Appender
		As Outputs Of (at least one exported)
			func NewByte(c byte) Byte

	 type Bytes ([])
		Bytes is an Appender that appends byte slice.

		Methods (only one, which is exported)
			( Bytes) Append(dst []byte) []byte
				Append implements the Appender interface.

		Implements (at least one exported)
			 Bytes : Appender
		As Outputs Of (at least one exported)
			func NewBytes(buf []byte) Bytes

	 type Concat[T, U] (struct)

		Type Parameters:
			T: Appender
			U: Appender

		Concat is an Appender that concatenates two values.

		Fields (total 2, both are exported)
			A T
				A is the first value to append.

			B U
				B is the second value to append.

		Methods (only one, which is exported)
			( Concat[T, U]) Append(dst []byte) []byte
				Append implements the Appender interface.

		Implements (at least one exported)
			 Concat : Appender
		As Outputs Of (at least one exported)
			func NewConcat[T, U](a T, b U) Concat[T, U]

	 type Empty (struct)
		Empty is an Appender that does nothing.

		Methods (only one, which is exported)
			( Empty) Append(dst []byte) []byte
				Append implements the Appender interface.

		Implements (at least one exported)
			 Empty : Appender
		As Outputs Of (at least one exported)
			func NewEmpty() Empty

	 type KV[KeyAppender, SepAppender, ValAppender] (struct)

		Type Parameters:
			KeyAppender: Appender
			SepAppender: Appender
			ValAppender: Appender

		KV is an Appender that appends a key-value pair separated with the given
		separator.

		Fields (total 3, all are exported)
			Key KeyAppender
				Key is the key in the key-value pair.

			Sep SepAppender
				Sep is a separator that is appended between key and value.

			Val ValAppender
				Val is the value in the key-value pair.

		Methods (only one, which is exported)
			( KV[KeyAppender, SepAppender, ValAppender]) Append(dst []byte) []byte
				Append implements the Appender interface.

		Implements (at least one exported)
			 KV : Appender
		As Outputs Of (at least one exported)
			func NewKV[KeyAppender, SepAppender, ValAppender](sep SepAppender, k KeyAppender, v ValAppender) KV[KeyAppender, SepAppender, ValAppender]

	 type List[SeparatorAppender, ElementAppender] (struct)

		Type Parameters:
			SeparatorAppender: Appender
			ElementAppender: Appender

		List is an Appender that appends a list of values separated with the given
		separator.

		Fields (total 2, both are exported)
			Elements []ElementAppender
				Elements is a list of elements to append.

			Separator SeparatorAppender
				Separator is a separator that is appended between elements.

		Methods (only one, which is exported)
			( List[ElementAppender, SeparatorAppender]) Append(dst []byte) []byte
				Append implements the Appender interface.

		Implements (at least one exported)
			 List : Appender
		As Outputs Of (at least one exported)
			func NewList[SeparatorAppender, ElementAppender](sep SeparatorAppender, elements ...ElementAppender) List[SeparatorAppender, ElementAppender]

	 type Option[T] (struct)

		Type Parameters:
			T: Appender

		Option is an Appender that appends optional value if it is set.

		Fields (only one, which is exported)
			Option option.Of[T]
		Methods (only one, which is exported)
			( Option[T]) Append(dst []byte) []byte
				Append implements the Appender interface.

		Implements (at least one exported)
			 Option : Appender
		As Outputs Of (at least 2, in which 1 are exported)
			func NewOption[T](opt option.Of[T]) Option[T]
			/* at least one unexported ... *//* at least one unexported: */
			func go.pact.im/x/phcformat.optionAppenderWithPrefix[PrefixAppender, OptionAppender](prefix PrefixAppender, opt option.Of[OptionAppender]) Option[Concat[PrefixAppender, OptionAppender]]

	 type String string (basic type)
		String is an Appender that appends string.

		Methods (only one, which is exported)
			( String) Append(dst []byte) []byte
				Append implements the Appender interface.

		Implements (at least one exported)
			 String : Appender
		As Outputs Of (at least one exported)
			func NewString(s string) String

	 type StringOrBytes (interface)
		StringOrBytes is a union of string and byte slice types.

	 type Uint uint (basic type)
		Uint is an Appender that encodes uint as a decimal number.

		Methods (only one, which is exported)
			( Uint) Append(dst []byte) []byte
				Append implements the Appender interface.

		Implements (at least one exported)
			 Uint : Appender
		As Outputs Of (at least one exported)
			func NewUint(n uint) Uint


Package-Level Functions (total 12, in which 11 are exported)

	 func NewBase64[T](data T) Base64[T]

		Type Parameters:
			T: StringOrBytes

		NewBase64 returns a new Base64 instance.

	 func NewByte(c byte) Byte
		NewByte returns a new Byte instance.

	 func NewBytes(buf []byte) Bytes
		NewBytes returns a new Bytes instance.

	 func NewConcat[T, U](a T, b U) Concat[T, U]

		Type Parameters:
			T: Appender
			U: Appender

		NewConcat returns a new Concat instance.

	 func NewEmpty() Empty
		NewEmpty returns a new Empty instance.

	 func NewKV[KeyAppender, SepAppender, ValAppender](sep SepAppender, k KeyAppender, v ValAppender) KV[KeyAppender, SepAppender, ValAppender]

		Type Parameters:
			KeyAppender: Appender
			SepAppender: Appender
			ValAppender: Appender

		NewKV returns a new KV instance.

	 func NewList[SeparatorAppender, ElementAppender](sep SeparatorAppender, elements ...ElementAppender) List[SeparatorAppender, ElementAppender]

		Type Parameters:
			SeparatorAppender: Appender
			ElementAppender: Appender

		NewList returns a new List instance.

	 func NewOption[T](opt option.Of[T]) Option[T]

		Type Parameters:
			T: Appender

		NewOption returns a new Option instance.

	 func NewString(s string) String
		NewString returns a new String instance.

	 func NewUint(n uint) Uint
		NewUint returns a new Uint instance.

	 func Nil() option.Of[Appender]
		Nil returns a nil Appender option.

	/* one unexported ... *//* one unexported: */
	 func base64Append(e *base64.Encoding, dst, src []byte) []byte
		base64Append is an append-style function for base64 encoding.

		See also https://go.dev/issue/19366

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)