Enum ExpectedHash 

#[non_exhaustive]
pub enum ExpectedHash {
    Whole {
        algorithm: HashAlgorithm,
        hash: Vec<u8>,
    },
    Blocks {
        algorithm: HashAlgorithm,
        block_size: u64,
        hashes: Vec<Vec<u8>>,
    },
}

Expected hash spec for a single file.

Either a single whole-file digest, or a fixed-block-size digest per block. Block-mode is what FFXIV patch lists actually carry for .dat files (50 MiB blocks), because it pinpoints which block is bad. Whole-file mode is the natural fit for small files (e.g. .index files), where a single mismatched bit is best surfaced as a single failure.

Stability

#[non_exhaustive] — future hash-spec shapes may be added without a SemVer break.

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.

Whole

Whole-file hash mode: a single algorithm digest over the full file.

Fields

algorithm: HashAlgorithm

Hash algorithm used.

hash: Vec<u8>

Expected digest bytes. Length must equal algorithm.digest_len().

Blocks

Block-mode hash: file is split into block_size-byte chunks, each hashed independently. The last block may be shorter than block_size.

Fields

algorithm: HashAlgorithm

Hash algorithm used.

block_size: u64

Block size in bytes. Must be non-zero.

hashes: Vec<Vec<u8>>

One digest per block, in file order. Each digest’s length must equal algorithm.digest_len().

Implementations

impl ExpectedHash

pub fn whole_sha1(hash: Vec<u8>) -> Self

Construct a whole-file SHA1 spec from a 20-byte digest.

pub fn blocks_sha1(block_size: u64, hashes: Vec<Vec<u8>>) -> Self

Construct a block-mode SHA1 spec.

pub fn algorithm(&self) -> HashAlgorithm

Hash algorithm in use.

Trait Implementations

impl Clone for ExpectedHash

fn clone(&self) -> ExpectedHash

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExpectedHash

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

Formats the value using the given formatter.

impl PartialEq for ExpectedHash

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

impl StructuralPartialEq for ExpectedHash