base36

README

multiformats/go-base36

Simple base36 codec

This is an optimized codec for []byte <=> base36 string conversion

Documentation

https://pkg.go.dev/github.com/multicodec/go-base36

Lead Maintainer

Steven Allen

Contributing

Contributions are welcome! This repository is related to the IPFS project and therefore governed by our contributing guidelines.

License

SPDX-License-Identifier: Apache-2.0 OR MIT

Documentation

Overview

Package base36 provides a reasonably fast implementation of a binary base36 codec.

Index

• Constants
• func DecodeString(s string) ([]byte, error)
• func EncodeToStringLc(b []byte) string
• func EncodeToStringUc(b []byte) string

Constants

const LcAlphabet = "0123456789abcdefghijklmnopqrstuvwxyz"

const UcAlphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"

Functions

func DecodeString

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

DecodeString takes a base36 encoded string and returns a slice of the decoded bytes.

func EncodeToStringLc

func EncodeToStringLc(b []byte) string

EncodeToStringLc encodes the given byte-buffer as base36 using [0-9a-z] as the digit-alphabet

func EncodeToStringUc

func EncodeToStringUc(b []byte) string

EncodeToStringUc encodes the given byte-buffer as base36 using [0-9A-Z] as the digit-alphabet