Struct PrefixLength

pub struct PrefixLength<I: Ip> { /* private fields */ }

An IP prefix length.

Implementations

impl<I: Ip> PrefixLength<I>

pub const fn get(self) -> u8

Returns the prefix length.

The returned length is guaranteed to be a valid prefix length for I::Addr.

pub fn get_mask(self) -> I::Addr

Gets the subnet-mask representation of this prefix length.

pub const unsafe fn new_unchecked(prefix_length: u8) -> Self

Constructs a PrefixLength from a given prefix length without checking whether it is too long for the address type.

Safety

prefix_length must be less than or equal to the number of bits in I::Addr. In other words, prefix_length <= I::Addr::BYTES * 8.

pub const fn new(prefix_length: u8) -> Result<Self, PrefixTooLongError>

Constructs a PrefixLength from a given unverified prefix length.

Returns Err(PrefixTooLongError) if prefix_length is too long for the address type.

pub fn try_from_subnet_mask( subnet_mask: I::Addr, ) -> Result<Self, NotSubnetMaskError>

Constructs a PrefixLength from an IP address representing a subnet mask.

Returns Err(NotSubnetMaskError) if subnet_mask is not a valid subnet mask.

Trait Implementations

impl<I: Clone + Ip> Clone for PrefixLength<I>

fn clone(&self) -> PrefixLength<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Debug + Ip> Debug for PrefixLength<I>

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

Formats the value using the given formatter.

impl<I: Ip> From<PrefixLength<I>> for u8

fn from(value: PrefixLength<I>) -> Self

Converts to this type from the input type.

impl<I: Ip, IpType> GenericOverIp<IpType> for PrefixLength<I>

where IpType: Ip,

type Type = PrefixLength<IpType>

The type of Self when its IP-generic parameter is replaced with the type NewIp.

impl<I: Hash + Ip> Hash for PrefixLength<I>

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<I: Ord + Ip> Ord for PrefixLength<I>

fn cmp(&self, other: &PrefixLength<I>) -> 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<I: PartialEq + Ip> PartialEq for PrefixLength<I>

fn eq(&self, other: &PrefixLength<I>) -> 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<I: PartialOrd + Ip> PartialOrd for PrefixLength<I>

fn partial_cmp(&self, other: &PrefixLength<I>) -> 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<I: Copy + Ip> Copy for PrefixLength<I>

impl<I: Eq + Ip> Eq for PrefixLength<I>

impl<I: Ip> StructuralPartialEq for PrefixLength<I>