formatting

Documentation

Index

• func Decode(encoding Encoding, str string) ([]byte, error)
• func Encode(encoding Encoding, bytes []byte) (string, error)
• func IntFormat(maxValue int) 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 Encode

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

Encode 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.

func IntFormat

func IntFormat(maxValue int) string

Types

type Encoding

type Encoding uint8

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

const (
	// Hex specifies a hex plus 4 byte checksum encoding format
	Hex Encoding = iota
	// HexNC specifies a hex encoding format
	HexNC
	// HexC specifies a hex plus 4 byte checksum encoding format
	HexC
	// 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