Struct den::Signature

pub struct Signature { /* private fields */ }

A identifier of a file, much smaller than the file itself.

See crate-level documentation for more details.

Implementations

impl Signature

pub fn parallel_diff(&self, data: &[u8], wp: &WorkerPool) -> Difference

Calculate the Self::diff in parallel using multiple OS threads.

pub fn parallel_diff_with_options( &self, data: &[u8], wp: &WorkerPool, data_size_threshold: usize, parallel_block_size: usize ) -> Difference

Calculate the Self::diff in parallel using multiple OS threads.

data_size_threshold is the threshold for how long data has to be before using the parallel implementation. If data is shorter than data_size_threshold, Self::diff is used instead.

parallel_block_size is the size of the blocks data is split into before being sent to other threads.

Panics

Panics if parallel_block_size == 0.

impl Signature

pub fn new(block_size: usize) -> SignatureBuilder

Creates a new SignatureBuilder in which data can be added to create a list of hashes for blocks the size of block_size.

I recommend block size 4096 for remote transfers. If small documents are what’s mostly being transmitted, consider 512. Consider running Difference::minify if getting the smallest diff is your concern.

This creates a signature of a resource. The signature takes up much less space than the resource.

Larger block_sizes will take more less to compute but signatures become larger, as if a block’s contents isn’t found, it has to send block_size bytes of data. Smaller block_sizes takes more time to compute, but send data in the Signature. Diffs with smaller block_sizes also have the advantage of interfering less with changes if applied to data other than what’s written to the signature.

The HashAlgorithm is chosen using experience with hasher’s performance and heuristics. You can query the algorithm using Self::algorithm.

Panics

Panics if block_size is 0.

pub fn with_algorithm( algorithm: HashAlgorithm, block_size: usize ) -> SignatureBuilder

This will create a new SignatureBuilder with the algorithm. Consider using Self::new if you don’t know exactly what you are doing, as it sets the algorithm for you. You can query the algorithm using Self::algorithm.

See Self::new for more details and insights into how to choose block_size.

Panics

Will panic if HashAlgorithm is of type None* and block_size is larger than the HashAlgorithm. Also panics if block_size is 0.

pub const fn algorithm(&self) -> HashAlgorithm

Get the algorithm used by this signature.

pub const fn block_size(&self) -> usize

Returns the block size of this signature.

pub fn diff(&self, data: &[u8]) -> Difference

Get the Difference between the data the Signature represents and the local data.

This will return a struct which when serialized (using e.g. bincode) is much smaller than data.

Trait Implementations

impl Clone for Signature

fn clone(&self) -> Signature

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Signature

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Signature

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Signature> for Signature

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

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 Signature

impl StructuralEq for Signature

impl StructuralPartialEq for Signature