Package: github.com/multiformats/go-multibase

package multibase Import Path github.com/multiformats/go-multibase (on go.dev) Dependency Relation imports 9 packages, and imported by 4 packages

Involved Source Files base16.go base2.go base256emoji.go base32.go encoder.go multibase.go

Package-Level Type Names (total 2)

/* sort by: alphabet | popularity */

type Encoder (struct) Encoder is a multibase encoding that is verified to be supported and supports an Encode method that does not return an error Methods (total 2) ( Encoder) Encode(data []byte) string Encode encodes the multibase using the given Encoder. ( Encoder) Encoding() Encoding As Outputs Of (at least 3) func EncoderByName(str string) (Encoder, error) func MustNewEncoder(base Encoding) Encoder func NewEncoder(base Encoding) (Encoder, error) As Inputs Of (at least one exported) func github.com/ipfs/go-cid.Cid.Encode(base Encoder) string

type Encoding int (basic type) Encoding identifies the type of base-encoding that a multibase is carrying. As Outputs Of (at least 3) func Decode(data string) (Encoding, []byte, error) func Encoder.Encoding() Encoding func github.com/ipfs/go-cid.ExtractEncoding(v string) (Encoding, error) As Inputs Of (at least 4) func Encode(base Encoding, data []byte) (string, error) func MustNewEncoder(base Encoding) Encoder func NewEncoder(base Encoding) (Encoder, error) func github.com/ipfs/go-cid.Cid.StringOfBase(base Encoding) (string, error)

Package-Level Functions (total 5)

func Decode(data string) (Encoding, []byte, error) Decode takes a multibase string and decodes into a bytes buffer. It will return an error if the selected base is not known.

func Encode(base Encoding, data []byte) (string, error) Encode encodes a given byte slice with the selected encoding and returns a multibase string (<encoding><base-encoded-string>). It will return an error if the selected base is not known.

func EncoderByName(str string) (Encoder, error) EncoderByName creates an encoder from a string, the string can either be the multibase name or single character multibase prefix

func MustNewEncoder(base Encoding) Encoder MustNewEncoder is like NewEncoder but will panic if the encoding is invalid.

func NewEncoder(base Encoding) (Encoder, error) NewEncoder create a new Encoder from an Encoding

Package-Level Variables (total 3)

var Encodings map[string]Encoding

var EncodingToStr map[Encoding]string EncodingToStr is a map of the supported encoding, unsupported encoding specified in standard are left out

var ErrUnsupportedEncoding error ErrUnsupportedEncoding is returned when the selected encoding is not known or implemented.