Struct Time

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

A newtype for the concept of time. A Time value can represent either a point in time or the output of arithmetic involving time.

Wraps f64.

Examples

let t0 = tskit::Time::from(2.0);
let t1 = tskit::Time::from(10.0);

let mut sum = t0 + t1;

match sum.partial_cmp(&12.0) {
   Some(std::cmp::Ordering::Equal) => (),
   _ => assert!(false),
};

sum /= tskit::Time::from(2.0);

match sum.partial_cmp(&6.0) {
   Some(std::cmp::Ordering::Equal) => (),
   _ => assert!(false),
};

Notes

The current implementation of PartialOrd is based on the underlying implementation for f64.

A Time can be multiplied and divided by a Position

Trait Implementations

impl Add for Time

type Output = Time

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Time

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Time

fn clone(&self) -> Time

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Time

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

Formats the value using the given formatter.

impl Display for Time

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

Formats the value using the given formatter.

impl Div<Position> for Time

type Output = Time

The resulting type after applying the / operator.

fn div(self, other: Position) -> Self

Performs the / operation.

impl Div<Time> for Position

type Output = Position

The resulting type after applying the / operator.

fn div(self, other: Time) -> Self

Performs the / operation.

impl Div for Time

type Output = Time

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<Position> for Time

fn div_assign(&mut self, other: Position)

Performs the /= operation.

impl DivAssign<Time> for Position

fn div_assign(&mut self, other: Time)

Performs the /= operation.

impl DivAssign for Time

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<Time> for f64

fn from(value: Time) -> Self

Converts to this type from the input type.

impl From<f64> for Time

fn from(value: f64) -> Self

Converts to this type from the input type.

impl Mul<Position> for Time

type Output = Time

The resulting type after applying the * operator.

fn mul(self, other: Position) -> Self

Performs the * operation.

impl Mul<Time> for Position

type Output = Position

The resulting type after applying the * operator.

fn mul(self, other: Time) -> Self

Performs the * operation.

impl Mul for Time

type Output = Time

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<Position> for Time

fn mul_assign(&mut self, other: Position)

Performs the *= operation.

impl MulAssign<Time> for Position

fn mul_assign(&mut self, other: Time)

Performs the *= operation.

impl MulAssign for Time

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl PartialEq<Time> for f64

fn eq(&self, other: &Time) -> 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 PartialEq<f64> for Time

fn eq(&self, other: &f64) -> 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 PartialEq for Time

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

fn partial_cmp(&self, other: &Time) -> 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 PartialOrd<f64> for Time

fn partial_cmp(&self, other: &f64) -> 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 PartialOrd for Time

fn partial_cmp(&self, other: &Time) -> 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 Sub for Time

type Output = Time

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Time

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Time

impl StructuralPartialEq for Time