Struct Solver

pub struct Solver { /* private fields */ }

Make progress toward finding a Solution.

Each Solver instance will own about 1.8 MB of temporary memory until it is dropped. This interface supports cancelling an ongoing solve and it supports multithreaded use, but it requires an external thread pool implementation.

Implementations

impl Solver

pub fn run(&mut self) -> Result<Solution, RuntimeErrorV1>

Run the solver until it produces a Solution.

This takes a random amount of time to finish, with no possibility to cancel early. If you need cancellation, use Self::run_step() instead.

pub fn run_step(&mut self) -> Result<Option<Solution>, RuntimeErrorV1>

Run the solver algorithm, returning when we are at a good stopping point.

Typical durations would be very roughly 10ms with the compiled hash implementation or 250ms with the interpreted implementation.

These durations are far too long to include in any event loop that’s not built specifically for blocking operations, but they’re short enough that we still have a chance of cancelling a high-effort solve. Step duration does not depend on effort choice.

Internally, this checks only one Nonce value. That’s the only good stopping point we have in Equi-X right now. If we really need finer grained cancellation the equix crate could be modified to support this but at a performance penalty.

It’s possible to call this again after a solution has already been returned, but the resulting solutions will have nearby Nonce values so this is not recommended except for benchmarking.