pub struct SoftDerivation(Derivation);
Expand description

wrapper to guarantee the given derivation is a soft derivation

Tuple Fields§

§0: Derivation

Implementations§

source§

impl SoftDerivation

source

pub const fn new_unchecked(derivation: Derivation) -> Self

construct a soft derivation from the given derivation without checking the derivation is actually a soft derivation.

this function does not perform any verification and if the value is not correct it will create a cascade of issues, be careful when utilizing this function.

source

pub fn new(derivation: Derivation) -> Result<Self, DerivationError>

build a soft derivation from the given Derivation. If the value is not a soft derivation it will return an error

Example
let derivation = Derivation::new(42);
let derivation = SoftDerivation::new(derivation)?;

println!("derivation: {}", derivation);
source

pub const fn max_value() -> Self

returns the max derivation index value

let max = SoftDerivation::max_value();
assert_eq!(max, SoftDerivation::new_unchecked(Derivation::new(0x7FFF_FFFF)));
source

pub const fn min_value() -> Self

returns the min derivation index value

let min = SoftDerivation::min_value();
assert_eq!(min, SoftDerivation::new_unchecked(Derivation::new(0)));
source

pub fn overflowing_add(self, rhs: u32) -> (Self, bool)

calculate self + rhs

Returns the tuple of the addition along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage:

assert_eq!(
    SoftDerivation::new_unchecked(Derivation::new(5)).overflowing_add(2),
    (SoftDerivation::new_unchecked(Derivation::new(7)), false)
);
assert_eq!(
    SoftDerivation::max_value().overflowing_add(1),
    (SoftDerivation::new_unchecked(Derivation::new(0)), true)
);
source

pub fn saturating_add(self, rhs: u32) -> Self

saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(
    SoftDerivation::new_unchecked(Derivation::new(100)).saturating_add(1),
    SoftDerivation::new_unchecked(Derivation::new(101))
);
assert_eq!(
    SoftDerivation::max_value().saturating_add(2048),
    SoftDerivation::max_value(),
);
source

pub fn checked_add(self, rhs: u32) -> Option<Self>

checked integer addition. Computes self + rhs, returning None if overflow would occurred.

Examples

Basic usage:

assert_eq!(
    SoftDerivation::new_unchecked(Derivation::new(100)).checked_add(1),
    Some(SoftDerivation::new_unchecked(Derivation::new(101)))
);
assert_eq!(
    SoftDerivation::max_value().checked_add(2048),
    None,
);
source

pub fn wrapping_add(self, rhs: u32) -> Self

Wrapping (modular) addition. Computes self + rhs, wrapping around the boundary of the type.

Examples

Basic usage:

assert_eq!(
    SoftDerivation::new_unchecked(Derivation::new(100)).wrapping_add(1),
    SoftDerivation::new_unchecked(Derivation::new(101))
);
assert_eq!(
    SoftDerivation::max_value().wrapping_add(1),
    SoftDerivation::new_unchecked(Derivation::new(0)),
);
source

fn saturating_sub(self, rhs: u32) -> Self

Methods from Deref<Target = u32>§

1.43.0 · source

pub const MIN: u32 = 0u32

1.43.0 · source

pub const MAX: u32 = 4_294_967_295u32

1.53.0 · source

pub const BITS: u32 = 32u32

Trait Implementations§

source§

impl Clone for SoftDerivation

source§

fn clone(&self) -> SoftDerivation

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for SoftDerivation

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for SoftDerivation

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Deref for SoftDerivation

§

type Target = u32

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl Display for SoftDerivation

source§

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

Formats the value using the given formatter. Read more
source§

impl From<SoftDerivation> for Derivation

source§

fn from(d: SoftDerivation) -> Self

Converts to this type from the input type.
source§

impl FromStr for SoftDerivation

§

type Err = ParseDerivationError

The associated error which can be returned from parsing.
source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
source§

impl Hash for SoftDerivation

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for SoftDerivation

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more
source§

impl PartialEq<SoftDerivation> for SoftDerivation

source§

fn eq(&self, other: &SoftDerivation) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd<SoftDerivation> for SoftDerivation

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl TryFrom<Derivation> for SoftDerivation

§

type Error = DerivationError

The type returned in the event of a conversion error.
source§

fn try_from(value: Derivation) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl TryFrom<u32> for SoftDerivation

§

type Error = DerivationError

The type returned in the event of a conversion error.
source§

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl Copy for SoftDerivation

source§

impl Eq for SoftDerivation

source§

impl StructuralEq for SoftDerivation

source§

impl StructuralPartialEq for SoftDerivation

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.