tools

Documentation

Index

• Variables
• func SmartMarshal(inItem Marshaller, ioBuf []byte) []byte
• func Zero(buf []byte)
• type Buf
  • func (buf *Buf) Unmarshal(inSrc []byte) error
• type Bytes
  • func (b Bytes) MarshalText() ([]byte, error)
  • func (b Bytes) String() string
  • func (b *Bytes) UnmarshalJSON(in []byte) error
  • func (b *Bytes) UnmarshalText(input []byte) error
• type Marshaller
• type Unmarshaller

Variables

var (

	// Parsing/Encoding
	ErrEmptyString   = &toolsErr{"empty hex string"}
	ErrSyntax        = &toolsErr{"invalid hex string"}
	ErrMissingPrefix = &toolsErr{"hex string without 0x prefix"}
	ErrOddLength     = &toolsErr{"hex string of odd length"}
	ErrEmptyNumber   = &toolsErr{"hex string \"0x\""}
	ErrLeadingZero   = &toolsErr{"hex number with leading zero digits"}
	ErrUint64Range   = &toolsErr{"hex number > 64 bits"}
	ErrBig256Range   = &toolsErr{"hex number > 256 bits"}
)

Errors

Functions

func SmartMarshal

func SmartMarshal(inItem Marshaller, ioBuf []byte) []byte

SmartMarshal marshals the given item to the given buffer. If there is not enough space

func Zero

func Zero(buf []byte)

Zero zeros out a given slice

Types

type Buf

type Buf struct {
	Unmarshaller

	Bytes []byte
}

Buf is a flexible buffer designed for reuse.

func (*Buf) Unmarshal

func (buf *Buf) Unmarshal(inSrc []byte) error

Unmarshal effectively copies the src buffer.

type Bytes

type Bytes []byte

Bytes marshal/unmarshal as a JSON string with 0x prefix. The empty slice marshals as "0x".

func (Bytes) MarshalText

func (b Bytes) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler

func (Bytes) String

func (b Bytes) String() string

String returns the hex encoding of b.

func (*Bytes) UnmarshalJSON

func (b *Bytes) UnmarshalJSON(in []byte) error

UnmarshalJSON implements json.Unmarshaler.

func (*Bytes) UnmarshalText

func (b *Bytes) UnmarshalText(input []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

type Marshaller

type Marshaller interface {
	Marshal() ([]byte, error)
	MarshalTo([]byte) (int, error)
	Size() int
}

Marshaller used to generalize serialization

type Unmarshaller

type Unmarshaller interface {
	Unmarshal([]byte) error
}

Unmarshaller used to generalize deserialization