codec

Documentation

Index

• type CvpCodec
  • func GetCvpCodecV1() CvpCodec
  • func GetCvpCodecV2() CvpCodec
  • func GetCvpCodecV3() CvpCodec
  • func NewProxyCvpCodec() CvpCodec
  • func WrapCvpCodecInProxy(inner CvpCodec) CvpCodec
• type CvpCodecVersion
  • func DetectEncodingVersion(bz []byte) (possible CvpCodecVersion, detected bool)

Types

type CvpCodec

type CvpCodec interface {
	// EncodeStreamingLightValidators encodes the given light validators information into sorter string for streaming.
	// Input is assumed to be valid, otherwise panic.
	EncodeStreamingLightValidators(types.StreamingLightValidators) []byte

	// DecodeStreamingLightValidators decodes the given string into light validators.
	DecodeStreamingLightValidators([]byte) (types.StreamingLightValidators, error)

	// EncodeStreamingNextBlockVotingInformation encodes the given next block voting information into sorter string for streaming.
	// Input is assumed to be valid, otherwise panic.
	EncodeStreamingNextBlockVotingInformation(*types.StreamingNextBlockVotingInformation) []byte

	// DecodeStreamingNextBlockVotingInformation decodes the given string into next block voting information.
	DecodeStreamingNextBlockVotingInformation([]byte) (*types.StreamingNextBlockVotingInformation, error)

	// GetVersion returns the implementation version of this codec instance.
	//
	// In case a proxy CvpCodec, it returns the underlying implementation version
	// which set by NewProxyCvpCodec (default) or WrapCvpCodecInProxy (specify).
	GetVersion() CvpCodecVersion
}

CvpCodec is the interface for encoding and decoding streaming data.

func GetCvpCodecV1

func GetCvpCodecV1() CvpCodec

GetCvpCodecV1 returns genesis version of CvpCodec.

Deprecated: use NewProxyCvpCodec for the latest and compatible version.

func GetCvpCodecV2

func GetCvpCodecV2() CvpCodec

GetCvpCodecV2 returns new instance of v2 implementation of CvpCodec.

V2 output smaller size of encoded data than v1. But still not as small as v3 (gzip version of v2).

func GetCvpCodecV3

func GetCvpCodecV3() CvpCodec

GetCvpCodecV3 returns new instance of CvpCodec that actually encode data using v2 codec then gzip it. Procedures smaller data than v2 codec in most cases with large data size. But slower than v2 codec, ofc.

func NewProxyCvpCodec

func NewProxyCvpCodec() CvpCodec

NewProxyCvpCodec returns new instance of proxy CvpCodec.

The proxy automatically detect version of encoded data and forward to the corresponding implementation for decoding.

When invoking encode functions, it forward to default CvpCodec version.

func WrapCvpCodecInProxy

func WrapCvpCodecInProxy(inner CvpCodec) CvpCodec

WrapCvpCodecInProxy wraps a CvpCodec into a proxy CvpCodec.

The proxy automatically detect version of encoded data and forward to the corresponding implementation for decoding.

When invoking encode functions, it forward to the provided version.

type CvpCodecVersion

type CvpCodecVersion string

const (
	CvpCodecVersionUnknown CvpCodecVersion = "unknown"
	CvpCodecVersionV1      CvpCodecVersion = "v1"
	CvpCodecVersionV2      CvpCodecVersion = "v2"
	CvpCodecVersionV3      CvpCodecVersion = "v3"
)

func DetectEncodingVersion

func DetectEncodingVersion(bz []byte) (possible CvpCodecVersion, detected bool)

DetectEncodingVersion will try to detect the encoding version of the given byte array based on the very first bytes. The returned version is 'possible' because it is not guaranteed to be the correct version without actual decode it.