pub struct GeneralPurpose { /* private fields */ }
Expand description

A general-purpose base64 engine.

  • It uses no vector CPU instructions, so it will work on any system.
  • It is reasonably fast (~2-3GiB/s).
  • It is not constant-time, though, so it is vulnerable to timing side-channel attacks. For loading cryptographic keys, etc, it is suggested to use the forthcoming constant-time implementation.

Implementations§

source§

impl GeneralPurpose

source

pub const fn new(alphabet: &Alphabet, config: GeneralPurposeConfig) -> Self

Create a GeneralPurpose engine from an Alphabet.

While not very expensive to initialize, ideally these should be cached if the engine will be used repeatedly.

Trait Implementations§

source§

impl Engine for GeneralPurpose

§

type Config = GeneralPurposeConfig

The config type used by this engine
§

type DecodeEstimate = GeneralPurposeEstimate

The decode estimate used by this engine
source§

fn config(&self) -> &Self::Config

Returns the config for this engine.
source§

fn encode<T: AsRef<[u8]>>(&self, input: T) -> String

Encode arbitrary octets as base64 using the provided Engine. Returns a String. Read more
source§

fn encode_string<T: AsRef<[u8]>>(&self, input: T, output_buf: &mut String)

Encode arbitrary octets as base64 into a supplied String. Writes into the supplied String, which may allocate if its internal buffer isn’t big enough. Read more
source§

fn encode_slice<T: AsRef<[u8]>>( &self, input: T, output_buf: &mut [u8] ) -> Result<usize, EncodeSliceError>

Encode arbitrary octets as base64 into a supplied slice. Writes into the supplied output buffer. Read more
source§

fn decode<T: AsRef<[u8]>>(&self, input: T) -> Result<Vec<u8>, DecodeError>

Decode from string reference as octets using the specified Engine. Returns a Result containing a Vec<u8>. Read more
source§

fn decode_vec<T: AsRef<[u8]>>( &self, input: T, buffer: &mut Vec<u8> ) -> Result<(), DecodeError>

Decode from string reference as octets. Writes into the supplied Vec, which may allocate if its internal buffer isn’t big enough. Returns a Result containing an empty tuple, aka (). Read more
source§

fn decode_slice<T: AsRef<[u8]>>( &self, input: T, output: &mut [u8] ) -> Result<usize, DecodeSliceError>

Decode the input into the provided output slice. Read more
source§

fn decode_slice_unchecked<T: AsRef<[u8]>>( &self, input: T, output: &mut [u8] ) -> Result<usize, DecodeError>

Decode the input into the provided output slice. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.