package
0.1.22
Repository: https://github.com/keys-pub/keys.git
Documentation: pkg.go.dev

# README

Encoding

encoding.MustEncode(keys.RandBytes(16), encoding.Base32, encoding.NoPadding(), encoding.Lowercase())

# Functions

BreakString breaks words and lines.
BytesToPhrase returns a phrase for bytes.
Decode decodes string to bytes using encoding.
DecodeBase32 decode base32.
DecodeBase62 decode base62.
DecodeBase64 decode base64.
DecodeHex decode base16 (hex).
DecodeSaltpack decodes saltpack message.
Encode encodes bytes to an Encoding.
EncodeBase32 encode base32.
EncodeBase62 encode base62.
EncodeBase64 encode base64.
EncodeHex encode base16 (hex).
EncodeSaltpack encodes bytes to saltpack message.
FindSaltpack finds saltpack message in a string starting with "BEGIN {BRAND }MESSAGE." and ending with "END {BRAND }MESSAGE".
HasUpper returns true if string has an uppercase character.
IsAlphaNumeric returns true if string is only a-z, A-Z, 0-9 with optional extra characters.
IsASCII returns true if bytes are ASCII.
IsValidPhrase checks is phrase is valid.
Lowercase ...
MustDecode decodes or panics.
MustEncode returns encoding or panics on error.
NewEncoding returns an Encoding from a string.
NoPadding ...
Parse returns an Encoding from a string.
ParseOr returns an Encoding from a string, or if empty, a default.
PhraseToBytes decodes a bip39 mnemonic into bytes.
TrimSaltpack removes non base63 characters from a string.

# Constants

Base32 encoding.
Base58 encoding.
Base62 encoding.
Base64 encoding (with padding).
BIP39 encoding.
Hex (Base16) encoding.
NoEncoding ...
Saltpack encoding.

# Variables

ErrInvalidBIP39Input if invalid number of bytes for encoding.

# Structs

EncodeOption ...
EncodeOptions ...
ErrInvalidPhrase if phrase is invalid.

# Type aliases

Encoding is an encoding for bytes to and from a string.
TextMarshaler alias for encoding.TextMarshaler.