Enum Address

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

Either an IPv4 or IPv6 address.

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 Address::Ipv4 variants are expected.

Examples

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

let addr = "2001:db8::1".parse::<Address<Any>>()?;

assert!(addr.is_documentation());

Variants

Ipv4(Address<Ipv4>)

IPv4 address variant.

Ipv6(Address<Ipv6>)

IPv6 address variant.

Implementations

impl Address

pub const fn is_ipv4(&self) -> bool

Returns true if this is an IPv4 address.

Examples

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

let ipv4_addr = "192.0.2.1".parse::<Address<Any>>()?;
let ipv6_addr = "2001:db8::1".parse::<Address<Any>>()?;

assert!(ipv4_addr.is_ipv4());
assert!(!ipv6_addr.is_ipv4());

pub const fn is_ipv6(&self) -> bool

Returns true if this is an IPv6 address.

Examples

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

let ipv4_addr = "192.0.2.1".parse::<Address<Any>>()?;
let ipv6_addr = "2001:db8::1".parse::<Address<Any>>()?;

assert!(!ipv4_addr.is_ipv6());
assert!(ipv6_addr.is_ipv6());

pub fn to_canonical(&self) -> Self

Convert the address to its canonical representation.

Address::Ipv4 variants are returned unchanged.

Address::Ipv6 variants are handled by converting an IPv4-mapped IPv6 address to an Address::Ipv4, and returning an Address::Ipv6 otherwise.

Examples

use ip::{Address, Any, Ipv6};

let ipv4_mapped = "::ffff:192.0.2.1".parse::<Address<Any>>()?;

assert!(ipv4_mapped.is_ipv6());
assert!(ipv4_mapped.to_canonical().is_ipv4());

Trait Implementations

impl Address for Address

fn afi(&self) -> Afi

Returns the address-family associated with this IP address.

fn is_broadcast(&self) -> bool

Returns true if this is an IPv4 broadcast address (255.255.255.255). Returns false for all IPv6 addresses.

fn is_link_local(&self) -> bool

Returns true if the address is link-local.

fn is_private(&self) -> bool

Returns true if this is a private IPv4 address. Returns false for all IPv6 addresses.

fn is_reserved(&self) -> bool

Returns true if this address is an IPv4 address reserved by IANA for future use. RFC 1112 defines the block of reserved addresses as 240.0.0.0/4. This range normally includes the broadcast address 255.255.255.255, but this implementation explicitly excludes it, since it is obviously not reserved for future use.

fn is_shared(&self) -> bool

Returns true if this address is part of the IPv4 Shared Address Space defined in RFC 6598 (100.64.0.0/10).

fn is_thisnet(&self) -> bool

Returns true if this address is part of the IPv4 “This network” prefix defined in RFC 791 (0.0.0.0/8).

fn is_benchmarking(&self) -> bool

Returns true if this is an address reserved for network device benchmarking:

fn is_documentation(&self) -> bool

Returns true if this is an address reserved for documentation:

fn is_global(&self) -> bool

Returns true if this address appears to be globally reachable.

fn is_loopback(&self) -> bool

Returns true if this is a loopback address.

fn is_multicast(&self) -> bool

Returns true if this is a multicast address.

fn is_unicast(&self) -> bool

Returns true if this is neither a multicase nor a broadcast address. See is_multicast() and is_broadcast().

fn is_unspecified(&self) -> bool

Returns true for the special “unspecified” address, also called “this host on this network” in IPv4.

fn is_unique_local(&self) -> bool

Returns true if this is an IPv6 unique local address (fc00::/7 RFC 4193).

fn is_unicast_global(&self) -> bool

Returns true if this is a unicast address that is gloablly routable. See is_unicast() and is_global().

impl Arbitrary for Address

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

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 Address

fn clone(&self) -> Address

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Address

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

Formats the value using the given formatter.

impl Display for Address

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

Formats the value using the given formatter.

impl From<<Ipv4 as Afi>::Octets> for Address

fn from(octets: <Ipv4 as Afi>::Octets) -> Self

Converts to this type from the input type.

impl From<<Ipv4 as Afi>::Primitive> for Address

fn from(primitive: <Ipv4 as Afi>::Primitive) -> Self

Converts to this type from the input type.

impl From<<Ipv6 as Afi>::Octets> for Address

fn from(octets: <Ipv6 as Afi>::Octets) -> Self

Converts to this type from the input type.

impl From<<Ipv6 as Afi>::Primitive> for Address

fn from(primitive: <Ipv6 as Afi>::Primitive) -> Self

Converts to this type from the input type.

impl From<[u16; 8]> for Address

fn from(segments: [u16; 8]) -> Self

Converts to this type from the input type.

impl From<Address<Ipv4>> for Address

fn from(addr: Address<Ipv4>) -> Self

Converts to this type from the input type.

impl From<Address<Ipv6>> for Address

fn from(addr: Address<Ipv6>) -> Self

Converts to this type from the input type.

impl From<IpAddr> for Address

Available on crate feature std only.

fn from(addr: IpAddr) -> Self

Converts to this type from the input type.

impl From<Ipv4Addr> for Address

Available on crate feature std only.

fn from(addr: Ipv4Addr) -> Self

Converts to this type from the input type.

impl From<Ipv6Addr> for Address

Available on crate feature std only.

fn from(addr: Ipv6Addr) -> Self

Converts to this type from the input type.

impl FromStr for Address

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 Address

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<Address<Ipv4>> for Address

fn eq(&self, other: &Address<Ipv4>) -> 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 PartialEq<Address<Ipv6>> for Address

fn eq(&self, other: &Address<Ipv6>) -> 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 PartialEq<Address> for Address<Ipv4>

fn eq(&self, other: &Address) -> 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 PartialEq<Address> for Address<Ipv6>

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

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

fn partial_cmp(&self, other: &Address<Ipv4>) -> 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 PartialOrd<Address<Ipv6>> for Address

fn partial_cmp(&self, other: &Address<Ipv6>) -> 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 PartialOrd<Address> for Address<Ipv4>

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

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

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

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 TryFrom<Address> for Address<Ipv4>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Address> for Address<Ipv6>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Address

impl Eq for Address

impl StructuralPartialEq for Address