package postcard

Import Path
	github.com/tmc/go-iroh/internal/postcard (on go.dev)

Dependency Relation
	imports 6 packages, and imported by one package

Involved Source Files

	  d postcard.go
		Package postcard encodes and decodes the Rust postcard wire format.
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type Decoder (struct)
		Decoder incrementally decodes postcard values.

		Methods (total 8)
			(*Decoder) Bool() (bool, error)
				Bool decodes a postcard bool.

			(*Decoder) BytesValue() ([]byte, error)
				BytesValue decodes a postcard byte sequence.

			(*Decoder) Decode(v any) error
				Decode decodes the next postcard value into v.

			(*Decoder) Done() bool
				Done reports whether d consumed all input.

			(*Decoder) Int() (int64, error)
				Int decodes a postcard signed integer.

			(*Decoder) RawBytes(n int) ([]byte, error)
				RawBytes decodes n bytes without a length prefix.

			(*Decoder) String() (string, error)
				String decodes a postcard string.

			(*Decoder) Uint() (uint64, error)
				Uint decodes a postcard unsigned integer.

		Implements (at least one exported)
			*Decoder : github.com/grpc-ecosystem/grpc-gateway/v2/runtime.Decoder
		As Outputs Of (at least one exported)
			func NewDecoder(b []byte) *Decoder
		As Inputs Of (at least 2)
			func DecoderFrom.DecodePostcard(*Decoder) error
			func github.com/tmc/go-iroh/internal/relayproto.(*KeyMaterialClientAuth).DecodePostcard(d *Decoder) error

	 type DecoderFrom (interface)
		DecoderFrom is implemented by values that decode themselves from d.

		Methods (only one)
			( DecoderFrom) DecodePostcard(*Decoder) error
		Implemented By (at least one exported)
			*github.com/tmc/go-iroh/internal/relayproto.KeyMaterialClientAuth

	 type Encoder (struct)
		Encoder incrementally encodes postcard values.

		Methods (total 8)
			(*Encoder) Bool(v bool)
				Bool appends v as a postcard bool.

			(*Encoder) Bytes() []byte
				Bytes returns a copy of the encoded bytes.

			(*Encoder) BytesValue(b []byte)
				BytesValue appends b as a postcard byte sequence.

			(*Encoder) Encode(v any) error
				Encode appends v to e.

			(*Encoder) Int(v int64)
				Int appends v as a postcard signed integer.

			(*Encoder) RawBytes(b []byte)
				RawBytes appends b without a length prefix.

			(*Encoder) String(s string)
				String appends s as a postcard string.

			(*Encoder) Uint(v uint64)
				Uint appends v as a postcard unsigned integer.

		Implements (at least 3)
			*Encoder : github.com/apache/arrow-go/v18/internal/hashing.ByteSlice
			*Encoder : github.com/grpc-ecosystem/grpc-gateway/v2/runtime.Encoder
			*Encoder : go.uber.org/zap/zapcore.ReflectedEncoder
		As Inputs Of (at least 2)
			func EncoderTo.EncodePostcard(*Encoder) error
			func github.com/tmc/go-iroh/internal/relayproto.KeyMaterialClientAuth.EncodePostcard(e *Encoder) error

	 type EncoderTo (interface)
		EncoderTo is implemented by values that encode themselves to e.

		Methods (only one)
			( EncoderTo) EncodePostcard(*Encoder) error
		Implemented By (at least one exported)
			 github.com/tmc/go-iroh/internal/relayproto.KeyMaterialClientAuth

	 type Marshaler (interface)
		Marshaler is implemented by values with a custom postcard representation.

		Methods (only one)
			( Marshaler) MarshalPostcard() ([]byte, error)


Package-Level Functions (total 3)

	 func Marshal(v any) ([]byte, error)
		Marshal encodes v in postcard format.

	 func NewDecoder(b []byte) *Decoder
		NewDecoder returns a decoder reading b.

	 func Unmarshal(data []byte, v any) error
		Unmarshal decodes postcard data into v.


Package-Level Variables (only one)

	  var ErrTrailingBytes error
		ErrTrailingBytes is returned when Unmarshal does not consume all input.

The pages are generated with Golds v0.8.4. (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.