Struct TickId 

pub struct TickId(pub u32);

A unique identifier for a specific tick in a deterministic simulation.

Tuple Fields

0: u32

Implementations

impl TickId

pub fn new(value: u32) -> Self

Creates a new TickId with the specified value.

Arguments

• value - The underlying u32 value for the TickId.

Examples

use tick_id::TickId;

let tick_id = TickId::new(1);
assert_eq!(tick_id.value(), 1);

pub fn value(&self) -> u32

Returns the underlying u32 value of the TickId.

Examples

use tick_id::TickId;

let tick_id = TickId::new(1);
assert_eq!(tick_id.value(), 1);

Trait Implementations

impl Add<u32> for TickId

fn add(self, other: u32) -> TickId

Adds a u32 value to the TickId.

Panics

This method will panic if the addition results in an overflow.

type Output = TickId

The resulting type after applying the + operator.

impl AddAssign<u32> for TickId

fn add_assign(&mut self, other: u32)

Adds a u32 value to the TickId in place.

impl Clone for TickId

fn clone(&self) -> TickId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TickId

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

Formats the value using the given formatter.

impl Default for TickId

fn default() -> TickId

Returns the “default value” for a type.

impl Display for TickId

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

Formats the value using the given formatter.

impl Ord for TickId

fn cmp(&self, other: &TickId) -> 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 TickId

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

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

fn sub(self, other: u32) -> TickId

Subtracts a u32 value from the TickId.

Panics

This method will panic if the subtraction results in an underflow.

type Output = TickId

The resulting type after applying the - operator.

impl Sub for TickId

fn sub(self, other: TickId) -> i64

Calculates the difference between two TickId values.

Examples

use tick_id::TickId;

let tick_id1 = TickId::new(10);
let tick_id2 = TickId::new(5);
assert_eq!(tick_id1 - tick_id2, 5);

type Output = i64

The resulting type after applying the - operator.

impl SubAssign<u32> for TickId

fn sub_assign(&mut self, other: u32)

Subtracts a u32 value from the TickId in place.

impl Copy for TickId

impl Eq for TickId

impl StructuralPartialEq for TickId