pub struct Address<A: Afi>(/* private fields */);
Expand description
An IP address of address family A
.
Implementations§
Source§impl<A: Afi> Address<A>
impl<A: Afi> Address<A>
Sourcepub const fn new(inner: A::Primitive) -> Self
pub const fn new(inner: A::Primitive) -> Self
Construct a new Address<A>
from an integer primitive
appropriate to A
.
Sourcepub const fn into_primitive(self) -> A::Primitive
pub const fn into_primitive(self) -> A::Primitive
Get the primitive integer value, consuming self
.
Source§impl Address<Ipv4>
impl Address<Ipv4>
Sourcepub fn to_ipv6_compatible(&self) -> Address<Ipv6>
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>>()?,
);
Sourcepub fn to_ipv6_mapped(&self) -> 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>>()?,
);
Source§impl Address<Ipv6>
impl Address<Ipv6>
Sourcepub fn is_unicast_link_local(&self) -> bool
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()
.
Sourcepub fn multicast_scope(&self) -> Option<MulticastScope>
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,);
Sourcepub fn segments(&self) -> [u16; 8]
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],
);
Sourcepub fn to_canonical(&self) -> Address
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),
);
Sourcepub fn to_ipv4(&self) -> Option<Address<Ipv4>>
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,);
Sourcepub fn to_ipv4_mapped(&self) -> Option<Address<Ipv4>>
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,
);
Source§impl<A: Afi> Address<A>
impl<A: Afi> Address<A>
Sourcepub const UNSPECIFIED: Self
pub const UNSPECIFIED: Self
The “unspecified” address for address family A
.
Sourcepub fn from_octets(octets: A::Octets) -> Self
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>>()?,
);
Sourcepub fn from_slice(slice: &[u8]) -> Result<Self, Error>
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(_),
));
Sourcepub fn octets(&self) -> A::Octets
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],
);
Sourcepub fn common_length(self, other: Self) -> PrefixLength<A>
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§
Source§impl<A: Afi> Address for Address<A>
impl<A: Afi> Address for Address<A>
Source§fn is_broadcast(&self) -> bool
fn is_broadcast(&self) -> bool
Source§fn is_private(&self) -> bool
fn is_private(&self) -> bool
Source§fn is_reserved(&self) -> bool
fn is_reserved(&self) -> bool
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. Read moreSource§fn is_thisnet(&self) -> bool
fn is_thisnet(&self) -> bool
Source§fn is_benchmarking(&self) -> bool
fn is_benchmarking(&self) -> bool
Source§fn is_documentation(&self) -> bool
fn is_documentation(&self) -> bool
Source§fn is_unspecified(&self) -> bool
fn is_unspecified(&self) -> bool
Source§fn is_unique_local(&self) -> bool
fn is_unique_local(&self) -> bool
Source§fn is_unicast(&self) -> bool
fn is_unicast(&self) -> bool
true
if this is neither a multicase nor a broadcast
address. See is_multicast()
and
is_broadcast()
. Read moreSource§fn is_unicast_global(&self) -> bool
fn is_unicast_global(&self) -> bool
true
if this is a unicast address that is gloablly
routable. See is_unicast()
and
is_global()
. Read moreSource§impl<A> Arbitrary for Address<A>
Available on crate feature arbitrary
only.
impl<A> Arbitrary for Address<A>
arbitrary
only.Source§type Parameters = <<A as Afi>::Primitive as Arbitrary>::Parameters
type Parameters = <<A as Afi>::Primitive as Arbitrary>::Parameters
arbitrary_with
accepts for configuration
of the generated Strategy
. Parameters must implement Default
.Source§type Strategy = BoxedStrategy<Address<A>>
type Strategy = BoxedStrategy<Address<A>>
Strategy
used to generate values of type Self
.Source§fn arbitrary_with(params: Self::Parameters) -> Self::Strategy
fn arbitrary_with(params: Self::Parameters) -> Self::Strategy
Source§impl<A: Afi, T> BitAndAssign<T> for Address<A>where
Self: BitAnd<T, Output = Self>,
impl<A: Afi, T> BitAndAssign<T> for Address<A>where
Self: BitAnd<T, Output = Self>,
Source§fn bitand_assign(&mut self, rhs: T)
fn bitand_assign(&mut self, rhs: T)
&=
operation. Read moreSource§impl<A: Ord + Afi> Ord for Address<A>
impl<A: Ord + Afi> Ord for Address<A>
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Source§impl<A: Afi> PartialOrd<Address<A>> for Prefix<A>
impl<A: Afi> PartialOrd<Address<A>> for Prefix<A>
Source§impl PartialOrd<Address<Ipv4>> for Address
impl PartialOrd<Address<Ipv4>> for Address
Source§impl PartialOrd<Address<Ipv6>> for Address
impl PartialOrd<Address<Ipv6>> for Address
Source§impl PartialOrd<Address> for Address<Ipv4>
impl PartialOrd<Address> for Address<Ipv4>
Source§impl PartialOrd<Address> for Address<Ipv6>
impl PartialOrd<Address> for Address<Ipv6>
Source§impl<A: PartialOrd + Afi> PartialOrd for Address<A>where
A::Primitive: PartialOrd,
impl<A: PartialOrd + Afi> PartialOrd for Address<A>where
A::Primitive: PartialOrd,
impl<A: Copy + Afi> Copy for Address<A>
impl<A: Eq + Afi> Eq for Address<A>
impl<A: Afi> StructuralPartialEq for Address<A>
Auto Trait Implementations§
impl<A> Freeze for Address<A>
impl<A> RefUnwindSafe for Address<A>
impl<A> Send for Address<A>
impl<A> Sync for Address<A>
impl<A> Unpin for Address<A>
impl<A> UnwindSafe for Address<A>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.