Struct base64_simd::Base64

pub struct Base64 { /* private fields */ }

Base64 variants

• Base64::STANDARD
• Base64::STANDARD_NO_PAD
• Base64::URL_SAFE
• Base64::URL_SAFE_NO_PAD

Implementations

impl Base64

pub const STANDARD: Self = _

Standard charset with padding.

pub const STANDARD_NO_PAD: Self = _

Standard charset without padding.

pub const URL_SAFE: Self = _

URL-safe charset with padding.

pub const URL_SAFE_NO_PAD: Self = _

URL-safe charset without padding.

pub const fn charset(&self) -> &[u8; 64]

Returns the character set used for encoding.

pub const fn encoded_length(&self, n: usize) -> usize

Calculates the encoded length.

Panics

This function panics if any of the conditions below is not satisfied:

• n <= isize::MAX

pub const fn estimated_decoded_length(&self, n: usize) -> usize

Estimates the decoded length.

The result is an upper bound which can be used for allocation.

pub fn decoded_length(&self, data: &[u8]) -> Result<usize, Error>

Calculates the decoded length.

The result is a precise value which can be used for allocation.

pub fn encode<'s, 'd>(
    &self,
    src: &'s [u8],
    dst: OutBuf<'d, u8>
) -> Result<&'d mut [u8], Error>

Encodes src and writes to dst.

Errors

This function returns Err if:

• The length of dst is not enough.

pub fn encode_as_str<'s, 'd>(
    &self,
    src: &'s [u8],
    dst: OutBuf<'d, u8>
) -> Result<&'d mut str, Error>

Encodes src to dst and returns &mut str.

Errors

This function returns Err if:

• The length of dst is not enough.

pub fn decode<'s, 'd>(
    &self,
    src: &'s [u8],
    dst: OutBuf<'d, u8>
) -> Result<&'d mut [u8], Error>

Decodes src and writes to dst.

Errors

This function returns Err if:

• The length of dst is not enough.
• The content of src is invalid.

pub fn decode_inplace<'d>(
    &self,
    data: &'d mut [u8]
) -> Result<&'d mut [u8], Error>

Decodes data and writes inplace.

Errors

This function returns Err if:

• The content of data is invalid.

pub fn encode_to_boxed_str(&self, data: &[u8]) -> Box<str>

Available on crate feature alloc only.

Encodes data and returns Box<str>

Panics

This function panics if:

• The encoded length of data is greater than isize::MAX

pub fn decode_to_boxed_bytes(&self, data: &[u8]) -> Result<Box<[u8]>, Error>

Available on crate feature alloc only.

Decodes data and returns Box<[u8]>

Errors

This function returns Err if:

• The content of data is invalid.

pub fn forgiving_decode_inplace(data: &mut [u8]) -> Result<&mut [u8], Error>

Forgiving decodes data and writes inplace.

See https://infra.spec.whatwg.org/#forgiving-base64

Trait Implementations

impl Debug for Base64

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

Formats the value using the given formatter.