t5b1

Documentation

Overview

Package t5b1 implements the t5b1 encoding encoding which uses one byte to represent each 5-trit group.

Index

• func Decode(dst trinary.Trits, src []byte) (int, error)
• func DecodeToTrytes(src []byte) (trinary.Trytes, error)
• func DecodedLen(n int) int
• func Encode(dst []byte, src trinary.Trits) int
• func EncodeTrytes(src trinary.Trytes) []byte
• func EncodedLen(n int) int

Functions

func Decode

func Decode(dst trinary.Trits, src []byte) (int, error)

Decode decodes src into DecodedLen(len(src)) trits of dst and returns the actual number of bytes written. Decode expects that src contains a valid t5b1 encoding, it returns an error otherwise.

func DecodeToTrytes

func DecodeToTrytes(src []byte) (trinary.Trytes, error)

DecodeToTrytes returns the trytes represented by the t5b1 encoded bytes. The returned trytes always have a length of Ceil(DecodedLen(len(src))/3). DecodeToTrytes expects that src contains a valid t5b1 encoding of a tryte-string. If the input is malformed or does not contain the correct zero padding, it returns an error.

func DecodedLen

func DecodedLen(n int) int

DecodedLen returns the trit-length of a decoding of n source bytes.

func Encode

func Encode(dst []byte, src trinary.Trits) int

Encode encodes src into EncodedLen(len(src)) bytes of dst. As a convenience, it returns the number of trits written, but this value is always EncodedLen(len(src)). Encode implements the t5b1 encoding converting a trit string into binary. If the length of src is not a multiple of 5, it is padded with zeroes. If src does not contain trits, the behavior of Encode is undefined.

func EncodeTrytes

func EncodeTrytes(src trinary.Trytes) []byte

EncodeTrytes returns the encoding of src converted into bytes. If the corresponding number of trits of src is not a multiple of 5, it is padded with zeroes. If src does not contain valid trytes, the behavior is undefined.

func EncodedLen

func EncodedLen(n int) int

EncodedLen returns the byte-length of an encoding of n source trits.