Enum Checksum 

pub enum Checksum {
    Blake3(Hash),
    Sha256([u8; 32]),
}

A checksum value computed with a recognised algorithm (BLAKE3 or SHA-256).

let data = Cursor::new(b"BepInExPack_Valheim-5.4.2202.zip contents");
let ck = Checksum::compute(data, ChecksumAlgorithm::Blake3).unwrap();
assert_eq!(ck.algorithm().to_string(), "blake3");

let as_str = ck.to_string();
let parsed: Checksum = as_str.parse().unwrap();
assert_eq!(ck, parsed);

let ck = Checksum::from_value_str(
    "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
    ChecksumAlgorithm::Sha256,
).unwrap();
assert_eq!(ck.algorithm().to_string(), "sha256");

Variants

Blake3(Hash)

Sha256([u8; 32])

Implementations

impl Checksum

pub fn blake3(hash: Hash) -> Self

Create a Checksum::Blake3 from an already-computed blake3::Hash.

pub fn sha256(hash: [u8; 32]) -> Self

Create a Checksum::Sha256 from a raw 32-byte array.

pub fn compute<R>(reader: R, algorithm: ChecksumAlgorithm) -> Result<Self>

where R: Read,

Compute a checksum by reading a byte stream with the chosen algorithm.

let data = Cursor::new(b"some mod archive data");
let ck = Checksum::compute(data, ChecksumAlgorithm::Sha256).unwrap();
assert_eq!(ck.algorithm().to_string(), "sha256");

pub fn compute_from_path( path: impl AsRef<Path>, algorithm: ChecksumAlgorithm, ) -> Result<Self>

pub fn algorithm(&self) -> ChecksumAlgorithm

Return which algorithm this checksum was produced with.

pub fn without_algorithm(&self) -> WithoutAlgorithm<'_>

Return a wrapper that displays only the hex portion (no algorithm prefix).

pub fn from_value_str(value: &str, algorithm: ChecksumAlgorithm) -> Result<Self>

Parse a checksum from a raw hex string with an explicit algorithm.

Useful when the algorithm and value are stored separately, or when you have already split "<algo>:<hex>" yourself.

let ck = Checksum::from_value_str(
    "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
    ChecksumAlgorithm::Sha256,
).unwrap();
assert_eq!(ck.algorithm().to_string(), "sha256");

Trait Implementations

impl Clone for Checksum

fn clone(&self) -> Checksum

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Checksum

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Checksum

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Checksum

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

Formats the value using the given formatter.

impl Eq for Checksum

impl From<Checksum> for String

fn from(checksum: Checksum) -> Self

Converts to this type from the input type.

impl From<Hash> for Checksum

fn from(hash: Hash) -> Self

Converts to this type from the input type.

impl FromStr for Checksum

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

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

impl PartialEq for Checksum

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Checksum

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Checksum

impl TryFrom<String> for Checksum

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self>

Performs the conversion.