Struct Effort

pub struct Effort(/* private fields */);

Effort setting, a u32 value with linear scale

The numerical value is roughly the expected number of times we will need to invoke the underlying solver (Equi-X) for the v1 proof-of-work protocol to find a solution.

Implementations

impl Effort

pub const fn new(value: u32) -> Self

Const constructor for Effort from any u32

Effort can also be constructed using into() conversions, but those are not available in const expressions.

pub const fn zero() -> Self

Const constructor for zero effort

Zero effort is used in suggested effort to mean the puzzle is available but shouldn’t be used on a first connection attempt.

If zero is actually used for solve and verify, it will have equivalent performance to an effort of 1.

pub const fn saturating_mul_u32(&self, rhs: u32) -> Self

Multiply this effort by an integer of the same size, saturating on overflow

pub fn saturating_mul_f32(&self, rhs: f32) -> Self

Multiply this effort by a float, with saturating cast back to Effort

Trait Implementations

impl AsRef<u32> for Effort

fn as_ref(&self) -> &u32

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Effort

fn clone(&self) -> Effort

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Effort

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

Formats the value using the given formatter.

impl Default for Effort

fn default() -> Effort

Returns the “default value” for a type.

impl From<Effort> for u32

fn from(value: Effort) -> Self

Converts to this type from the input type.

impl From<u32> for Effort

fn from(value: u32) -> Self

Converts to this type from the input type.

impl Ord for Effort

fn cmp(&self, other: &Effort) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Effort

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

fn partial_cmp(&self, other: &Effort) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Readable for Effort

fn take_from(b: &mut Reader<'_>) -> Result<Self>

Try to extract an object of this type from a Reader.

impl Writeable for Effort

fn write_onto<B: Writer + ?Sized>(&self, b: &mut B) -> EncodeResult<()>

Encode this object into the writer b.

impl Copy for Effort

impl Eq for Effort

impl StructuralPartialEq for Effort