Struct base64_simd::Base64

pub struct Base64 { /* private fields */ }

Base64 variant

Implementations

impl Base64

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

Returns the character set.

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

Calculates the encoded length.

Panics

This function will panic if 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.

Errors

This function returns Err if the content of data is partially invalid.

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

Checks whether data is a base64 string.

Errors

This function returns Err if the content of data is invalid.

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

Encodes bytes to a base64 string.

Panics

This function will panic if the length of dst is not enough.

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

Encodes bytes to a base64 string and returns &mut str.

Panics

This function will panic if the length of dst is not enough.

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

Decodes a base64 string to bytes.

Errors

This function returns Err if the content of src is invalid.

Panics

This function will panic if the length of dst is not enough.

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

Decodes a base64 string to bytes and writes inplace.

Errors

This function returns Err if the content of data is invalid.

pub fn encode_type<T: FromBase64Encode>(&self, data: impl AsRef<[u8]>) -> T

Encodes bytes to a base64 string and returns a specified type.

pub fn decode_type<T: FromBase64Decode>(
    &self,
    data: impl AsRef<[u8]>
) -> Result<T, Error>

Decodes a base64 string to bytes and returns a specified type.

Errors

This function returns Err if the content of data is invalid.

pub fn encode_append<T: AppendBase64Encode>(
    &self,
    src: impl AsRef<[u8]>,
    dst: &mut T
)

Encodes bytes to a base64 string and appends to a specified type.

pub fn decode_append<T: AppendBase64Decode>(
    &self,
    src: impl AsRef<[u8]>,
    dst: &mut T
) -> Result<(), Error>

Decodes a base64 string to bytes and appends to a specified type.

Errors

This function returns Err if the content of src is invalid.

pub fn encode_to_string(&self, data: impl AsRef<[u8]>) -> String

Available on crate feature alloc only.

Encodes bytes to a base64 string.

pub fn decode_to_vec(&self, data: impl AsRef<[u8]>) -> Result<Vec<u8>, Error>

Available on crate feature alloc only.

Decodes a base64 string to bytes.

Errors

This function returns Err if the content of data is invalid.

Trait Implementations

impl Debug for Base64

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

Formats the value using the given formatter.