cidenc

Documentation

Index

• type Encoder
  • func Default() Encoder
  • func (enc Encoder) Encode(c cid.Cid) string
  • func (enc Encoder) Recode(v string) (string, error)

Types

type Encoder

type Encoder struct {
	Base    mbase.Encoder // The multibase to use
	Upgrade bool          // If true upgrade CIDv0 to CIDv1 when encoding
}

Encoder is a basic Encoder that will encode CIDs using a specified base and optionally upgrade a CIDv0 to CIDv1

func Default

func Default() Encoder

Default return a new default encoder

func (Encoder) Encode

func (enc Encoder) Encode(c cid.Cid) string

Encode encodes the cid using the parameters of the Encoder

func (Encoder) Recode

func (enc Encoder) Recode(v string) (string, error)

Recode reencodes the cid string to match the parameters of the encoder