Struct Avx2 

pub struct Avx2 {
    inner: GeneralPurpose,
    kind: SimdKind,
}

A base64 engine that unconditionally uses AVX2, without runtime detection.

This works in no_std builds. Because it does not check for AVX2 support, it must only be used on a CPU that has it. Only the STANDARD and URL_SAFE alphabets are accelerated, so it is constructed with the Avx2::standard / Avx2::url_safe (checked) or Avx2::standard_unchecked / Avx2::url_safe_unchecked constructors.

Fields

inner: GeneralPurpose

kind: SimdKind

Implementations

impl Avx2

pub fn standard(config: GeneralPurposeConfig) -> Option<Self>

Create an Avx2 engine for the STANDARD alphabet if the running CPU supports AVX2, else None.

Requires the std feature for the detection; in no_std use Avx2::standard_unchecked.

pub fn url_safe(config: GeneralPurposeConfig) -> Option<Self>

Create an Avx2 engine for the URL_SAFE alphabet if the running CPU supports AVX2, else None.

Requires the std feature for the detection; in no_std use Avx2::url_safe_unchecked.

pub const unsafe fn standard_unchecked(config: GeneralPurposeConfig) -> Self

Create an Avx2 engine for the STANDARD alphabet without checking for AVX2 support.

Safety

The CPU that will run encode/decode must support AVX2. Using the engine on a CPU without AVX2 is undefined behavior.

pub const unsafe fn url_safe_unchecked(config: GeneralPurposeConfig) -> Self

Create an Avx2 engine for the URL_SAFE alphabet without checking for AVX2 support.

Safety

The CPU that will run encode/decode must support AVX2. Using the engine on a CPU without AVX2 is undefined behavior.

Trait Implementations

impl Clone for Avx2

fn clone(&self) -> Avx2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Avx2

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

Formats the value using the given formatter.

impl Engine for Avx2

Available on x86-64 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.