Struct CheckingParameters

pub struct CheckingParameters { /* private fields */ }

CheckingParameters carry enough information to confirm whether a Voucher was generated from a given u64 value using the unknown VouchingParameters associated with the CheckingParameters.

CheckingParameters should be obtained either by calling VouchingParameters::checking_parameters for transient in-memory parameters, by parsing a string representation with CheckingParameters::parse or CheckingParameters::parse_bytes, or, when initialising const variables with hardcoded strings, with CheckingParameters::parse_or_die.

After that, the result of VouchingParameters::vouch can be checked with CheckingParameters::check, and that of VouchingParameters::vouch_many with CheckingParameters::check_many.

Implementations

impl CheckingParameters

pub const REPRESENTATION_BYTE_COUNT: usize = 39usize

Number of ASCII characters in the string representation for one CheckingParameters instance.

pub const fn parse(string: &str) -> Result<CheckingParameters, &'static str>

Attempts to parse the string representation of a CheckingParameters instance.

This representation can be generated by the std::fmt::Display trait, e.g., with format!("{}", checking_params) => "CHECK-9bf723a6b538fe4a-1dddb95caa81d852".

pub const fn parse_or_die(string: &str) -> CheckingParameters

Parses the string representation of a CheckingParameters object or panics.

This function is mostly useful to initialise const literals.

pub const fn check(self, expected: u64, voucher: Voucher) -> bool

Returns whether the expected value matches the voucher, assuming the voucher was generated with the VouchingParameters from which the self CheckingParameters came.

If the voucher was generated from different parameters (generated independently and uniformly at random), the probability of a match is less than 2**-60.

pub fn check_many(self, expected: &[u64], vouchers: &[Voucher]) -> bool

Returns whether the expected values match all the vouchers, assuming the vouchers were generated with the VouchingParameters from which the self CheckingParameters came.

If the vouchers were generated from different parameters (generated independently and uniformly at random), the probability of a match is less than 2**-60.

pub const fn parse_bytes( bytes: &[u8], ) -> Result<CheckingParameters, &'static str>

Attempts to parse bytes, which must be the utf-8 (it’s all ASCII) representation of a serialised CheckingParameters, with a length of exactly REPRESENTATION_BYTE_COUNT bytes.

Returns the CheckingParameters on success, and an error reason on failure.

Trait Implementations

impl Clone for CheckingParameters

fn clone(&self) -> CheckingParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CheckingParameters

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

Formats the value using the given formatter.

impl Display for CheckingParameters

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

Formats the value using the given formatter.

impl Hash for CheckingParameters

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CheckingParameters

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

impl Eq for CheckingParameters

impl StructuralPartialEq for CheckingParameters