Enum Prefix

pub enum Prefix {
    Ipv4(Prefix<Ipv4>),
    Ipv6(Prefix<Ipv6>),
}

Either an IPv4 or IPv6 prefix.

Memory Use

Rust enums are sized to accommodate their largest variant, with smaller variants being padded to fill up any unused space.

As a result, users should avoid using this type in a context where only Prefix::Ipv4 variants are expected.

Examples

use ip::{
    traits::{Address as _, Prefix as _},
    Any, Prefix,
};

let prefix = "192.0.2.0/24".parse::<Prefix<Any>>()?;

assert!(prefix.network().is_documentation());

Variants

Ipv4(Prefix<Ipv4>)

IPv4 prefix variant.

Ipv6(Prefix<Ipv6>)

IPv6 prefix variant.

Trait Implementations

impl Arbitrary for Prefix

Available on crate feature arbitrary only.

type Parameters = (<Prefix<Ipv4> as Arbitrary>::Parameters, <Prefix<Ipv6> as Arbitrary>::Parameters)

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

type Strategy = BoxedStrategy<Prefix>

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

fn arbitrary_with(params: 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 Clone for Prefix

fn clone(&self) -> Prefix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Prefix

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

Formats the value using the given formatter.

impl Display for Prefix

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

Formats the value using the given formatter.

impl Extend<Prefix> for Set

Available on crate feature std only.

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = Prefix>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Prefix<Ipv4>> for Prefix

fn from(prefix: Prefix<Ipv4>) -> Self

Converts to this type from the input type.

impl From<Prefix<Ipv6>> for Prefix

fn from(prefix: Prefix<Ipv6>) -> Self

Converts to this type from the input type.

impl From<Prefix> for Range

fn from(prefix: Prefix) -> Self

Converts to this type from the input type.

impl FromStr for Prefix

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 Hash for Prefix

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 PartialEq for Prefix

fn eq(&self, other: &Prefix) -> 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 PartialOrd for Prefix

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

type Address = Address

The type of IP address represented by this prefix type.

type Length = Length

The type used to represent lengths for this IP prefix type.

type Hostmask = Mask<Host>

The type of IP hostmask corresponding to this prefix type.

type Netmask = Mask<Net>

The type of IP netmask corresponding to this prefix type.

type Subprefixes = Subprefixes

The Iterator type returned by the Self::subprefixes method.

fn network(&self) -> Self::Address

Returns the network address of the IP subnet represented by this prefix.

fn hostmask(&self) -> Self::Hostmask

Returns the hostmask of the IP subnet represented by this prefix.

fn netmask(&self) -> Self::Netmask

Returns the netmask of the IP subnet represented by this prefix.

fn max_prefix_len(&self) -> Self::Length

Returns the maximum valid prefix length for prefixes of this type.

fn prefix_len(&self) -> Self::Length

Returns the length of this prefix.

fn broadcast(&self) -> Self::Address

Returns the broadcast address of the IP subnet represented by this prefix.

fn supernet(&self) -> Option<Self>

Returns the prefix of length self.prefix_len() + 1 containing self, if it exists.

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

Returns true if self and other share the same immediate supernet. See also supernet().

fn subprefixes( &self, new_prefix_length: Self::Length, ) -> Result<Self::Subprefixes, Error>

Returns an iterator over the subprefixes of self of length new_prefix_len.

fn new_prefix_length(&self, length: u8) -> Result<Self::Length, Error>

Try to construct a new Self::Length for the address-family associated with this IP prefix.

fn contains<T>(&self, other: &T) -> bool

where Self: PartialOrd<T>,

Returns true if self contains other (in the set-theoretic sense).

fn afi(&self) -> Afi

Returns the address-family associated with this IP prefix.

impl TryFrom<Prefix> for Prefix<Ipv4>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Prefix> for Prefix<Ipv6>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Prefix

impl Eq for Prefix

impl StructuralPartialEq for Prefix