Struct fletcher_simd::Fletcher

source · [−]

pub struct Fletcher<T: FletcherChecksum> { /* private fields */ }

Expand description

A Fletcher checksum object that allows for continuous updates to the checksum.

Examples

use fletcher_simd::Fletcher;

const DATA: &str = "abcdefgh";
let mut fletcher = Fletcher::<u16>::new();
fletcher.update_with_slice(DATA.as_bytes());

assert_eq!(fletcher.value(), 0xF824);

The update_with_iter method is also available for use with the Iterator interface.

use byteorder::{ByteOrder, LittleEndian};
use fletcher_simd::Fletcher128;

const DATA: &str = "abcdefgh";
let mut fletcher = Fletcher128::new();

fletcher.update_with_iter(
    DATA.as_bytes()
        .chunks(8)
        .map(|chunk| LittleEndian::read_u64(chunk)),
);

assert_eq!(fletcher.value(), 0x68676665646362616867666564636261);

Implementations

source

impl Fletcher<u16>

source

pub fn new() -> Self

Constructs a new Fletcher<T> with the default values.

source

pub fn with_initial_values(a: u8, b: u8) -> Self

Constructs a new Fletcher<T> with specific values.

a will represent the lesser significant bits. b will represent the more significant bits.

source

pub fn update_with_slice(&mut self, data: &[u8 ])

Updates the checksum with a slice of data of type T::BlockType.

source

pub fn update_with_iter<Iter>(&mut self, elems: Iter) where
Iter: Iterator<Item = u8>,

Updates the checksum with an iterator over elements of type T::BlockType.

source

pub fn update_with_iter_scalar<Iter>(&mut self, elems: Iter) where
Iter: Iterator<Item = u8>,

Updates the checksum with an iterator over elements of type T::BlockType using a scalar-only implementation.

source

pub fn value(&self) -> u16

Returns the checksum value.

source

impl Fletcher<u32>

source

pub fn new() -> Self

Constructs a new Fletcher<T> with the default values.

source

pub fn with_initial_values(a: u16, b: u16) -> Self

Constructs a new Fletcher<T> with specific values.

a will represent the lesser significant bits. b will represent the more significant bits.

source

pub fn update_with_slice(&mut self, data: &[u16 ])

Updates the checksum with a slice of data of type T::BlockType.

source

pub fn update_with_iter<Iter>(&mut self, elems: Iter) where
Iter: Iterator<Item = u16>,

Updates the checksum with an iterator over elements of type T::BlockType.

source

pub fn update_with_iter_scalar<Iter>(&mut self, elems: Iter) where
Iter: Iterator<Item = u16>,

Updates the checksum with an iterator over elements of type T::BlockType using a scalar-only implementation.

source

pub fn value(&self) -> u32

Returns the checksum value.

source

impl Fletcher<u64>

source

pub fn new() -> Self

Constructs a new Fletcher<T> with the default values.

source

pub fn with_initial_values(a: u32, b: u32) -> Self

Constructs a new Fletcher<T> with specific values.

a will represent the lesser significant bits. b will represent the more significant bits.

source

pub fn update_with_slice(&mut self, data: &[u32 ])

Updates the checksum with a slice of data of type T::BlockType.

source

pub fn update_with_iter<Iter>(&mut self, elems: Iter) where
Iter: Iterator<Item = u32>,

Updates the checksum with an iterator over elements of type T::BlockType.

source

pub fn update_with_iter_scalar<Iter>(&mut self, elems: Iter) where
Iter: Iterator<Item = u32>,

Updates the checksum with an iterator over elements of type T::BlockType using a scalar-only implementation.

source

pub fn value(&self) -> u64

Returns the checksum value.

source

impl Fletcher<u128>

source

pub fn new() -> Self

Constructs a new Fletcher<T> with the default values.

source

pub fn with_initial_values(a: u64, b: u64) -> Self

Constructs a new Fletcher<T> with specific values.

a will represent the lesser significant bits. b will represent the more significant bits.

source

pub fn update_with_slice(&mut self, data: &[u64 ])

Updates the checksum with a slice of data of type T::BlockType.

source

pub fn update_with_iter<Iter>(&mut self, elems: Iter) where
Iter: Iterator<Item = u64>,

Updates the checksum with an iterator over elements of type T::BlockType.

source

pub fn update_with_iter_scalar<Iter>(&mut self, elems: Iter) where
Iter: Iterator<Item = u64>,

Updates the checksum with an iterator over elements of type T::BlockType using a scalar-only implementation.

source

pub fn value(&self) -> u128

Returns the checksum value.

Trait Implementations

source

impl<T: Clone + FletcherChecksum> Clone for Fletcher<T> where
T::BlockType: Clone,
T::BlockType: Clone,

source

fn clone(&self) -> Fletcher<T>

Returns a copy of the value. Read more

This method tests for !=.

source

impl<T: Copy + FletcherChecksum> Copy for Fletcher<T> where
T::BlockType: Copy,
T::BlockType: Copy,

source

impl<T: FletcherChecksum> StructuralPartialEq for Fletcher<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for Fletcher<T> where
<T as FletcherChecksum>::BlockType: RefUnwindSafe,

impl<T> Send for Fletcher<T> where
<T as FletcherChecksum>::BlockType: Send,

impl<T> Sync for Fletcher<T> where
<T as FletcherChecksum>::BlockType: Sync,

impl<T> Unpin for Fletcher<T> where
<T as FletcherChecksum>::BlockType: Unpin,

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct fletcher_simd::Fletcher

Examples

Implementations

impl Fletcher<u16>

pub fn new() -> Self

pub fn with_initial_values(a: u8, b: u8) -> Self

pub fn update_with_slice(&mut self, data: &[u8])

pub fn update_with_iter<Iter>(&mut self, elems: Iter) where Iter: Iterator<Item = u8>,

pub fn update_with_iter_scalar<Iter>(&mut self, elems: Iter) where Iter: Iterator<Item = u8>,

pub fn value(&self) -> u16

impl Fletcher<u32>

pub fn new() -> Self

pub fn with_initial_values(a: u16, b: u16) -> Self

pub fn update_with_slice(&mut self, data: &[u16])

pub fn update_with_iter<Iter>(&mut self, elems: Iter) where Iter: Iterator<Item = u16>,

pub fn update_with_iter_scalar<Iter>(&mut self, elems: Iter) where Iter: Iterator<Item = u16>,

pub fn value(&self) -> u32

impl Fletcher<u64>

pub fn new() -> Self

pub fn with_initial_values(a: u32, b: u32) -> Self

pub fn update_with_slice(&mut self, data: &[u32])

pub fn update_with_iter<Iter>(&mut self, elems: Iter) where Iter: Iterator<Item = u32>,

pub fn update_with_iter_scalar<Iter>(&mut self, elems: Iter) where Iter: Iterator<Item = u32>,

pub fn value(&self) -> u64

impl Fletcher<u128>

pub fn new() -> Self

pub fn with_initial_values(a: u64, b: u64) -> Self

pub fn update_with_slice(&mut self, data: &[u64])

pub fn update_with_iter<Iter>(&mut self, elems: Iter) where Iter: Iterator<Item = u64>,

pub fn update_with_iter_scalar<Iter>(&mut self, elems: Iter) where Iter: Iterator<Item = u64>,

pub fn value(&self) -> u128

Trait Implementations

impl<T: Clone + FletcherChecksum> Clone for Fletcher<T> where T::BlockType: Clone, T::BlockType: Clone,

fn clone(&self) -> Fletcher<T>

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

impl<T: Debug + FletcherChecksum> Debug for Fletcher<T> where T::BlockType: Debug, T::BlockType: Debug,

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

impl<T: Default + FletcherChecksum> Default for Fletcher<T> where T::BlockType: Default, T::BlockType: Default,

fn default() -> Fletcher<T>

impl From<Fletcher<u128>> for u128

fn from(f: Fletcher<u128>) -> Self

impl From<Fletcher<u16>> for u16

fn from(f: Fletcher<u16>) -> Self

impl From<Fletcher<u32>> for u32

fn from(f: Fletcher<u32>) -> Self

impl From<Fletcher<u64>> for u64

fn from(f: Fletcher<u64>) -> Self

impl<T: PartialEq + FletcherChecksum> PartialEq<Fletcher<T>> for Fletcher<T> where T::BlockType: PartialEq, T::BlockType: PartialEq,

fn eq(&self, other: &Fletcher<T>) -> bool

fn ne(&self, other: &Fletcher<T>) -> bool

impl<T: Copy + FletcherChecksum> Copy for Fletcher<T> where T::BlockType: Copy, T::BlockType: Copy,

impl<T: FletcherChecksum> StructuralPartialEq for Fletcher<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for Fletcher<T> where <T as FletcherChecksum>::BlockType: RefUnwindSafe,

impl<T> Send for Fletcher<T> where <T as FletcherChecksum>::BlockType: Send,

impl<T> Sync for Fletcher<T> where <T as FletcherChecksum>::BlockType: Sync,

impl<T> Unpin for Fletcher<T> where <T as FletcherChecksum>::BlockType: Unpin,

impl<T> UnwindSafe for Fletcher<T> where <T as FletcherChecksum>::BlockType: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn update_with_slice(&mut self, data: &[u8 ])

pub fn update_with_iter<Iter>(&mut self, elems: Iter) where
Iter: Iterator<Item = u8>,

pub fn update_with_iter_scalar<Iter>(&mut self, elems: Iter) where
Iter: Iterator<Item = u8>,

pub fn update_with_slice(&mut self, data: &[u16 ])

pub fn update_with_iter<Iter>(&mut self, elems: Iter) where
Iter: Iterator<Item = u16>,

pub fn update_with_iter_scalar<Iter>(&mut self, elems: Iter) where
Iter: Iterator<Item = u16>,

pub fn update_with_slice(&mut self, data: &[u32 ])

pub fn update_with_iter<Iter>(&mut self, elems: Iter) where
Iter: Iterator<Item = u32>,

pub fn update_with_iter_scalar<Iter>(&mut self, elems: Iter) where
Iter: Iterator<Item = u32>,

pub fn update_with_slice(&mut self, data: &[u64 ])

pub fn update_with_iter<Iter>(&mut self, elems: Iter) where
Iter: Iterator<Item = u64>,

pub fn update_with_iter_scalar<Iter>(&mut self, elems: Iter) where
Iter: Iterator<Item = u64>,

impl<T: Clone + FletcherChecksum> Clone for Fletcher<T> where
T::BlockType: Clone,
T::BlockType: Clone,

impl<T: Debug + FletcherChecksum> Debug for Fletcher<T> where
T::BlockType: Debug,
T::BlockType: Debug,

impl<T: Default + FletcherChecksum> Default for Fletcher<T> where
T::BlockType: Default,
T::BlockType: Default,

impl<T: PartialEq + FletcherChecksum> PartialEq<Fletcher<T>> for Fletcher<T> where
T::BlockType: PartialEq,
T::BlockType: PartialEq,

impl<T: Copy + FletcherChecksum> Copy for Fletcher<T> where
T::BlockType: Copy,
T::BlockType: Copy,

impl<T> RefUnwindSafe for Fletcher<T> where
<T as FletcherChecksum>::BlockType: RefUnwindSafe,

impl<T> Send for Fletcher<T> where
<T as FletcherChecksum>::BlockType: Send,

impl<T> Sync for Fletcher<T> where
<T as FletcherChecksum>::BlockType: Sync,

impl<T> Unpin for Fletcher<T> where
<T as FletcherChecksum>::BlockType: Unpin,

impl<T> UnwindSafe for Fletcher<T> where
<T as FletcherChecksum>::BlockType: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,