Enum xvc_core::types::hashalgorithm::HashAlgorithm

pub enum HashAlgorithm {
    AsIs,
    Blake3,
    Blake2s,
    SHA2_256,
    SHA3_256,
}

The available content hash algorithms to get content addresses. Note that, the selection is based on the digest size being 32 bytes. We already represent this as 64 digit hex in the file hierarchies. Using a longer digests than 32 bytes will probably cause file length problems, especially in Windows.

The default algorithm is set by cache.algorithm config key.

See crate::XvcDigest for details of digest calculation.

Variants

AsIs

Do nothing. When the data to be hashed is already less than 32 bytes, it’s used as is. Please do not use this in your functions. This is currently only used to prevent crate::XvcMetadata to be hashed in xvc_ecs::HStore

Blake3

Use BLAKE3 to calculate digests: https://github.com/BLAKE3-team/BLAKE3 This is the default

Blake2s

Use BLAKE2S to calculate digests: https://www.blake2.net

SHA2_256

Use SHA2-256 to calculate digests. https://en.wikipedia.org/wiki/SHA-2 This may be used when FIPS/NIST compatibility is required.

SHA3_256

Use SHA2-256 to calculate digests: https://en.wikipedia.org/wiki/SHA-3 This may be used when NIST compatibility is required.

Trait Implementations

impl Clone for HashAlgorithm

fn clone(&self) -> HashAlgorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HashAlgorithm

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HashAlgorithm

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for HashAlgorithm

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

Formats the value using the given formatter.

impl FromConfigKey<HashAlgorithm> for HashAlgorithm

fn from_conf(conf: &XvcConfig) -> HashAlgorithm

Create a value of type T from configuration. Supposed to panic! if there is no key, or the value cannot be parsed.

fn try_from_conf(conf: &XvcConfig) -> Result<HashAlgorithm>

Try to create a type T from the configuration. Returns error if there is no key, or the value cannot be parsed.

impl FromStr for HashAlgorithm

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl Ord for HashAlgorithm

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<HashAlgorithm> for HashAlgorithm

fn eq(&self, other: &HashAlgorithm) -> 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 PartialOrd<HashAlgorithm> for HashAlgorithm

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for HashAlgorithm

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for HashAlgorithm

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<HashAlgorithm, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl VariantNames for HashAlgorithm

const VARIANTS: &'static [&'static str] = _

Names of the variants of this enum

impl Copy for HashAlgorithm

impl Eq for HashAlgorithm

impl StructuralEq for HashAlgorithm

impl StructuralPartialEq for HashAlgorithm