Struct ChecksumEngine 

pub struct ChecksumEngine { /* private fields */ }

An engine which consumes one GF32 character at a time, and produces a residue modulo some generator

Implementations

impl Engine

pub fn new_codex32_short() -> Engine

pub fn new_codex32_long() -> Engine

pub fn force_residue_to_zero(&mut self)

When computing checksums of “diffs” you do may want to set the highest-degree coefficient of the polynomial to 1.

If you do not know exactly why you are using this function, you should not use it.

pub fn into_residue(self) -> Vec<Fe>

Extracts the residue from a checksum engine

pub fn is_valid(&self) -> bool

Determines whether the residue matches the target value for the checksum

If you need the actual residue, e.g. for error correction, call the into_residue function (which will consume the engine).

pub fn input_hrp(&mut self, hrp: &str) -> Result<(), Error>

Initializes the checksum engine by loading an HRP into it

pub fn input_char(&mut self, c: char) -> Result<(), Error>

Adds a single character to the checksum engine

pub fn input_data_str(&mut self, s: &str) -> Result<(), Error>

Adds an entire string to the engine, counting each character as a data character (not an HRP).

pub fn input_own_target(&mut self)

Adds the target residue to the end of the input string

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

Adds a single field element to the checksum engine

This is where the real magic happens.

Trait Implementations

impl Clone for Engine

fn clone(&self) -> Engine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Engine

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

Formats the value using the given formatter.

impl PartialEq for Engine

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

impl StructuralPartialEq for Engine