Struct PrefixLength

pub struct PrefixLength<A: Afi>(/* private fields */);

An IP prefix length guaranteed to be within appropriate bounds for address family A.

Implementations

impl<A: Afi> PrefixLength<A>

pub const MIN: Self

Minimum valid value of PrefixLength<A>.

pub const MAX: Self

Maximum valid value of PrefixLength<A>.

pub fn from_primitive( n: <A::Primitive as Address<A>>::Length, ) -> Result<Self, Error>

Construct a new PrefixLength<A> from an integer primitive appropriate to A.

Errors

Fails if n is outside of the range Self::MIN to Self::MAX inclusive.

pub const fn into_primitive(self) -> <A::Primitive as Address<A>>::Length

Get the inner integer val, consuming self.

Trait Implementations

impl<A: Afi> Arbitrary for PrefixLength<A>

where <A::Primitive as Address<A>>::Length: 'static, RangeInclusive<<A::Primitive as Address<A>>::Length>: Strategy<Value = <A::Primitive as Address<A>>::Length>,

Available on crate feature arbitrary only.

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<PrefixLength<A>>

The type of Strategy used to generate values of type Self.

fn arbitrary_with((): Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl<A: Afi> AsRef<u8> for PrefixLength<A>

where A::Primitive: Address<A, Length = u8>,

fn as_ref(&self) -> &u8

Converts this type into a shared reference of the (usually inferred) input type.

impl<A: Clone + Afi> Clone for PrefixLength<A>

where A::Primitive: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Debug + Afi> Debug for PrefixLength<A>

where A::Primitive: Debug,

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

Formats the value using the given formatter.

impl<A: Afi> Display for PrefixLength<A>

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

Formats the value using the given formatter.

impl<A: Afi> From<PrefixLength<A>> for Hostmask<A>

fn from(len: PrefixLength<A>) -> Self

Converts to this type from the input type.

impl<A: Afi> From<PrefixLength<A>> for Netmask<A>

fn from(len: PrefixLength<A>) -> Self

Converts to this type from the input type.

impl From<PrefixLength<Ipv4>> for Length

fn from(length: PrefixLength<Ipv4>) -> Self

Converts to this type from the input type.

impl From<PrefixLength<Ipv6>> for Length

fn from(length: PrefixLength<Ipv6>) -> Self

Converts to this type from the input type.

impl<A: Afi> FromStr for PrefixLength<A>

type Err = Error

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<A: Hash + Afi> Hash for PrefixLength<A>

where A::Primitive: Hash,

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<A: Afi> Length for PrefixLength<A>

fn increment(self) -> Result<Self, Error>

Returns a new Self that is one greater than self unless self is already the maximum possible value.

fn decrement(self) -> Result<Self, Error>

Returns a new Self that is one less than self unless self is already the minimum possible value.

impl<A: Afi> Neg for PrefixLength<A>

type Output = PrefixLength<A>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<A: Ord + Afi> Ord for PrefixLength<A>

where A::Primitive: Ord,

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

where A::Primitive: PartialEq,

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

where A::Primitive: PartialOrd,

fn partial_cmp(&self, other: &PrefixLength<A>) -> 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<A: Afi, T: Type> Shl<PrefixLength<A>> for Mask<T, A>

type Output = Mask<T, A>

The resulting type after applying the << operator.

fn shl(self, rhs: PrefixLength<A>) -> Self::Output

Performs the << operation.

impl<A: Afi, T: Type> Shr<PrefixLength<A>> for Mask<T, A>

type Output = Mask<T, A>

The resulting type after applying the >> operator.

fn shr(self, rhs: PrefixLength<A>) -> Self::Output

Performs the >> operation.

impl TryFrom<Length> for PrefixLength<Ipv4>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Length> for PrefixLength<Ipv6>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: Afi> TryFrom<usize> for PrefixLength<A>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl<A: Copy + Afi> Copy for PrefixLength<A>

where A::Primitive: Copy,

impl<A: Eq + Afi> Eq for PrefixLength<A>

where A::Primitive: Eq,

impl<A: Afi> StructuralPartialEq for PrefixLength<A>