Struct Simd 

pub struct Simd {
    inner: GeneralPurpose,
    kind: SimdKind,
    backend: Backend,
}

A base64 engine that uses the best SIMD instruction set detected at runtime, falling back to the scalar GeneralPurpose engine.

Requires the std feature (for runtime CPU-feature detection) and an x86_64 or aarch64 target. On other targets, use GeneralPurpose directly. Only the STANDARD and URL_SAFE alphabets are accelerated, so it is constructed with Simd::standard / Simd::url_safe.

Fields

inner: GeneralPurpose

kind: SimdKind

backend: Backend

Implementations

impl Simd

pub fn standard(config: GeneralPurposeConfig) -> Self

Create a Simd engine for the STANDARD alphabet, detecting the instruction set once.

pub fn url_safe(config: GeneralPurposeConfig) -> Self

Create a Simd engine for the URL_SAFE alphabet, detecting the instruction set once.

fn new( kind: SimdKind, alphabet: &Alphabet, config: GeneralPurposeConfig, ) -> Self

Trait Implementations

impl Clone for Simd

fn clone(&self) -> Simd

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Simd

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

Formats the value using the given formatter.

impl Engine for Simd

Available on crate feature std and (x86-64 or AArch64) only.

type Config = GeneralPurposeConfig

The config type used by this engine

type DecodeEstimate = GeneralPurposeEstimate

The decode estimate used by this engine

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

Returns the config for this engine.

fn padding(&self) -> Symbol

Returns the symbol used for encode padding.

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

Encode arbitrary octets as base64 using the provided Engine. Returns a String.

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.

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.

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

Decode the input into a new Vec.

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

Decode the input into the supplied buffer.

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

Decode the input into the provided output slice.

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

Decode the input into the provided output slice.