internal

package

v1.7.2 Latest Latest Go to latest Published: Mar 6, 2018 License: CC0-1.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/danieagle/colfer

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ColferSizeMax is the upper limit for serial byte sizes.
	ColferSizeMax = 16 * 1024 * 1024
)

Colfer configuration attributes

Functions ¶

This section is empty.

Types ¶

type ColferError ¶

type ColferError int

ColferError signals a data mismatch as as a byte index.

func (ColferError) Error ¶

func (i ColferError) Error() string

Error honors the error interface.

type ColferMax ¶

type ColferMax string

ColferMax signals an upper limit breach.

func (ColferMax) Error ¶

func (m ColferMax) Error() string

Error honors the error interface.

type ColferTail ¶

type ColferTail int

ColferTail signals data continuation as a byte index.

func (ColferTail) Error ¶

func (i ColferTail) Error() string

Error honors the error interface.

type Header ¶

type Header struct {
	SeqID uint64

	Method string

	Error string

	BodySize uint32
}

Header is a prefix for requests and responses.

func (o *Header) MarshalBinary() (data []byte, err error)

MarshalBinary encodes o as Colfer conform encoding.BinaryMarshaler. The error return option is internal.ColferMax.

func (o *Header) MarshalLen() (int, error)

MarshalLen returns the Colfer serial byte size. The error return option is internal.ColferMax.

func (o *Header) MarshalTo(buf []byte) int

MarshalTo encodes o as Colfer into buf and returns the number of bytes written. If the buffer is too small, MarshalTo will panic.

func (o *Header) Unmarshal(data []byte) (int, error)

Unmarshal decodes data as Colfer and returns the number of bytes read. The error return options are io.EOF, internal.ColferError and internal.ColferMax.

func (o *Header) UnmarshalBinary(data []byte) error

UnmarshalBinary decodes data as Colfer conform encoding.BinaryUnmarshaler. The error return options are io.EOF, internal.ColferError, internal.ColferTail and internal.ColferMax.

Source Files ¶

View all Source files

Colfer.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

internal

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

Types ¶

type ColferError ¶

func (ColferError) Error ¶

type ColferMax ¶

func (ColferMax) Error ¶

type ColferTail ¶

func (ColferTail) Error ¶

type Header ¶

func (*Header) MarshalBinary ¶

func (*Header) MarshalLen ¶

func (*Header) MarshalTo ¶

func (*Header) Unmarshal ¶

func (*Header) UnmarshalBinary ¶

Source Files ¶