yabase - v0.10.0

yabase/core/encoding

Types

Base32Variant

opaque </>

Variants for Base32 encoding.

pub opaque type Base32Variant

Base58Variant

opaque </>

Variants for Base58 encoding.

pub opaque type Base58Variant

Base64Variant

opaque </>

Variants for Base64 encoding.

pub opaque type Base64Variant

Base85Variant

opaque </>

Variants for Base85 encoding.

pub opaque type Base85Variant

CodecError

</>

Re-export of error.CodecError so the historical import yabase/core/encoding.{type CodecError} shape keeps working. Other error types (Bech32Variant, Bech32Decoded, Base58CheckDecoded) are no longer re-exported — import them directly from yabase/core/error.

pub type CodecError =
  error.CodecError

Decoded

</>

A decoded value tagged with its detected encoding.

pub type Decoded {
  Decoded(encoding: Encoding, data: BitArray)
}

Constructors 

  • Decoded(encoding: Encoding, data: BitArray)

Encoding

opaque </>

Represents a supported encoding scheme.

pub opaque type Encoding

Values

base10

</> 
pub fn base10() -> Encoding

base16

</> 
pub fn base16() -> Encoding

base2

</> 
pub fn base2() -> Encoding

base32_clockwork

</> 
pub fn base32_clockwork() -> Encoding

base32_crockford

</> 
pub fn base32_crockford() -> Encoding

base32_crockford_check

</> 
pub fn base32_crockford_check() -> Encoding

base32_hex

</> 
pub fn base32_hex() -> Encoding

base32_rfc4648

</> 
pub fn base32_rfc4648() -> Encoding

base32_z_base32

</> 
pub fn base32_z_base32() -> Encoding

base36

</> 
pub fn base36() -> Encoding

base45

</> 
pub fn base45() -> Encoding

base58_bitcoin

</> 
pub fn base58_bitcoin() -> Encoding

base58_flickr

</> 
pub fn base58_flickr() -> Encoding

base62

</> 
pub fn base62() -> Encoding

base64_dq

</> 
pub fn base64_dq() -> Encoding

base64_no_padding

</> 
pub fn base64_no_padding() -> Encoding

base64_standard

</> 
pub fn base64_standard() -> Encoding

base64_url_safe

</> 
pub fn base64_url_safe() -> Encoding

base64_url_safe_no_padding

</> 
pub fn base64_url_safe_no_padding() -> Encoding

base8

</> 
pub fn base8() -> Encoding

base85_adobe

</> 
pub fn base85_adobe() -> Encoding

base85_btoa

</> 
pub fn base85_btoa() -> Encoding

base85_rfc1924

</> 
pub fn base85_rfc1924() -> Encoding

base85_z85

</> 
pub fn base85_z85() -> Encoding

base91

</> 
pub fn base91() -> Encoding

decode_as

</> 
pub fn decode_as(
  enc: Encoding,
  value: String,
) -> Result(BitArray, error.CodecError)

Decode a string using the specified encoding.

encode

</> 
pub fn encode(
  enc: Encoding,
  data: BitArray,
) -> Result(String, error.CodecError)

Encode data using the specified encoding.

from_multibase_prefix

</> 
pub fn from_multibase_prefix(
  prefix: String,
) -> Result(Encoding, Nil)

Map a multibase prefix character to its Encoding.

multibase_name

</> 
pub fn multibase_name(enc: Encoding) -> String

Human-readable name for an Encoding.

multibase_prefix

</> 
pub fn multibase_prefix(enc: Encoding) -> Result(String, Nil)

Map an Encoding to its official multibase prefix character.

normalise_for_multibase_prefix

</> 
pub fn normalise_for_multibase_prefix(
  enc: Encoding,
  encoded: String,
) -> String

Lowercase the dispatcher’s output for encodings whose multibase prefix pins lowercase output (currently Base16 under prefix f).

✨ Search Document