Struct rs_internal_state::KeccakState

pub struct KeccakState<T: Default + Copy> { /* private fields */ }

KeccakState<T> represents the internal state of the Keccak-based permutations with a variable width. It is used as the foundation for various NIST-validated hash algorithms and other Keccak-based constructions.

This implementation is designed to support multiple widths by varying the T type parameter, which corresponds to the following bit widths:

• u8: 200-bit permutation
• u16: 400-bit permutation
• u32: 800-bit permutation
• u64: 1600-bit permutation

The 1600-bit permutation (KeccakState<u64>) is the basis for the following NIST-validated hash algorithms:

• SHA-3 family of hash functions:

  • SHA3-224
  • SHA3-256
  • SHA3-384
  • SHA3-512

• Extendable-output functions (XOFs):

  • SHAKE128
  • SHAKE256

• RawSHAKE variants:

  • RawSHAKE128
  • RawSHAKE256

Please note that the NIST-validated hash algorithms are specifically based on the 1600-bit permutation (KeccakState<u64>). The other permutations (KeccakState<u8>, KeccakState<u16>, and KeccakState<u32>) can be used for other Keccak-based constructions or research purposes.

Implementations

impl<T> KeccakState<T>where T: BitAnd + BitAndAssign + BitOr<NBitWord<T>, Output = NBitWord<T>> + BitXor + BitXorAssign + Copy + Default + Not, NBitWord<T>: From<u64> + LittleEndianBytes + Not<Output = NBitWord<T>> + Rotate + TSize<T>, u32: Sub<NBitWord<T>, Output = NBitWord<T>>,

pub fn apply_f(&mut self)

Trait Implementations

impl<T: Clone + Default + Copy> Clone for KeccakState<T>

fn clone(&self) -> KeccakState<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Default + Copy> Debug for KeccakState<T>

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

Formats the value using the given formatter.

impl<T: Copy + Default> Default for KeccakState<T>

fn default() -> Self

Returns the “default value” for a type.

impl From<[[u64; 5]; 5]> for KeccakState<u64>

fn from(planes: [[u64; 5]; 5]) -> Self

Converts to this type from the input type.

impl<T: Hash + Default + Copy> Hash for KeccakState<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq + Default + Copy> PartialEq<KeccakState<T>> for KeccakState<T>

fn eq(&self, other: &KeccakState<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Eq + Default + Copy> Eq for KeccakState<T>

impl<T: Default + Copy> StructuralEq for KeccakState<T>

impl<T: Default + Copy> StructuralPartialEq for KeccakState<T>