apiculture - v0.3.0

apiculture/encoding

Encoding abstraction.

This module is a thin wrapper around yabase for encoding and decoding bytes. It normalizes decoding failures to apiculture’s Error type and records whether an encoding uses padding.

Types

Encoding

</>

A byte-to-text encoding and its padding behavior.

pub type Encoding {
  Encoding(inner: encoding.Encoding, uses_padding: Bool)
}

Constructors

Values

base32_crockford

</> 
pub fn base32_crockford() -> Encoding

Crockford’s Base32 encoding.

base32_hex

</> 
pub fn base32_hex() -> Encoding

Base32hex encoding.

base32_rfc

</> 
pub fn base32_rfc() -> Encoding

RFC 4648 Base32 encoding (padded variant).

base32_rfc_unpadded

</> 
pub fn base32_rfc_unpadded() -> Encoding

RFC 4648 Base32 encoding (unpadded variant).

base32_z

</> 
pub fn base32_z() -> Encoding

z-base-32 encoding.

base36

</> 
pub fn base36() -> Encoding

Base36 encoding (lowercase).

base58

</> 
pub fn base58() -> Encoding

Base58 encoding (Bitcoin alphabet).

base62

</> 
pub fn base62() -> Encoding

Base62 encoding.

base64

</> 
pub fn base64() -> Encoding

Standard Base64 encoding.

base64_url

</> 
pub fn base64_url() -> Encoding

Base64URL encoding (URL-safe).

decode

</> 
pub fn decode(
  encoding: Encoding,
  input: String,
) -> Result(BitArray, error.Error)

Decode string to bytes using the given encoding.

encode

</> 
pub fn encode(encoding: Encoding, bytes: BitArray) -> String

Encode bytes to string using the given encoding.

hex_lower

</> 
pub fn hex_lower() -> Encoding

Lowercase hexadecimal encoding.

hex_upper

</> 
pub fn hex_upper() -> Encoding

Uppercase hexadecimal encoding.

name

</> 
pub fn name(encoding: Encoding) -> String

Returns the name of the encoding.

uses_padding

</> 
pub fn uses_padding(encoding: Encoding) -> Bool

Returns whether the encoding uses padding.

✨ Search Document