Enum Algorithm

#[non_exhaustive]
pub enum Algorithm {
    Sha512,
    Sha384,
    Sha256,
    Sha1,
    Xxh3,
}

Valid algorithms for integrity strings.

Sha1 and Xxh3 are special cases in this library–they’re not allowed by the current SRI spec, but they’re useful enough that having first-class support makes sense. They should also be completely harmless to have in your strings if you do use it in a browser context–they just won’t be used.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Sha512

Sha384

Sha256

Sha1

Xxh3

xxh3 is a non-cryptographic hash function that is very fast and can be used to speed up integrity calculations, at the cost of cryptographically-secure guarantees.

ssri uses 128-bit xxh3 hashes, which have been shown to have no conflicts even on billions of hashes.

Trait Implementations

impl Clone for Algorithm

fn clone(&self) -> Algorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Algorithm

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

Formats the value using the given formatter.

impl Display for Algorithm

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

Formats the value using the given formatter.

impl FromStr for Algorithm

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Algorithm, <Algorithm as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Algorithm

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

where __H: Hasher,

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 Ord for Algorithm

fn cmp(&self, other: &Algorithm) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Algorithm

fn eq(&self, other: &Algorithm) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Algorithm

fn partial_cmp(&self, other: &Algorithm) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Algorithm

impl Eq for Algorithm

impl StructuralPartialEq for Algorithm