minami58

README

minami58

safety encode/decode based on 58 ASCII

Documentation

Index

• func Decode(raw []byte) ([]byte, error)
• func DecodeWithDesc(raw []byte) (desc string, payload []byte, err error)
• func Encode(payload []byte) []byte
• func EncodeWithDesc(raw []byte, desc string, delim Delim) ([]byte, error)
• type Delim

Functions

func Decode

func Decode(raw []byte) ([]byte, error)

Decode something

func DecodeWithDesc

func DecodeWithDesc(raw []byte) (desc string, payload []byte, err error)

DecodeWithDesc decode and return desc

func Encode

func Encode(payload []byte) []byte

Encode something

func EncodeWithDesc

func EncodeWithDesc(raw []byte, desc string, delim Delim) ([]byte, error)

EncodeWithDesc add some desc into payload

Types

type Delim

type Delim interface {
	// contains filtered or unexported methods
}

Delim delimiter

var (
	// ErrDescContainsDelim desc can't contains delim
	ErrDescContainsDelim = errors.New("desc contains delim")

	// Non no delim
	Non Delim = &delim{value: ""}

	// CR \r
	CR Delim = &delim{value: "\r"}

	// LF \n
	LF Delim = &delim{value: "\n"}

	// CRLF \r\n
	CRLF Delim = &delim{value: "\r\n"}
)