Struct Profile 

pub struct Profile<A, const PAD: bool> { /* private fields */ }

A named Base64 profile with an engine and optional strict line wrapping.

Profiles are convenience values for protocol-shaped Base64. They keep the same strict alphabet, padding, canonical-bit, and output-buffer rules as Engine, while carrying the wrapping policy for MIME/PEM-like formats.

Implementations

impl<A, const PAD: bool> Profile<A, PAD>

where A: Alphabet,

pub const fn new(engine: Engine<A, PAD>, wrap: Option<LineWrap>) -> Self

Creates a profile from an engine and optional strict line wrapping.

pub const fn engine(&self) -> Engine<A, PAD>

Returns the underlying engine.

pub const fn line_wrap(&self) -> Option<LineWrap>

Returns the strict wrapping policy carried by this profile, if any.

pub const fn encoded_len(&self, input_len: usize) -> Result<usize, EncodeError>

Returns the encoded length for this profile.

pub fn decoded_len(&self, input: &[u8]) -> Result<usize, DecodeError>

Returns the exact decoded length for this profile.

pub fn validate_result(&self, input: &[u8]) -> Result<(), DecodeError>

Validates input according to this profile without writing decoded bytes.

pub fn validate(&self, input: &[u8]) -> bool

Returns whether input is valid for this profile.

pub fn encode_slice( &self, input: &[u8], output: &mut [u8], ) -> Result<usize, EncodeError>

Encodes input into output according to this profile.

pub fn encode_slice_clear_tail( &self, input: &[u8], output: &mut [u8], ) -> Result<usize, EncodeError>

Encodes input into output and clears all bytes after the encoded prefix.

pub fn encode_buffer<const CAP: usize>( &self, input: &[u8], ) -> Result<EncodedBuffer<CAP>, EncodeError>

Encodes input into a stack-backed buffer.

This is useful for short values where heap allocation is unnecessary. If encoding fails, the internal backing array is cleared before the error is returned.

pub fn decode_slice( &self, input: &[u8], output: &mut [u8], ) -> Result<usize, DecodeError>

Decodes input into output according to this profile.

pub fn decode_slice_clear_tail( &self, input: &[u8], output: &mut [u8], ) -> Result<usize, DecodeError>

Decodes input into output and clears all bytes after the decoded prefix.

pub fn encode_vec(&self, input: &[u8]) -> Result<Vec<u8>, EncodeError>

Encodes input into a newly allocated byte vector.

pub fn encode_secret(&self, input: &[u8]) -> Result<SecretBuffer, EncodeError>

Encodes input into a redacted owned secret buffer.

pub fn encode_string(&self, input: &[u8]) -> Result<String, EncodeError>

Encodes input into a newly allocated UTF-8 string.

pub fn decode_vec(&self, input: &[u8]) -> Result<Vec<u8>, DecodeError>

Decodes input into a newly allocated byte vector.

pub fn decode_secret(&self, input: &[u8]) -> Result<SecretBuffer, DecodeError>

Decodes input into a redacted owned secret buffer.

Trait Implementations

impl<A: Clone, const PAD: bool> Clone for Profile<A, PAD>

fn clone(&self) -> Profile<A, PAD>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Debug, const PAD: bool> Debug for Profile<A, PAD>

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

Formats the value using the given formatter.

impl<A: PartialEq, const PAD: bool> PartialEq for Profile<A, PAD>

fn eq(&self, other: &Profile<A, PAD>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<A: Copy, const PAD: bool> Copy for Profile<A, PAD>

impl<A: Eq, const PAD: bool> Eq for Profile<A, PAD>

impl<A, const PAD: bool> StructuralPartialEq for Profile<A, PAD>