Struct SCell

pub struct SCell<T> { /* private fields */ }

The structure which ensures the calculation safety

Implementations

impl<T> SCell<T>

pub fn new(data: T) -> Self

Create a new SCell

Examples found in repository

examples/main.rs (line 19)

fn main() -> Result<(), String> {
    let a = SCell::<i32>::new(12) * SCell::<i32>::new(3);
    assert_eq!(*a.ok_or("overflow")?.get_data(), 36);

    // Addition will result in `None` in the presence of overflow behavior(s)
    let a = SCell::<i32>::new(std::i32::MAX) + SCell::<i32>::new(1);
    assert!(a.is_none());
    Ok(())
}

pub fn get_data(&self) -> &T

Get the data of underlying type T

Examples found in repository

examples/main.rs (line 20)

fn main() -> Result<(), String> {
    let a = SCell::<i32>::new(12) * SCell::<i32>::new(3);
    assert_eq!(*a.ok_or("overflow")?.get_data(), 36);

    // Addition will result in `None` in the presence of overflow behavior(s)
    let a = SCell::<i32>::new(std::i32::MAX) + SCell::<i32>::new(1);
    assert!(a.is_none());
    Ok(())
}

impl<T: Zero> SCell<T>

pub fn zero() -> Self

See num crate for more information

pub fn is_zero(&self) -> bool

See num crate for more information

impl<T: One + PartialEq> SCell<T>

pub fn one() -> Self

See num crate for more information

pub fn is_one(&self) -> bool

See num crate for more information

impl<T: Num + CheckedAdd + CheckedSub + CheckedMul + CheckedDiv + CheckedRem> SCell<T>

pub fn from_str_radix(str: &str, radix: u32) -> Result<Self, T::FromStrRadixErr>

See num crate for more information

impl<T: Signed + CheckedAdd + CheckedSub + CheckedMul + CheckedDiv + CheckedRem + CheckedNeg + Ord + Copy> SCell<T>

pub fn abs(&self) -> Option<Self>

See num crate for more information

pub fn abs_sub(&self, other: &Self) -> Option<Self>

See num crate for more information

pub fn signum(&self) -> Self

See num crate for more information

pub fn is_positive(&self) -> bool

See num crate for more information

pub fn is_negative(&self) -> bool

See num crate for more information

Trait Implementations

impl<T: CheckedAdd> Add for SCell<T>

type Output = Option<SCell<T>>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<T: Clone> Clone for SCell<T>

fn clone(&self) -> SCell<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SCell<T>

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

Formats the value using the given formatter.

impl<T: CheckedDiv> Div for SCell<T>

type Output = Option<SCell<T>>

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl<T: FromStr> FromStr for SCell<T>

type Err = <T as FromStr>::Err

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl<T: CheckedMul> Mul for SCell<T>

type Output = Option<SCell<T>>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl<T: CheckedNeg> Neg for SCell<T>

type Output = Option<SCell<T>>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: Not> Not for SCell<T>

type Output = SCell<<T as Not>::Output>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T: PartialEq> PartialEq for SCell<T>

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

fn partial_cmp(&self, other: &SCell<T>) -> 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<T: CheckedRem> Rem for SCell<T>

type Output = Option<SCell<T>>

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl<T: CheckedSub> Sub for SCell<T>

type Output = Option<SCell<T>>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<T: Copy> Copy for SCell<T>

impl<T> StructuralPartialEq for SCell<T>