Struct BufferSet 

pub struct BufferSet<Q: AsRef<[Align64<Block<R>>]> + AsMut<[Align64<Block<R>>]>, R: ArrayLength + NonZero> { /* private fields */ }

Scrypt with a fixed R value

Implementations

impl<R: ArrayLength + NonZero> BufferSet<Vec<Align64<Block<R>>>, R>

pub fn new_boxed(cf: NonZeroU8) -> Box<Self>

Create a new buffer set in a box with a given Cost Factor (log2(N))

impl<R: ArrayLength + NonZero> BufferSet<MaybeHugeSlice<Align64<Block<R>>>, R>

pub fn new_maybe_huge_slice( cf: NonZeroU8, ) -> BufferSet<MaybeHugeSlice<Align64<Block<R>>>, R>

Create a new buffer set in a huge page with a given Cost Factor (log2(N))

pub fn new_maybe_huge_slice_ex( cf: NonZeroU8, ) -> (BufferSet<MaybeHugeSlice<Align64<Block<R>>>, R>, Option<Error>)

Create a new buffer set in a huge page with a given Cost Factor (log2(N))

impl<Q: AsRef<[Align64<Block<R>>]> + AsMut<[Align64<Block<R>>]>, R: ArrayLength + NonZero> BufferSet<Q, R>

pub fn new(q: Q) -> Self

Create a new buffer set

Panics

Panics if the number of blocks is less than 4 or greater than MAX_N + 2.

pub fn try_new(q: Q) -> Option<Self>

Create a new buffer set if the number of blocks is between 4 and MAX_N + 2

Returns

None if the number of blocks is less than 4 or greater than MAX_N + 2

pub fn into_inner(self) -> Q

Consume the buffer set and return the inner buffer

pub fn input_buffer(&self) -> &Align64<Block<R>>

Get the block buffer as 32-bit words

pub fn input_buffer_mut(&mut self) -> &mut Align64<Block<R>>

Get the block buffer mutably as 32-bit words

pub fn set_input(&mut self, hmac_state: &Pbkdf2HmacSha256State, salt: &[u8])

Set the input for the block buffer

pub fn cf(&self) -> u8

Get the effective Cost Factor (log2(N)) for the buffer set

pub fn n(&self) -> usize

Get the effective N value for the buffer set

pub fn raw_salt_output(&self) -> &Align64<Block<R>>

Get the raw salt output, useful for concatenation for P>1 cases

pub fn extract_output( &self, hmac_state: &Pbkdf2HmacSha256State, output: &mut [u8], )

Extract the output from the block buffer

pub fn shorten( &mut self, cf: NonZeroU8, ) -> Option<(BufferSet<&mut [Align64<Block<R>>], R>, &mut [Align64<Block<R>>])>

Shorten the buffer set into a smaller buffer set and return the remainder as a slice, handy if you want to make a large allocation for the largest N you want to use and reuse it for multiple Cost Factors.

Returns

None if the number of blocks is less than the minimum number of blocks for the given Cost Factor.

pub fn ro_mix_front(&mut self)

Start an interleaved pipeline using the default engine by performing the $RoMix_{Front}$ operation.

pub fn ro_mix_back(&mut self)

Drain an interleaved pipeline using the default engine by performing the $RoMix_{Back}$ operation.

pub fn scrypt_ro_mix(&mut self)

Perform the RoMix operation using the default engine.

pub fn ro_mix_interleaved(&mut self, other: &mut Self)

Perform the RoMix operation with interleaved buffers.

$RoMix_{Back}$ is performed on self and $RoMix_{Front}$ is performed on other.

Panics

Panics if the buffers are of different equivalent Cost Factors.

pub fn pipeline<K, S, C: PipelineContext<S, Q, R, K>, I: IntoIterator<Item = C>>( &mut self, other: &mut Self, iter: I, state: &mut S, ) -> Option<K>

Pipeline RoMix operations on an iterator of inputs.

Trait Implementations

impl<Q: AsRef<[Align64<Block<R>>]> + AsMut<[Align64<Block<R>>]>, R: ArrayLength + NonZero> AsMut<Q> for BufferSet<Q, R>

fn as_mut(&mut self) -> &mut Q

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

impl<Q: AsRef<[Align64<Block<R>>]> + AsMut<[Align64<Block<R>>]>, R: ArrayLength + NonZero> AsRef<Q> for BufferSet<Q, R>

fn as_ref(&self) -> &Q

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

impl<Q: Clone + AsRef<[Align64<Block<R>>]> + AsMut<[Align64<Block<R>>]>, R: Clone + ArrayLength + NonZero> Clone for BufferSet<Q, R>

fn clone(&self) -> BufferSet<Q, R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Q: Debug + AsRef<[Align64<Block<R>>]> + AsMut<[Align64<Block<R>>]>, R: Debug + ArrayLength + NonZero> Debug for BufferSet<Q, R>

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

Formats the value using the given formatter.

impl<Q: AsRef<[Align64<Block<R>>]> + AsMut<[Align64<Block<R>>]> + Default, R: ArrayLength + NonZero> Default for BufferSet<Q, R>

fn default() -> Self

Returns the “default value” for a type.

impl<Q: Copy + AsRef<[Align64<Block<R>>]> + AsMut<[Align64<Block<R>>]>, R: Copy + ArrayLength + NonZero> Copy for BufferSet<Q, R>