Enum Interface

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

Either an IPv4 or IPv6 interface.

Memory Use

Rust enums are sized to accomodate 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 Interface::Ipv4 variants are expected.

Examples

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

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

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

Variants

Ipv4(Interface<Ipv4>)

IPv4 interface variant.

Ipv6(Interface<Ipv6>)

IPv6 interface variant.

Trait Implementations

impl Arbitrary for Interface

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<Interface>

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 Clone for Interface

fn clone(&self) -> Interface

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Interface

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

Formats the value using the given formatter.

impl Display for Interface

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

Formats the value using the given formatter.

impl From<Interface<Ipv4>> for Interface

fn from(interface: Interface<Ipv4>) -> Self

Converts to this type from the input type.

impl From<Interface<Ipv6>> for Interface

fn from(interface: Interface<Ipv6>) -> Self

Converts to this type from the input type.

impl FromStr for Interface

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 Interface

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 Interface for Interface

type Address = Address

The type of IP address represented by this interface type.

type Prefix = Prefix

The type used to represented IP prefix lengths for this IP interface type.

type PrefixLength = Length

The type used to represented IP prefixes for this IP interface type.

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

Returns the network address of the IP subnet containing this interface.

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

Returns the IP address of this interface.

fn trunc(&self) -> Self::Prefix

Returns the IP prefix containing this interface.

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

Returns the prefix length of this interface.

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

Returns the broadcast address of the IP subnet containing this interface.

impl PartialEq for Interface

fn eq(&self, other: &Interface) -> 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 TryFrom<Interface> for Interface<Ipv4>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Interface> for Interface<Ipv6>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Interface

impl Eq for Interface

impl StructuralPartialEq for Interface