codec

Documentation

Overview

Package codec defines interfaces for use with both pointer and reference types that allows proper integration with zero-copy and allocation pools

Index

• type B
• type Binary
• type Ctx
• type E
• type JSON
• type N
• type S

Types

type B

type B = []byte

type Binary

type Binary interface {
	// MarshalBinary converts the data of the type into binary form, appending
	// it to the provided slice.
	MarshalBinary(dst B) (b B, err E)
	// UnmarshalBinary decodes a binary form of a type back into the runtime
	// form, and returns whatever remains after the type has been decoded out.
	UnmarshalBinary(b B) (r B, err E)
}

type Ctx

type Ctx = context.T

type E

type E = error

type JSON

type JSON interface {
	// MarshalJSON converts the data of the type into JSON, appending it to the
	// provided slice and returning the extended slice.
	MarshalJSON(dst B) (b B, err E)
	// UnmarshalJSON decodes a JSON form of a type back into the runtime form,
	// and returns whatever remains after the type has been decoded out.
	UnmarshalJSON(b B) (r B, err E)
}

type N

type N = int

type S

type S = string