Struct Serial 

pub struct Serial<T>(/* private fields */);

A wraparound serial number.

Example

use serial_uint::Serial;

let a = Serial::<u8>::new(250);
let b = a + 10; // wraparound: 250 + 10 = 4
assert_eq!(b.value(), 4);
assert!(a < b); // wraparound comparison: a precedes b

Implementations

impl<T: SerialPrimitive> Serial<T>

pub const fn new(value: T) -> Self

Constructs a serial number from a raw value.

pub fn value(self) -> T

Returns the underlying raw value.

pub fn distance_to(self, other: Self) -> T

The forward wraparound distance from self to other, i.e. other - self (wraparound).

The result lies in [0, MAX] and is always non-negative. For example, for u8 the distance from 250 to 4 is 10.

pub fn precedes(self, other: Self) -> bool

Returns whether self precedes other (in the wraparound sense).

Returns false when the two are exactly half a cycle apart and their ordering is undefined.

Trait Implementations

impl<T: SerialPrimitive> Add<T> for Serial<T>

fn add(self, rhs: T) -> Serial<T>

Adds an offset (wraparound).

Per RFC 1982 the addend must be in [0, HALF - 1]; larger values are undefined. This is checked with debug_assert! (debug builds only) and otherwise still wraps.

type Output = Serial<T>

The resulting type after applying the + operator.

impl<T: SerialPrimitive> AddAssign<T> for Serial<T>

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<T: Clone> Clone for Serial<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Serial<T>

impl<T: Debug> Debug for Serial<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Serial<T>

fn default() -> Serial<T>

Returns the “default value” for a type.

impl<T: SerialPrimitive + Display> Display for Serial<T>

Forwards to the underlying value’s Display, so a serial number prints just like its raw value.

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Serial<T>

impl<T: Hash> Hash for Serial<T>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq> PartialEq for Serial<T>

fn eq(&self, other: &Serial<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 PartialEq<Serial<u8>> for u8

Compare equality directly against the underlying raw value: raw == serial.

fn eq(&self, other: &Serial<u8>) -> 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<Serial<u16>> for u16

Compare equality directly against the underlying raw value: raw == serial.

fn eq(&self, other: &Serial<u16>) -> 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<Serial<u32>> for u32

Compare equality directly against the underlying raw value: raw == serial.

fn eq(&self, other: &Serial<u32>) -> 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<Serial<u64>> for u64

Compare equality directly against the underlying raw value: raw == serial.

fn eq(&self, other: &Serial<u64>) -> 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<Serial<u128>> for u128

Compare equality directly against the underlying raw value: raw == serial.

fn eq(&self, other: &Serial<u128>) -> 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<Serial<usize>> for usize

Compare equality directly against the underlying raw value: raw == serial.

fn eq(&self, other: &Serial<usize>) -> 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: SerialPrimitive> PartialEq<T> for Serial<T>

Compare equality directly against the underlying raw value: serial == raw.

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

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

RFC 1982 wraparound comparison.

Let the wraparound difference be d = other - self (wraparound):

• d == 0 → equal
• 0 < d < HALF → self < other
• d > HALF → self > other
• d == HALF → undefined, returns None

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<Serial<u8>> for u8

Wraparound ordering against a serial number: raw <cmp> serial.

The raw value is treated as Serial(raw), so the comparison uses RFC 1982 wraparound semantics (and yields None when half a cycle apart).

fn partial_cmp(&self, other: &Serial<u8>) -> 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<Serial<u16>> for u16

Wraparound ordering against a serial number: raw <cmp> serial.

The raw value is treated as Serial(raw), so the comparison uses RFC 1982 wraparound semantics (and yields None when half a cycle apart).

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

Wraparound ordering against a serial number: raw <cmp> serial.

The raw value is treated as Serial(raw), so the comparison uses RFC 1982 wraparound semantics (and yields None when half a cycle apart).

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

Wraparound ordering against a serial number: raw <cmp> serial.

The raw value is treated as Serial(raw), so the comparison uses RFC 1982 wraparound semantics (and yields None when half a cycle apart).

fn partial_cmp(&self, other: &Serial<u64>) -> 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<Serial<u128>> for u128

Wraparound ordering against a serial number: raw <cmp> serial.

The raw value is treated as Serial(raw), so the comparison uses RFC 1982 wraparound semantics (and yields None when half a cycle apart).

fn partial_cmp(&self, other: &Serial<u128>) -> 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<Serial<usize>> for usize

Wraparound ordering against a serial number: raw <cmp> serial.

The raw value is treated as Serial(raw), so the comparison uses RFC 1982 wraparound semantics (and yields None when half a cycle apart).

fn partial_cmp(&self, other: &Serial<usize>) -> 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: SerialPrimitive> PartialOrd<T> for Serial<T>

Wraparound ordering against a raw value: serial <cmp> raw.

The raw value is treated as Serial(raw), so the comparison uses RFC 1982 wraparound semantics (and yields None when half a cycle apart).

fn partial_cmp(&self, other: &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: PartialEq> StructuralPartialEq for Serial<T>

impl<T: SerialPrimitive> Sub<T> for Serial<T>

fn sub(self, rhs: T) -> Serial<T>

Subtracts an offset (wraparound).

type Output = Serial<T>

The resulting type after applying the - operator.

impl<T: SerialPrimitive> SubAssign<T> for Serial<T>

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.