Struct Codec 

pub struct Codec<'a> { /* private fields */ }

BASE64 codec

Implementations

impl<'a> Codec<'a>

pub unsafe fn encode_to_raw( &self, src: &[u8], dst: NonNull<u8>, len: &mut usize, ) -> bool

Raw encoding function.

Arguments

• src - Input to encode;
• dst - Output to write;
• len - Output length, modified with required size regardless of outcome, unless calculation wrapping happens.

Result

Returns true on success.

Returns false if buffer overflow would to happen or required_len is too big.

pub unsafe fn decode_to_raw( &self, src: &[u8], dst: NonNull<u8>, len: &mut usize, ) -> bool

Raw decoding function.

Arguments

• src - Input to decode;
• dst - Output to write;
• len - Output length, modified with required size regardless of outcome.

Result

Returns true on success.

Returns false if buffer overflow would to happen or src is empty or invalid base64.

impl<'a> Codec<'a>

pub fn encode_to_uninit( self, src: &[u8], dst: &mut [MaybeUninit<u8>], ) -> Option<usize>

Encoding function writing to uninit slice.

Arguments

• src - Input to encode;
• dst - Output to write;

Result

Returns Some if successful, containing number of bytes written.

Returns None if data cannot be encoded due to insufficient buffer size or size calculation overflow happens.

pub fn decode_to_uninit( &self, src: &[u8], dst: &mut [MaybeUninit<u8>], ) -> Option<usize>

Decoding function writing to uninit slice.

Arguments

• src - Input to decode;
• dst - Output to write;

Result

Returns Some if successful, containing number of bytes written.

Returns None if data cannot be encoded due to insufficient buffer size or invalid input.

impl<'a> Codec<'a>

pub fn encode_into_vec(&self, src: &[u8]) -> Vec<u8>

Encoding function returns vector with data written.

Requires feature alloc.

Arguments

• src - Input to encode;

Panics

In case of required size to be too big

pub fn decode_into_vec(&self, src: &[u8]) -> Option<Vec<u8>>

Decoding function returns vector with data written.

Requires feature alloc.

Arguments

• src - Input to decode;

Result

Returns Some if successful, containing decoded output

Returns None if src is invalid input.

impl<'a> Codec<'a>

pub fn encode_into_string(&self, src: &[u8]) -> String

Encoding function returns string.

Requires feature alloc.

Arguments

• src - Input to encode;

Panics

In case of required size to be too big or table contains non-ASCII characters

impl<'a> Codec<'a>

pub const fn new(table: &'a [u8; 64]) -> Self

Creates new codec, validating that table contains only ASCII characters.

pub fn standard() -> &'static Codec<'static>

Access prebuilt instance of codec with STANDARD_TABLE

pub fn url_usafe() -> &'static Codec<'static>

Access prebuilt instance of codec with URL_TABLE

impl<'a> Codec<'a>

pub fn encode_to(&self, src: &[u8], dst: &mut [u8]) -> Option<usize>

Encoding function writing to slice.

Arguments

• src - Input to encode;
• dst - Output to write;

Result

Returns Some if successful, containing number of bytes written.

Returns None if data cannot be encoded due to insufficient buffer size or size calculation overflow happens.

pub fn decode_to(&self, src: &[u8], dst: &mut [u8]) -> Option<usize>

Decoding function writing to slice.

Arguments

• src - Input to decode;
• dst - Output to write;

Result

Returns Some if successful, containing number of bytes written.

Returns None if data cannot be encoded due to insufficient buffer size or invalid input.

Trait Implementations

impl<'a> Clone for Codec<'a>

fn clone(&self) -> Codec<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Codec<'a>