Struct aliri_base64::Base64

#[repr(transparent)]
pub struct Base64(_);

Owned data to be encoded as standard base64

Encoding alphabet: A–Z, a–z, 0–9, +, /

Padding character: =

Data is held in memory in its raw form. Costs of serialization are only incurred when serializing or displaying the value in its base64 representation.

Implementations of the From trait assume that assume that the underlying structure is in raw form.

Implementations

impl Base64

pub const fn new() -> Self

Creates an empty buffer

pub fn from_raw<T: Into<Vec<u8>>>(raw: T) -> Self

Creates a new buffer from an owned value

This function has no cost for Vec<u8>. Other types incur the cost of copying into a buffer.

To decode a base64-encoded buffer, use from_encoded().

pub fn from_encoded<T: AsRef<[u8]>>(enc: T) -> Result<Self, InvalidBase64Data>

Constructs a new buffer from a base64-encoded slice

This function will decode the slice into a new owned buffer.

If the underlying buffer has already been decoded, then transparently wrap the buffer using from_raw().

pub fn into_inner(self) -> Vec<u8>

Unwraps the underlying buffer

pub fn as_vec(&self) -> &Vec<u8>

Provides access to the underlying buffer as a vector

pub fn as_vec_mut(&mut self) -> &mut Vec<u8>

Provides mutable access to the underlying buffer as a vector

pub const fn calc_encoded_len(len: usize) -> usize

Calculates the expected length of the base64-encoding for a buffer of size len

Methods from Deref<Target = Base64Ref>

pub const fn encoded_len(&self) -> usize

Calculates the expected length of the base64-encoding of this buffer

pub const fn as_slice(&self) -> &[u8]

Provides access to the underlying slice

pub fn as_mut_slice(&mut self) -> &mut [u8]

Provides mutable access to the underlying slice

Trait Implementations

impl AsRef<Base64Ref> for Base64

fn as_ref(&self) -> &Base64Ref

Performs the conversion.

impl Borrow<Base64Ref> for Base64

fn borrow(&self) -> &Base64Ref

Immutably borrows from an owned value.

impl Clone for Base64

fn clone(&self) -> Base64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Base64

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

Formats the value using the given formatter.

impl Deref for Base64

type Target = Base64Ref

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Base64

fn deref_mut(&mut self) -> &mut Base64Ref

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Base64

This is supported on crate feature serde only.

Deserialize a base64 string and decode it into a byte array

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Base64

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

Formats the value using the given formatter.

impl Eq for Base64

impl From<&'_ [u8]> for Base64

fn from(slice: &[u8]) -> Self

Performs the conversion.

impl From<&'_ Base64Ref> for Base64

fn from(val: &Base64Ref) -> Self

Performs the conversion.

impl From<Vec<u8, Global>> for Base64

fn from(buf: Vec<u8>) -> Self

Performs the conversion.

impl Hash for Base64

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Base64> for Base64

fn eq(&self, other: &Base64) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<Base64> for Base64Ref

fn eq(&self, other: &Base64) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl PartialEq<Base64Ref> for Base64

fn eq(&self, other: &Base64Ref) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl Serialize for Base64

This is supported on crate feature serde only.

Serialize the underlying byte array as a base64 string

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralEq for Base64

impl StructuralPartialEq for Base64