Struct SixBitCodec 

pub struct SixBitCodec { /* private fields */ }

A Six Bit Codec encodes 3x eight-bit bytes (24 bits) into 4x six-bit symbols. Likewise, reads 4x six-bit symbols and decodes them into 3x eight-bit bytes.

The alphabet size is 2^6 = 64 symbols.

Implementations

impl SixBitCodec

pub fn new(alphabet: &'static [u8; 64]) -> Self

Creates a new codec, using the provided alphabet.

pub fn set_pad(&mut self, pad: u8) -> &mut Self

sets the end padding character (defaults to '=')

pub fn set_fail_on_invalid_character(&mut self) -> &mut Self

if set, decoding will return an error on invalid character - otherwise will just skip it.

Trait Implementations

impl Codec for SixBitCodec

fn encode<I: Bits, O: MutBits>( &self, input: I, output: &mut O, ) -> Result<usize, Error>

Encodes the input, writing to output. Returns the total number of bytes written.

fn decode<I: Bits, O: MutBits>( &self, input: I, output: &mut O, ) -> Result<usize, Error>

Decodes the input, writing to output. Returns the total number of bytes written.

fn encode_to_str<I: Bits>(&self, input: I) -> Result<String, Error>

Available on crate feature alloc only.

Reads the entirety of the input in the raw format, and produces the encoded UTF-8 results in an owned string.

fn encode_to_vec<I: Bits>(&self, input: I) -> Result<Vec<u8>, Error>

Available on crate feature alloc only.

Reads the entirety of the input in the raw format, and produces the encoded results in an owned Vec

fn decode_to_str_lossy<I: Bits>(&self, input: I) -> Result<String, Error>

Available on crate feature alloc only.

Reads the entirety of input in coded format, and produces the results in an owned UTF-8 encoded string, dropping any non-UTF-8 characters.

fn decode_to_vec<I: Bits>(&self, input: I) -> Result<Vec<u8>, Error>

Available on crate feature alloc only.

Reads the entirety of input in coded format, and produces the results in an owned Vec