Struct srt::SeqNumber

pub struct SeqNumber(pub u32);

Implementations

impl SeqNumber

pub const MAX: u32

pub const MAX_DIFF: u32

pub fn new_truncate(from: u32) -> SeqNumber

pub fn new(from: u32) -> Result<SeqNumber, OutOfRangeError>

pub fn as_raw(&self) -> u32

Trait Implementations

impl Add<u32> for SeqNumber

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<u32> for SeqNumber

fn add_assign(&mut self, rhs: u32)

Performs the += operation.

impl Clone for SeqNumber

fn clone(&self) -> SeqNumber

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SeqNumber

impl Debug for SeqNumber

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

Formats the value using the given formatter.

impl Display for SeqNumber

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

Formats the value using the given formatter.

impl Distribution<SeqNumber> for Standard

fn sample<T: Rng + ?Sized>(&self, rng: &mut T) -> SeqNumber

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
    R: Rng, 

Create an iterator that generates random values of T, using rng as the source of randomness.

impl Eq for SeqNumber

impl Ord for SeqNumber

Ordering sequence numbers is difficult, as they are modular How it works is if the absolute value of the difference between sequence numbers is greater than MAX_DIFF, then wrapping is assumed

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<SeqNumber> for SeqNumber

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

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

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

This method tests for !=.

impl PartialOrd<SeqNumber> for SeqNumber

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl Rem<u32> for SeqNumber

type Output = u32

The resulting type after applying the % operator.

fn rem(self, other: u32) -> Self::Output

Performs the % operation.

impl StructuralEq for SeqNumber

impl StructuralPartialEq for SeqNumber

impl Sub<SeqNumber> for SeqNumber

Gets the distance between two sequence numbers Always measured with first one first and the second one second ie: SeqNumber(0) - SeqNumber(MAX) == 1 and SeqNumber(1) - SeqNumber(0) == 1

type Output = u32

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<u32> for SeqNumber

Move a sequence number backwards by an offset ie: SeqNumber(3) - 2 == 1 and SeqNumber(0) - 1 == SeqNumber(MAX)

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl TryFrom<u32> for SeqNumber

type Error = OutOfRangeError

The type returned in the event of a conversion error.

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

Performs the conversion.