Struct routecore::addr::MaxLenPrefix

pub struct MaxLenPrefix { /* fields omitted */ }

The pair of a prefix and an optional max-len.

Ordering

The ordering of MaxLenPrefixes is similar to the ordering of Prefixes. The only difference is the optional MaxLen. When two prefixes are equal but differ in (presence of) max_len, the order is as follows:

• any max_len always comes before no max_len
• a larger (higher) max_len comes before a smaller (lower) max_len (e.g. 24 comes before 20). This is analog to how more-specifics come before less-specifics.

Note that the max_len can either be equal to the prefix length (with no practical difference from an omitted max_len) or larger than the prefix length. The max_len can not be smaller than the prefix length. Because of that, we can safely order ‘any max_len’ before ‘no max_len’ for equal prefixes.

Implementations

impl MaxLenPrefix

pub fn new(prefix: Prefix, max_len: Option<u8>) -> Result<Self, MaxLenError>

Creates a new value.

The function returns an error if max_len is present and smaller than prefix.len() or larger than the maximum prefix length of the prefix’s address family.

pub fn saturating_new(prefix: Prefix, max_len: Option<u8>) -> Self

Creates a value curtailing any out-of-bounds max-len.

pub fn prefix(self) -> Prefix

Returns the actual prefix.

pub fn addr(self) -> IpAddr

Returns the address of the prefix.

pub fn prefix_len(self) -> u8

Returns the prefix length.

pub fn max_len(self) -> Option<u8>

Returns the max-length.

pub fn resolved_max_len(self) -> u8

Returns the max-length or the prefix-length if there is no max-length.

Trait Implementations

impl Clone for MaxLenPrefix

fn clone(&self) -> MaxLenPrefix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MaxLenPrefix

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

Formats the value using the given formatter.

impl Display for MaxLenPrefix

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

Formats the value using the given formatter.

impl From<Prefix> for MaxLenPrefix

fn from(prefix: Prefix) -> Self

Performs the conversion.

impl FromStr for MaxLenPrefix

type Err = ParseMaxLenPrefixError

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 MaxLenPrefix

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.

impl Ord for MaxLenPrefix

See Ordering in the type documentation.

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<MaxLenPrefix> for MaxLenPrefix

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

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

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

This method tests for !=.

impl PartialOrd<MaxLenPrefix> for MaxLenPrefix

See Ordering in the type documentation.

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

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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 Copy for MaxLenPrefix

impl Eq for MaxLenPrefix

impl StructuralEq for MaxLenPrefix

impl StructuralPartialEq for MaxLenPrefix