Struct Encoding 

pub struct Encoding<const N: usize> { /* private fields */ }

A compile-time dictionary for base-N encoding/decoding.

Type Parameters

• N: The base (must be a power of 2 and <= 256)
• PAD: Optional padding character (0 means no padding)

Implementations

impl<const N: usize> Encoding<N>

pub const BITS_PER_CHAR: u32

The number of bits encoded per character.

pub const GROUP_IN: usize

The input group size (number of bytes per encoding group).

pub const GROUP_OUT: usize

The output group size (number of characters per encoding group).

pub const MASK: u8

The bit mask for extracting character values.

pub const fn new(alphabet: &[u8; N], pad: Option<u8>) -> Self

Creates a new encoding from an alphabet.

pub const fn with_lowercase(self) -> Self

Add lowercase aliases for [A-Z] if present in alphabet.

pub const fn mask(&self) -> u8

Returns the bit mask for extracting character values.

pub const fn group_size_out(&self) -> usize

Returns the output group size (number of characters per encoding group).

pub const fn group_size_in(&self) -> usize

Returns the input group size (number of bytes per encoding group).

pub const fn padding(&self) -> Option<u8>

Returns the padding character if padding is enabled.

pub const fn bits_per_char(&self) -> u32

Returns the bits per character.

pub const fn encode_len(&self, src_len: usize) -> usize

Returns the exact encoded length for a given source byte length.

pub const fn decode_len(&self, chars_len_upto_pad: usize) -> usize

Returns the decoded length for a given number of characters (excluding padding).

pub const fn encode(&self, value: u8) -> u8

Encodes a single value (masked to valid range) to its character.

pub const fn decode(&self, ch: u8) -> Option<u8>

Decodes a single character to its value, returning None for invalid characters.

pub const fn encode_mut(&self, src: &[u8], dst: &mut [u8]) -> usize

Encodes bytes into a mutable buffer, returning the number of characters written. Routes to optimized implementation at runtime or const fallback at compile time.

pub const fn decode_mut(&self, src: &[u8], dst: &mut [u8]) -> Result<usize>

Decodes characters into a mutable buffer, returning the number of bytes written. Routes to optimized implementation at runtime or const fallback at compile time.

pub const fn encode_n<const L: usize>(&self, src: &[u8; L]) -> ArrayStr<L>

Encodes a fixed-size byte array, returning an ArrayStr wrapper.

pub const fn decode_n<const L: usize>(&self, src: &[u8; L]) -> Option<Array<L>>

Decodes a fixed-size character array, returning an Array wrapper.

pub const fn encode_writer<W: Write>(&self, inner: W) -> EncodeWriter<W, N>

Creates an encoding writer that wraps an io::Write and encodes bytes before writing them.

The returned writer buffers input, encodes it using this encoding, and writes the encoded output to the inner writer.

Examples

use std::io::Write;

use omp_core::base64;

let mut output = Vec::new();
let mut writer = base64::STD.encode_writer(&mut output);
writer.write_all(b"Hello").unwrap();
writer.flush().unwrap();

pub const fn decode_writer<W: Write>(&self, inner: W) -> DecodeWriter<W, N>

Creates a decoding writer that wraps an io::Write and decodes bytes before writing them.

The returned writer buffers encoded input, decodes it using this encoding, and writes the decoded output to the inner writer.

Examples

use std::io::Write;

use omp_core::base64;

let mut output = Vec::new();
{
	let mut writer = base64::STD.decode_writer(&mut output);
	writer.write_all(b"SGVsbG8=").unwrap();
	writer.flush().unwrap();
}
assert_eq!(output, b"Hello");

Trait Implementations

impl<const N: usize> Clone for Encoding<N>

fn clone(&self) -> Encoding<N>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const N: usize> Copy for Encoding<N>

impl<const N: usize> Debug for Encoding<N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.