formatting

Documentation

Index

• func Decode(encoding Encoding, str string) ([]byte, error)
• func EncodeWithChecksum(encoding Encoding, bytes []byte) (string, error)
• func EncodeWithoutChecksum(encoding Encoding, bytes []byte) (string, error)
• func IntFormat(maxValue int) string
• type DumpBytes
  • func (db DumpBytes) String() string
• type Encoding
  • func (enc Encoding) MarshalJSON() ([]byte, error)
  • func (enc Encoding) String() string
  • func (enc *Encoding) UnmarshalJSON(b []byte) error
• type PrefixedStringer

Functions

func Decode

func Decode(encoding Encoding, str string) ([]byte, error)

Decode [str] to bytes using the given encoding If [str] is the empty string, returns a nil byte slice and nil error

func EncodeWithChecksum

func EncodeWithChecksum(encoding Encoding, bytes []byte) (string, error)

EncodeWithChecksum bytes to a string using the given encoding format bytes may be nil, in which case it will be treated the same as an empty slice. This function includes a checksum in the encoded string.

func EncodeWithoutChecksum

func EncodeWithoutChecksum(encoding Encoding, bytes []byte) (string, error)

EncodeWithoutChecksum bytes to a string using the given encoding format bytes may be nil, in which case it will be treated the same as an empty slice. Unlike EncodeWithChecksum, this function does not include a checksum in the encoded string.

func IntFormat

func IntFormat(maxValue int) string

Types

type DumpBytes

type DumpBytes []byte

func (DumpBytes) String

func (db DumpBytes) String() string

type Encoding

type Encoding uint8

Encoding defines how bytes are converted to a string and vice versa

const (
	// CB58 specifies the CB58 encoding format
	CB58 Encoding = iota
	// Hex specifies a hex plus 4 byte checksum encoding format
	Hex
	// JSON specifies the JSON encoding format
	JSON
)

func (Encoding) MarshalJSON

func (enc Encoding) MarshalJSON() ([]byte, error)

func (Encoding) String

func (enc Encoding) String() string

func (*Encoding) UnmarshalJSON

func (enc *Encoding) UnmarshalJSON(b []byte) error

type PrefixedStringer

type PrefixedStringer interface {
	fmt.Stringer

	PrefixedString(prefix string) string
}

PrefixedStringer extends a stringer that adds a prefix