Categorygithub.com/spacemeshos/go-scale

modulepackage

1.2.0

Repository: https://github.com/spacemeshos/go-scale.git

Documentation: pkg.go.dev

# README

SCALE

Types

golang	notes	example
[]byte	length prefixed byte array with length as u32 compact integer
string	same as []byte
[...]byte	appended to the result
bool	1 byte, 0 for false, 1 for true
Object{}	concatenation of fields
*Object{}	Option. 0 for nil, 1 for Object{}. if 1 - decode Object{}
uint8	compact u8 [TODO no need for compact u8]
uint16	compact u16
uint32	compact u32
uint34	compact u64
*uint8	Option (0 for nil, 1 otherwise), followed by compact u8	`&64 -> 01FC`; `&255 -> 01FD03`
*uint16	Option (0 for nil, 1 otherwise), followed by compact u16	`&255 -> 01FD03`
*uint32	Option (0 for nil, 1 otherwise), followed by compact u32	`&255 -> 01FD03`
*uint64	Option (0 for nil, 1 otherwise), followed by compact u64	`&255 -> 01FD03`
[]uint16	length prefixed (compact u32) followed by compact u16s	`[4, 15, 23, u16::MAX] -> 10103C5CFEFF0300`
[]uint32	length prefixed (compact u32) followed by compact u32s	`[4, 15, 23, u32::MAX] -> 10103C5C03FFFFFFFF`
[]uint64	length prefixed (compact u32) followed by compact u64s	`[4, 15, 23, u64::MAX] -> 10103C5C13FFFFFFFFFFFFFFFF`
[...]Object	array with objects. encoded by consecutively encoding every object
[]Object	slice with objects. prefixed with compact u32

Not implemented:

pointers to arrays and slices
slices with pointers
enumerations
fixed width integers

Code generation

go install github.com/spacemeshos/go-scale/scalegen

//go:generate scalegen will discover all struct types and derive EncodeScale/DecodeScale methods. To avoid struct auto-discovery use -types=U8,U16.

# Packages

nolint.

No description provided by the author

nolint.

No description provided by the author

# Functions

No description provided by the author

No description provided by the author

DecodeByteArray

No description provided by the author

DecodeByteSlice

No description provided by the author

DecodeByteSliceWithLimit

No description provided by the author

DecodeCompact16

No description provided by the author

DecodeCompact16Ptr

No description provided by the author

DecodeCompact32

No description provided by the author

DecodeCompact32Ptr

No description provided by the author

DecodeCompact64

No description provided by the author

DecodeCompact64Ptr

No description provided by the author

No description provided by the author

DecodeCompact8Ptr

No description provided by the author

No description provided by the author

No description provided by the author

DecodeSliceOfByteSlice

No description provided by the author

DecodeSliceOfByteSliceWithLimit

No description provided by the author

No description provided by the author

DecodeStringSlice

No description provided by the author

DecodeStringSliceWithLimit

No description provided by the author

DecodeStringWithLimit

No description provided by the author

No description provided by the author

DecodeStructArray

No description provided by the author

DecodeStructSlice

No description provided by the author

DecodeStructSliceWithLimit

No description provided by the author

DecodeUint16Slice

No description provided by the author

DecodeUint16SliceWithLimit

No description provided by the author

DecodeUint32Slice

No description provided by the author

DecodeUint32SliceWithLimit

No description provided by the author

DecodeUint64Slice

No description provided by the author

DecodeUint64SliceWithLimit

No description provided by the author

No description provided by the author

No description provided by the author

EncodeByteArray

No description provided by the author

EncodeByteSlice

No description provided by the author

EncodeByteSliceWithLimit

No description provided by the author

EncodeCompact16

No description provided by the author

EncodeCompact16Ptr

No description provided by the author

EncodeCompact32

No description provided by the author

EncodeCompact32Ptr

No description provided by the author

EncodeCompact64

No description provided by the author

EncodeCompact64Ptr

No description provided by the author

No description provided by the author

EncodeCompact8Ptr

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

EncodeStringSlice

No description provided by the author

EncodeStringSliceWithLimit

No description provided by the author

EncodeStringWithLimit

No description provided by the author

No description provided by the author

EncodeStructArray

No description provided by the author

EncodeStructSlice

No description provided by the author

EncodeStructSliceWithLimit

No description provided by the author

No description provided by the author

EncodeUint16Slice

No description provided by the author

EncodeUint16SliceWithLimit

No description provided by the author

No description provided by the author

EncodeUint32Slice

No description provided by the author

EncodeUint32SliceWithLimit

No description provided by the author

No description provided by the author

EncodeUint64Slice

No description provided by the author

EncodeUint64SliceWithLimit

No description provided by the author

No description provided by the author

LenSize returns the size in bytes required to encode a length value.

MaxScaleElements

MaxScaleElements is a generic version of GetMaxElementsFromValue that uses the specified type instead of a struct value.

MaxScaleElementsForField

MaxScaleElementsForField returns the max number of elements for the specified field in the struct passed as the v argument based on the 'scale' tag.

MustGetMaxElements

MustGetMaxElements is the same as GetMaxElements, but returns just the max tag value and panics in case of an error.

NewDecoder returns a new decoder that reads from r.

NewEncoder returns a new encoder that writes to w.

WithDecodeMaxElements

WithDecodeMaxElements sets the maximum number of elements allowed in a collection.

WithDecodeMaxNested

WithDecodeMaxNested sets the nested level of the decoder.

WithEncodeMaxElements

WithEncodeMaxElements sets the maximum number of elements allowed in a collection.

WithEncodeMaxNested

WithEncodeMaxNested sets the nested level of the encoder.

# Constants

MaxElements is the maximum number of elements allowed in a collection if not set explicitly during encoding/decoding.

MaxNested is the maximum nested level allowed if not set explicitly during encoding/decoding.

# Variables

ErrDecodeNestedTooDeep

ErrDecodeNestedTooDeep is returned when nested level is too deep.

ErrDecodeTooManyElements

ErrDecodeTooManyElements is returned when scale limit tag is used and collection has too many elements to decode.

ErrEncodeNestedTooDeep

ErrEncodeNestedTooDeep is returned when the depth of nested types exceeds the limit.

ErrEncodeTooManyElements

ErrEncodeTooManyElements is returned when scale limit tag is used and collection has too many elements to encode.

# Structs

No description provided by the author

No description provided by the author

# Interfaces

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

# Type aliases

No description provided by the author