Struct Engine

pub struct Engine<Ck>
where
    Ck: Checksum,
{ /* private fields */ }

A checksum engine, which can be used to compute or verify a checksum.

Use this to verify a checksum, feed it the data to be checksummed using the Self::input_* methods.

Implementations

impl<Ck> Engine<Ck>

where Ck: Checksum,

pub fn new() -> Engine<Ck>

Constructs a new checksum engine with no data input.

pub fn input_hrp(&mut self, hrp: Hrp)

Feeds hrp into the checksum engine.

pub fn input_fe(&mut self, e: Fe32)

Adds a single gf32 element to the checksum engine.

This is where the actual checksum computation magic happens.

pub fn input_target_residue(&mut self)

Inputs the target residue of the checksum.

Checksums are generated by appending the target residue to the input string, then computing the actual residue, and then replacing the target with the actual. This method lets us compute the actual residue without doing any string concatenations.

pub fn residue(&self) -> &<Ck as Checksum>::MidstateRepr

Returns for the current checksum residue.

Trait Implementations

impl<Ck> Clone for Engine<Ck>

where Ck: Clone + Checksum, <Ck as Checksum>::MidstateRepr: Clone,

fn clone(&self) -> Engine<Ck>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Ck> Debug for Engine<Ck>

where Ck: Debug + Checksum, <Ck as Checksum>::MidstateRepr: Debug,

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

Formats the value using the given formatter.

impl<Ck> Default for Engine<Ck>

where Ck: Checksum,

fn default() -> Engine<Ck>

Returns the “default value” for a type.

impl<Ck> PartialEq for Engine<Ck>

where Ck: PartialEq + Checksum, <Ck as Checksum>::MidstateRepr: PartialEq,

fn eq(&self, other: &Engine<Ck>) -> 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<Ck> Copy for Engine<Ck>

where Ck: Copy + Checksum, <Ck as Checksum>::MidstateRepr: Copy,

impl<Ck> Eq for Engine<Ck>

where Ck: Eq + Checksum, <Ck as Checksum>::MidstateRepr: Eq,

impl<Ck> StructuralPartialEq for Engine<Ck>

where Ck: Checksum,