base58

Documentation

Index

• Variables
• func CheckDecode(input string) (result []byte, version byte, err error)
• func CheckEncode(input []byte, version byte) string
• type Encoding
  • func NewEncoding(encoder string) *Encoding
  • func (enc *Encoding) Decode(src []byte) ([]byte, error)
  • func (enc *Encoding) DecodeString(src string) ([]byte, error)
  • func (enc *Encoding) DecodedLen(n int) int
  • func (enc *Encoding) Encode(b []byte) []byte
  • func (enc *Encoding) EncodeToString(src []byte) string
  • func (enc *Encoding) EncodedLen(n int) int

Variables

var ErrChecksum = errors.New("checksum error")

var ErrInvalidFormat = errors.New("invalid format: version and/or checksum bytes missing")

var StdEncoding = NewEncoding(alphabet)

Functions

func CheckDecode

func CheckDecode(input string) (result []byte, version byte, err error)

检测解码

func CheckEncode

func CheckEncode(input []byte, version byte) string

检测编码

Types

type Encoding

type Encoding struct {
	// contains filtered or unexported fields
}

An Encoding is a base 58 encoding/decoding scheme defined by a 58-character alphabet.

func NewEncoding

func NewEncoding(encoder string) *Encoding

NewEncoding returns a new Encoding defined by the given alphabet, which must be a 58-byte string that does not contain CR or LF ('\r', '\n').

func (*Encoding) Decode

func (enc *Encoding) Decode(src []byte) ([]byte, error)

Decode decodes src using the encoding enc. It writes at most DecodedLen(len(src)) bytes to dst and returns the number of bytes written. If src contains invalid base58 data, it will return the number of bytes successfully written and CorruptInputError.

func (*Encoding) DecodeString

func (enc *Encoding) DecodeString(src string) ([]byte, error)

DecodeString returns the bytes represented by the base58 string s.

func (*Encoding) DecodedLen

func (enc *Encoding) DecodedLen(n int) int

DecodedLen returns the maximum length in bytes of the decoded data corresponding to n bytes of base58-encoded data.

func (*Encoding) Encode

func (enc *Encoding) Encode(b []byte) []byte

func (*Encoding) EncodeToString

func (enc *Encoding) EncodeToString(src []byte) string

EncodeToString returns the base58 encoding of src.

func (*Encoding) EncodedLen

func (enc *Encoding) EncodedLen(n int) int

EncodedLen returns an upper bound on the length in bytes of the base58 encoding of an input buffer of length n. The true encoded length may be shorter.