Struct FileIntegrity

pub struct FileIntegrity { /* private fields */ }

This struct contains the integrity details of a file, such as a hash of the file’s contents, and hashes of “blocks” of the file, which is split according to the block_size specified in it.

Implementations

impl FileIntegrity

pub const fn algorithm(&self) -> HashAlgorithm

The hashing algorithm used to calculate the hash.

Example

println!("This file is hashed using {}", integrity.algorithm());

pub fn hash(&self) -> &[u8]

The hash of the file.

Example

println!("File hash: {}", hex::encode(integrity.hash()));

pub const fn block_size(&self) -> usize

The size of each “block” to be hashed in a file.

Defaults to 4 MiB.

Example

println!(
	"This file has a block size of {} KiB",
	integrity.block_size() / 1024
);

pub fn blocks(&self) -> &[Vec<u8>]

The hash of each “block” in a file.

Example

let blocks = integrity.blocks();
println!("This file has {} blocks", blocks.len());
for (idx, block) in blocks.iter().enumerate() {
	println!("Block #{}: {}", idx + 1, hex::encode(block));
}

Trait Implementations

impl Clone for FileIntegrity

fn clone(&self) -> FileIntegrity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileIntegrity

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileIntegrity

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for FileIntegrity

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 PartialEq for FileIntegrity

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FileIntegrity

impl StructuralPartialEq for FileIntegrity