Struct Address

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

An IP address of address family A.

Implementations

impl<A: Afi> Address<A>

pub const fn new(inner: A::Primitive) -> Self

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

pub const fn into_primitive(self) -> A::Primitive

Get the primitive integer value, consuming self.

impl Address<Ipv4>

pub const BROADCAST: Self

The IPv4 subnet-local broadcast address 255.255.255.255.

pub fn to_ipv6_compatible(&self) -> Address<Ipv6>

Converts this Address<Ipv4> to an IPv4-compatible Address<Ipv6>.

IPv4-compatible IPv6 addresses are of the form ::a.b.c.d, where a.b.c.d is the corresponding IPv4 address. See RFC 4291.

Examples

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

assert_eq!(
    "172.16.12.1".parse::<Address<Ipv4>>()?.to_ipv6_compatible(),
    "::172.16.12.1".parse::<Address<Ipv6>>()?,
);

pub fn to_ipv6_mapped(&self) -> Address<Ipv6>

Converts this Address<Ipv4> to an IPv4-mapped Address<Ipv6>.

IPv4-mapped IPv6 addresses are of the form ::ffff:a.b.c.d, where a.b.c.d is the corresponding IPv4 address. See RFC 4291.

Examples

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

assert_eq!(
    "172.16.12.1".parse::<Address<Ipv4>>()?.to_ipv6_mapped(),
    "::ffff:172.16.12.1".parse::<Address<Ipv6>>()?,
);

impl Address<Ipv6>

pub fn is_unicast_link_local(&self) -> bool

Returns true if the address is unicast link local.

This method is provided for compatibility with std::net::Ipv6Addr, and is just a wrapper around Address::is_link_local().

pub fn multicast_scope(&self) -> Option<MulticastScope>

Returns the Ipv6MulticastScope variant of the address if the address is a multicast address, or None otherwise.

Examples

use ip::{concrete::Ipv6MulticastScope, Address, Ipv6};

let ipv6_site_local_multicast = "ff05::1".parse::<Address<Ipv6>>()?;
assert_eq!(
    ipv6_site_local_multicast.multicast_scope(),
    Some(Ipv6MulticastScope::SiteLocal),
);

let ipv6_global_multicast = "ff0e::1".parse::<Address<Ipv6>>()?;
assert_eq!(
    ipv6_global_multicast.multicast_scope(),
    Some(Ipv6MulticastScope::Global),
);

let ipv6_unicast = "2001:db8::1".parse::<Address<Ipv6>>()?;
assert_eq!(ipv6_unicast.multicast_scope(), None,);

pub fn segments(&self) -> [u16; 8]

Returns a big-endian [[u16; 8]] representing the segments of the address.

Examples

use ip::{Address, Ipv6};

assert_eq!(
    "2001:db8:f00::1".parse::<Address<Ipv6>>()?.segments(),
    [0x2001, 0xdb8, 0xf00, 0x0, 0x0, 0x0, 0x0, 0x1],
);

pub fn to_canonical(&self) -> Address

Convert the address to its canonical representation as an any::Address, by converting an IPv4-mapped address to a any::Address::Ipv4, and returning an any::Address::Ipv6 otherwise.

Examples

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

let ipv4_mapped = "::ffff:192.168.1.1".parse::<Address<Ipv6>>()?;
assert_eq!(
    ipv4_mapped.to_canonical(),
    "192.168.1.1".parse::<Address<Any>>()?,
);

let ipv6_unicast = "2001:db8::1".parse::<Address<Ipv6>>()?;
assert_eq!(
    ipv6_unicast.to_canonical(),
    Address::<Any>::Ipv6(ipv6_unicast),
);

pub fn to_ipv4(&self) -> Option<Address<Ipv4>>

Returns the embedded Address<Ipv4> in an IPv4-compatible or IPv4-mapped Address<Ipv6>, or None otherwise.

Examples

use ip::{Address, Ipv6};

assert_eq!(
    "::192.168.1.1"
        .parse::<Address<Ipv6>>()?
        .to_ipv4()
        .map(|ipv4| ipv4.octets()),
    Some([192, 168, 1, 1]),
);

assert_eq!("2001:db8::1".parse::<Address<Ipv6>>()?.to_ipv4(), None,);

pub fn to_ipv4_mapped(&self) -> Option<Address<Ipv4>>

Returns the embedded Address<Ipv4> in an IPv4-mapped Address<Ipv6>, or None otherwise.

Examples

use ip::{Address, Ipv6};

assert_eq!(
    "::ffff:172.16.1.1"
        .parse::<Address<Ipv6>>()?
        .to_ipv4_mapped()
        .map(|ipv4| ipv4.octets()),
    Some([172, 16, 1, 1]),
);

assert_eq!(
    "::192.168.1.1".parse::<Address<Ipv6>>()?.to_ipv4_mapped(),
    None,
);

assert_eq!(
    "2001:db8::1".parse::<Address<Ipv6>>()?.to_ipv4_mapped(),
    None,
);

impl<A: Afi> Address<A>

pub const LOCALHOST: Self

The localhost address for address family A.

pub const UNSPECIFIED: Self

The “unspecified” address for address family A.

pub const ZEROS: Self

The “all-zeros” address for address family A.

pub fn from_octets(octets: A::Octets) -> Self

Construct a new Address<A> from a big-endian byte-array.

Examples

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

assert_eq!(
    Address::<Ipv4>::from_octets([10, 0, 0, 1]),
    "10.0.0.1".parse::<Address<Ipv4>>()?,
);

assert_eq!(
    Address::<Ipv6>::from_octets([0x20, 0x01, 0x0d, 0xb8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1,]),
    "2001:db8::1".parse::<Address<Ipv6>>()?,
);

pub fn from_slice(slice: &[u8]) -> Result<Self, Error>

Try to construct a new Address<A> from a big-endian slice of octets.

If slice is shorter than A::Octets then the missing low-order octets will be zero-filled.

Errors

An error of kind OctetSliceOverrun will be returned if the length of slice is greater than the length of A::Octets.

Examples

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

assert_eq!(
    Address::<Ipv6>::from_slice(&[0x20, 0x01, 0x0d, 0xb8])?,
    "2001:db8::".parse::<Address<Ipv6>>()?,
);

assert!(matches!(
    Address::<Ipv4>::from_slice(&[1, 2, 3, 4, 5]),
    Err(_),
));

pub fn octets(&self) -> A::Octets

Returns a big-endian byte-array representing the value of self.

Examples

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

assert_eq!("10.0.0.1".parse::<Address<Ipv4>>()?.octets(), [10, 0, 0, 1],);

assert_eq!(
    "2001:db8::1".parse::<Address<Ipv6>>()?.octets(),
    [0x20, 0x01, 0x0d, 0xb8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0x01],
);

pub fn common_length(self, other: Self) -> PrefixLength<A>

Compute the common length of self and another Address<A>.

See also common_length().

Trait Implementations

impl<A: Afi, T: Type> Add<Mask<T, A>> for Address<A>

type Output = Option<Address<A>>

The resulting type after applying the + operator.

fn add(self, mask: Mask<T, A>) -> Self::Output

Performs the + operation.

impl<A: Afi> Address for Address<A>

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_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(&self) -> bool

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

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<A> Arbitrary for Address<A>

where A: Afi + 'static, A::Primitive: Arbitrary + 'static, StrategyFor<A::Primitive>: 'static,

Available on crate feature arbitrary only.

type Parameters = <<A as Afi>::Primitive as Arbitrary>::Parameters

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

type Strategy = BoxedStrategy<Address<A>>

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<A: Afi, T: Type> BitAnd<Mask<T, A>> for Address<A>

type Output = Address<A>

The resulting type after applying the & operator.

fn bitand(self, mask: Mask<T, A>) -> Self::Output

Performs the & operation.

impl<A: Afi, T> BitAndAssign<T> for Address<A>

where Self: BitAnd<T, Output = Self>,

fn bitand_assign(&mut self, rhs: T)

Performs the &= operation.

impl<A: Afi, T: Type> BitOr<Mask<T, A>> for Address<A>

type Output = Address<A>

The resulting type after applying the | operator.

fn bitor(self, mask: Mask<T, A>) -> Self::Output

Performs the | operation.

impl<A: Afi> BitXor for Address<A>

type Output = <A as Afi>::Primitive

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

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

where A::Primitive: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Afi> Debug for Address<A>

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

Formats the value using the given formatter.

impl<A: Default + Afi> Default for Address<A>

where A::Primitive: Default,

fn default() -> Address<A>

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<[u16; 8]> for Address<Ipv6>

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

Converts to this type from the input type.

impl<A: Afi> From<Address<A>> for Interface<A>

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

Converts to this type from the input type.

impl<A: Afi> From<Address<A>> for Bitmask<A>

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

Converts to this type from the input type.

impl<A: Afi> From<Address<A>> for Prefix<A>

fn from(addr: Address<A>) -> 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<Ipv4Addr> for Address<Ipv4>

Available on crate feature std only.

fn from(addr: Ipv4Addr) -> Self

Converts to this type from the input type.

impl From<Ipv6Addr> for Address<Ipv6>

Available on crate feature std only.

fn from(addr: Ipv6Addr) -> Self

Converts to this type from the input type.

impl<A, O> From<O> for Address<A>

where A: Afi<Octets = O>, O: Borrow<[u8]>,

fn from(octets: O) -> Self

Converts to this type from the input type.

impl<A: Afi> FromStr for Address<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 Address<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: Ord + Afi> Ord for Address<A>

where A::Primitive: Ord,

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

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

where A::Primitive: PartialEq,

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

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

where A::Primitive: PartialOrd,

fn partial_cmp(&self, other: &Address<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> TryFrom<&'a [u8]> for Address<Ipv4>

type Error = <<Ipv4 as Afi>::Octets as TryFrom<&'a [u8]>>::Error

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a [u8]> for Address<Ipv6>

type Error = <<Ipv6 as Afi>::Octets as TryFrom<&'a [u8]>>::Error

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

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<A: Copy + Afi> Copy for Address<A>

where A::Primitive: Copy,

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

where A::Primitive: Eq,

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