base58

Documentation

Overview

Package base58 implements base58 encoding

Index

• Variables
• func DecodeString(s string) ([]byte, error)
• func DecodeUUID(s string) (u uuid.UUID, err error)
• func EncodeToString(src []byte) string
• func EncodeUUID(u uuid.UUID) string
• func NewUUID() string
• type Encoding
  • func NewEncoding(encoder string) *Encoding
  • func (enc *Encoding) DecodeString(s string) ([]byte, error)
  • func (enc *Encoding) EncodeToString(src []byte) string

Variables

var ErrInvalidChar = errors.New("invalid base58 string")

ErrInvalidChar is returned on decoding errors.

var ErrInvalidLenght = errors.New("invalid length")

ErrInvalidLenght is returned on UUID decoding errors.

var StdEncoding = NewEncoding("123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz")

StdEncoding is an Encoding with the Bitcoin alphabet.

Functions

func DecodeString

func DecodeString(s string) ([]byte, error)

DecodeString is a shortcut to Encoding.DecodeString on StdEncoding.

func DecodeUUID

func DecodeUUID(s string) (u uuid.UUID, err error)

DecodeUUID decodes a string to an UUID.

func EncodeToString

func EncodeToString(src []byte) string

EncodeToString is a shortcut to Encoding.EncodeToString on StdEncoding.

func EncodeUUID

func EncodeUUID(u uuid.UUID) string

EncodeUUID encodes an UUID to a base58 string.

func NewUUID

func NewUUID() string

NewUUID returns a base58 encoded UUIDv4.

Types

type Encoding

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

An Encoding is a radix 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-bit string that contains unique byte values and does not contain CR or LF characters.

func (*Encoding) DecodeString

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

DecodeString returns the bytes represented by the base58 string s.

func (*Encoding) EncodeToString

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

EncodeToString returns the base58 encoding of src.