Struct routinator::rtr::Serial

pub struct Serial(pub u32);

A serial number.

Serial numbers are regular integers with a special notion for comparison in order to be able to deal with roll-over.

Specifically, addition and comparison are defined in RFC 1982. Addition, however, is only defined for values up to 2^31 - 1, so we decided to not implement the Add trait but rather have a dedicated method add so as to not cause surprise panics.

Serial numbers only implement a partial ordering. That is, there are pairs of values that are not equal but there still isn’t one value larger than the other. Since this is neatly implemented by the PartialOrd trait, the type implements that.

Methods

impl Serial

pub fn from_be(value: u32) -> Self

pub fn to_be(self) -> u32

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

Add other to self.

Serial numbers only allow values of up to 2^31 - 1 to be added to them. Therefore, this method requires other to be a u32 instead of a Serial to indicate that you cannot simply add two serials together. This is also why we don’t implement the Add trait.

Panics

This method panics if other is greater than 2^31 - 1.

Trait Implementations

impl From<u32> for Serial

fn from(value: u32) -> Serial

Performs the conversion.

impl From<Serial> for u32

fn from(serial: Serial) -> u32

Performs the conversion.

impl Clone for Serial

fn clone(&self) -> Serial

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Serial

impl Eq for Serial

impl PartialEq<Serial> for Serial

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

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

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

This method tests for !=.

impl PartialEq<u32> for Serial

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

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

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

This method tests for !=.

impl PartialOrd<Serial> for Serial

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

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

Formats the value using the given formatter.

impl Display for Serial

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

Formats the value using the given formatter.

impl FromStr for Serial

type Err = <u32 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 Hash for Serial

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, 

Feeds a slice of this type into the given [Hasher].