Struct Base64String 

pub struct Base64String<S: Codec> { /* private fields */ }

An owned ordinary Base64 string validated by one exact codec policy.

The value retains the Base64<S> used to encode or validate its text, so its decode methods cannot accidentally select a different alphabet, padding, or trailing-bit policy. Construction either encodes bytes through that codec or validates complete encoded text before ownership is returned. There is deliberately no mutable string access.

This is an ordinary, visibly printable, cloneable value. It performs no cleanup and is not suitable for keys, tokens, passwords, or other secret material. Use the secret module for secret-bearing data.

Implementations

impl<S: Codec> Base64String<S>

pub fn encode(codec: Base64<S>, input: &[u8]) -> Result<Self, OneShotError>

Encodes bytes and retains the exact codec policy with the result.

Allocation and length errors use the same contract as Base64::encode_to_string.

pub fn from_string( codec: Base64<S>, encoded: String, ) -> Result<Self, OneShotError>

Validates and adopts an existing owned string without copying it.

The complete string must satisfy the supplied codec’s decode policy. On error, this function consumes and drops the supplied ordinary string.

pub fn parse(codec: Base64<S>, encoded: &str) -> Result<Self, OneShotError>

Validates and copies an encoded string slice into owned storage.

Validation completes before allocation. The copy uses try_reserve_exact, returning OneShotError::AllocationFailed if the reservation cannot be made.

pub const fn codec(&self) -> &Base64<S>

Returns the exact codec retained by this string.

pub fn settings(&self) -> CodecSettings

Returns the retained codec settings.

pub fn as_str(&self) -> &str

Returns the validated encoded text.

Passing this ordinary view to another codec can deliberately discard the retained policy. Use Self::decode to preserve it.

pub fn as_bytes(&self) -> &[u8]

Returns the validated encoded bytes.

Passing this ordinary view to another codec can deliberately discard the retained policy. Use Self::decode to preserve it.

pub fn len(&self) -> usize

Returns the encoded byte length.

pub fn is_empty(&self) -> bool

Returns whether the encoded text is empty.

pub fn decode(&self) -> Result<Vec<u8>, OneShotError>

Decodes the validated text with its retained codec.

pub fn decode_with_limit( &self, max_output_len: usize, ) -> Result<Vec<u8>, OneShotError>

Decodes with an exact maximum output length.

pub fn into_string(self) -> String

Consumes the wrapper and returns the validated ordinary string.

The returned String no longer carries the codec policy.

Trait Implementations

impl<S: Codec> AsRef<[u8]> for Base64String<S>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<S: Codec> AsRef<str> for Base64String<S>

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<S: Clone + Codec> Clone for Base64String<S>

fn clone(&self) -> Base64String<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + Codec> Debug for Base64String<S>

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

Formats the value using the given formatter.

impl<S: Codec> Display for Base64String<S>

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

Formats the value using the given formatter.

impl<S: Eq + Codec> Eq for Base64String<S>

impl<S: Hash + Codec> Hash for Base64String<S>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<S: PartialEq + Codec> PartialEq for Base64String<S>

fn eq(&self, other: &Base64String<S>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<S: PartialEq + Codec> StructuralPartialEq for Base64String<S>