Struct RescueSponge

pub struct RescueSponge<F: RescueParameter, const RATE: usize> { /* private fields */ }

A rescue hash function consists of a permutation function and an internal state.

Trait Implementations

impl<F: Clone + RescueParameter, const RATE: usize> Clone for RescueSponge<F, RATE>

fn clone(&self) -> RescueSponge<F, RATE>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: RescueParameter + PrimeField, const RATE: usize> CryptographicSponge for RescueSponge<T, RATE>

type Config = Permutation<T>

Config used by the sponge.

fn new(permutation: &Self::Config) -> Self

Initialize a new instance of the sponge.

fn absorb(&mut self, input: &impl Absorb)

Absorb an input into the sponge. This function will absorb the entire input, in chunks of RATE, even if the input length is not a multiple of RATE.

fn squeeze_bytes(&mut self, _num_bytes: usize) -> Vec<u8>

WARNING! This trait method is unimplemented and should not be used. Only use the CryptographicSponge for squeezing native field elements.

fn squeeze_bits(&mut self, _num_bits: usize) -> Vec<bool>

WARNING! This trait method is unimplemented and should not be used. Only use the CryptographicSponge for squeezing native field elements.

fn squeeze_field_elements_with_sizes<F: PrimeField>( &mut self, _sizes: &[FieldElementSize], ) -> Vec<F>

WARNING! This trait method is unimplemented and should not be used. Use squeeze_native_field_elements instead.

fn squeeze_field_elements<F: PrimeField>( &mut self, _num_elements: usize, ) -> Vec<F>

WARNING! This trait method is unimplemented and should not be used. Use squeeze_native_field_elements instead.

fn fork(&self, domain: &[u8]) -> Self

Creates a new sponge with applied domain separation.

impl<F: Debug + RescueParameter, const RATE: usize> Debug for RescueSponge<F, RATE>

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

Formats the value using the given formatter.

impl<F: Default + RescueParameter, const RATE: usize> Default for RescueSponge<F, RATE>

fn default() -> RescueSponge<F, RATE>

Returns the “default value” for a type.

impl<T: RescueParameter, const RATE: usize> FieldBasedCryptographicSponge<T> for RescueSponge<T, RATE>

The interface for field-based cryptographic sponge. T is the native field used by the cryptographic sponge implementation.

fn squeeze_native_field_elements(&mut self, num_elements: usize) -> Vec<T>

Squeeze num_elements field elements from the sponge.

fn squeeze_native_field_elements_with_sizes( &mut self, _sizes: &[FieldElementSize], ) -> Vec<T>

WARNING! This trait method is unimplemented and should not be used. Use squeeze_native_field_elements instead.

impl<F: RescueParameter, const RATE: usize> SpongeExt for RescueSponge<F, RATE>

type State = RescueVector<F>

The full state of the cryptographic sponge.

fn from_state(state: Self::State, permutation: &Self::Config) -> Self

Returns a sponge that uses state.

fn into_state(self) -> Self::State

Consumes self and returns the state.