Struct adler::Adler32[][src]

pub struct Adler32 { /* fields omitted */ }

Adler-32 checksum calculator.

An instance of this type is equivalent to an Adler-32 checksum: It can be created in the default state via new (or the provided Default impl), or from a precalculated checksum via from_checksum, and the currently stored checksum can be fetched via checksum.

This type also implements Hasher, which makes it easy to calculate Adler-32 checksums of any type that implements or derives Hash. This also allows using Adler-32 in a HashMap, although that is not recommended (while every checksum is a hash, they are not necessarily good at being one).

Implementations

impl Adler32[src]

pub fn new() -> Self[src]

Creates a new Adler-32 instance with default state.

pub fn from_checksum(sum: u32) -> Self[src]

Creates an Adler32 instance from a precomputed Adler-32 checksum.

This allows resuming checksum calculation without having to keep the Adler32 instance around.

Example

let parts = [
    "rust",
    "acean",
];
let whole = adler::adler32_slice(b"rustacean");

let mut sum = Adler32::new();
sum.write_slice(parts[0].as_bytes());
let partial = sum.checksum();

// ...later

let mut sum = Adler32::from_checksum(partial);
sum.write_slice(parts[1].as_bytes());
assert_eq!(sum.checksum(), whole);

pub fn checksum(&self) -> u32[src]

Returns the calculated checksum at this point in time.

pub fn write_slice(&mut self, bytes: &[u8])[src]

Adds bytes to the checksum calculation.

If efficiency matters, this should be called with Byte slices that contain at least a few thousand Bytes.

Trait Implementations

impl Clone for Adler32[src]

impl Copy for Adler32[src]

impl Debug for Adler32[src]

impl Default for Adler32[src]

impl Hasher for Adler32[src]

Auto Trait Implementations

impl Send for Adler32

impl Sync for Adler32

impl Unpin for Adler32

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.