Struct EquiXBuilder

pub struct EquiXBuilder {
    pub(crate) hash: HashXBuilder,
}

Builder for creating [EquiX] instances with custom settings

Fields

hash: HashXBuilder

Implementations

impl EquiXBuilder

pub fn new() -> EquiXBuilder

Create a new EquiXBuilder with default settings.

Immediately calling Self::build() would be equivalent to using [EquiX::new()].

pub fn runtime(&mut self, runtime: RuntimeOption) -> &mut EquiXBuilder

Select a new RuntimeOption.

pub fn build(&self, challenge: &[u8]) -> Result<EquiX, Error>

Build an [EquiX] instance with a challenge string and the selected options.

It’s normal for this to fail with a HashError::ProgramConstraints for a small fraction of challenge values. Those challenges must be skipped by solvers and rejected by verifiers.

pub fn solve(&self, challenge: &[u8]) -> Result<ArrayVec<Solution, 8>, Error>

Search for solutions to a particular challenge.

Each solve invocation returns zero or more solutions. Memory for the solver is allocated dynamically and not reused.

It’s normal for this to fail with a HashError::ProgramConstraints for a small fraction of challenge values. Those challenges must be skipped by solvers and rejected by verifiers.

pub fn verify(&self, challenge: &[u8], solution: &Solution) -> Result<(), Error>

Check a Solution against a particular challenge string.

Having a Solution instance guarantees that the order of items has already been checked. This only needs to check hash tree sums. Returns either Ok or [Error::HashSum].

pub fn verify_array( &self, challenge: &[u8], array: &[u16; 8], ) -> Result<(), Error>

Check a [SolutionItemArray].

Returns an error if the array is not a well formed Solution or it’s not suitable for the given challenge.

pub fn verify_bytes( &self, challenge: &[u8], array: &[u8; 16], ) -> Result<(), Error>

Check a [SolutionByteArray].

Returns an error if the array is not a well formed Solution or it’s not suitable for the given challenge.

Trait Implementations

impl Clone for EquiXBuilder

fn clone(&self) -> EquiXBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EquiXBuilder

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

Formats the value using the given formatter.

impl Default for EquiXBuilder

fn default() -> EquiXBuilder

Returns the “default value” for a type.

impl PartialEq for EquiXBuilder

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

impl StructuralPartialEq for EquiXBuilder