1.0.0[−][src]Struct std::net::Ipv4Addr
An IPv4 address.
IPv4 addresses are defined as 32-bit integers in IETF RFC 791. They are usually represented as four octets.
See IpAddr
for a type encompassing both IPv4 and IPv6 addresses.
The size of an Ipv4Addr
struct may vary depending on the target operating
system.
Textual representation
Ipv4Addr
provides a FromStr
implementation. The four octets are in decimal
notation, divided by .
(this is called "dot-decimal notation").
Examples
use std::net::Ipv4Addr; let localhost = Ipv4Addr::new(127, 0, 0, 1); assert_eq!("127.0.0.1".parse(), Ok(localhost)); assert_eq!(localhost.is_loopback(), true);Run
Methods
impl Ipv4Addr
[src]
pub const fn new(a: u8, b: u8, c: u8, d: u8) -> Ipv4Addr
[src]
Creates a new IPv4 address from four eight-bit octets.
The result will represent the IP address a
.b
.c
.d
.
Examples
use std::net::Ipv4Addr; let addr = Ipv4Addr::new(127, 0, 0, 1);Run
pub const LOCALHOST: Self
1.30.0[src]
An IPv4 address with the address pointing to localhost: 127.0.0.1.
Examples
use std::net::Ipv4Addr; let addr = Ipv4Addr::LOCALHOST; assert_eq!(addr, Ipv4Addr::new(127, 0, 0, 1));Run
pub const UNSPECIFIED: Self
1.30.0[src]
An IPv4 address representing an unspecified address: 0.0.0.0
Examples
use std::net::Ipv4Addr; let addr = Ipv4Addr::UNSPECIFIED; assert_eq!(addr, Ipv4Addr::new(0, 0, 0, 0));Run
pub const BROADCAST: Self
1.30.0[src]
An IPv4 address representing the broadcast address: 255.255.255.255
Examples
use std::net::Ipv4Addr; let addr = Ipv4Addr::BROADCAST; assert_eq!(addr, Ipv4Addr::new(255, 255, 255, 255));Run
pub fn octets(&self) -> [u8; 4]
[src]
Returns the four eight-bit integers that make up this address.
Examples
use std::net::Ipv4Addr; let addr = Ipv4Addr::new(127, 0, 0, 1); assert_eq!(addr.octets(), [127, 0, 0, 1]);Run
pub const fn is_unspecified(&self) -> bool
1.12.0[src]
Returns true
for the special 'unspecified' address (0.0.0.0).
This property is defined in UNIX Network Programming, Second Edition, W. Richard Stevens, p. 891; see also ip7.
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(0, 0, 0, 0).is_unspecified(), true); assert_eq!(Ipv4Addr::new(45, 22, 13, 197).is_unspecified(), false);Run
pub fn is_loopback(&self) -> bool
1.7.0[src]
Returns true
if this is a loopback address (127.0.0.0/8).
This property is defined by IETF RFC 1122.
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(127, 0, 0, 1).is_loopback(), true); assert_eq!(Ipv4Addr::new(45, 22, 13, 197).is_loopback(), false);Run
pub fn is_private(&self) -> bool
1.7.0[src]
Returns true
if this is a private address.
The private address ranges are defined in IETF RFC 1918 and include:
- 10.0.0.0/8
- 172.16.0.0/12
- 192.168.0.0/16
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(10, 0, 0, 1).is_private(), true); assert_eq!(Ipv4Addr::new(10, 10, 10, 10).is_private(), true); assert_eq!(Ipv4Addr::new(172, 16, 10, 10).is_private(), true); assert_eq!(Ipv4Addr::new(172, 29, 45, 14).is_private(), true); assert_eq!(Ipv4Addr::new(172, 32, 0, 2).is_private(), false); assert_eq!(Ipv4Addr::new(192, 168, 0, 2).is_private(), true); assert_eq!(Ipv4Addr::new(192, 169, 0, 2).is_private(), false);Run
pub fn is_link_local(&self) -> bool
1.7.0[src]
Returns true
if the address is link-local (169.254.0.0/16).
This property is defined by IETF RFC 3927.
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(169, 254, 0, 0).is_link_local(), true); assert_eq!(Ipv4Addr::new(169, 254, 10, 65).is_link_local(), true); assert_eq!(Ipv4Addr::new(16, 89, 10, 65).is_link_local(), false);Run
pub fn is_global(&self) -> bool
[src]
🔬 This is a nightly-only experimental API. (ip
#27709)
extra functionality has not been scrutinized to the level that it should be to be stable
Returns true
if the address appears to be globally routable.
See iana-ipv4-special-registry.
The following return false:
- private addresses (see
is_private()
) - the loopback address (see
is_loopback()
) - the link-local address (see
is_link_local()
) - the broadcast address (see
is_broadcast()
) - addresses used for documentation (see
is_documentation()
) - the unspecified address (see
is_unspecified()
), and the whole 0.0.0.0/8 block - addresses reserved for future protocols (see
is_ietf_protocol_assignment()
, except192.0.0.9/32
and192.0.0.10/32
which are globally routable - addresses reserved for future use (see
is_reserved()
- addresses reserved for networking devices benchmarking (see
is_benchmarking
)
Examples
#![feature(ip)] use std::net::Ipv4Addr; fn main() { // private addresses are not global assert_eq!(Ipv4Addr::new(10, 254, 0, 0).is_global(), false); assert_eq!(Ipv4Addr::new(192, 168, 10, 65).is_global(), false); assert_eq!(Ipv4Addr::new(172, 16, 10, 65).is_global(), false); // the 0.0.0.0/8 block is not global assert_eq!(Ipv4Addr::new(0, 1, 2, 3).is_global(), false); // in particular, the unspecified address is not global assert_eq!(Ipv4Addr::new(0, 0, 0, 0).is_global(), false); // the loopback address is not global assert_eq!(Ipv4Addr::new(127, 0, 0, 1).is_global(), false); // link local addresses are not global assert_eq!(Ipv4Addr::new(169, 254, 45, 1).is_global(), false); // the broadcast address is not global assert_eq!(Ipv4Addr::new(255, 255, 255, 255).is_global(), false); // the broadcast address is not global assert_eq!(Ipv4Addr::new(192, 0, 2, 255).is_global(), false); assert_eq!(Ipv4Addr::new(198, 51, 100, 65).is_global(), false); assert_eq!(Ipv4Addr::new(203, 0, 113, 6).is_global(), false); // shared addresses are not global assert_eq!(Ipv4Addr::new(100, 100, 0, 0).is_global(), false); // addresses reserved for protocol assignment are not global assert_eq!(Ipv4Addr::new(192, 0, 0, 0).is_global(), false); assert_eq!(Ipv4Addr::new(192, 0, 0, 255).is_global(), false); // addresses reserved for future use are not global assert_eq!(Ipv4Addr::new(250, 10, 20, 30).is_global(), false); // addresses reserved for network devices benchmarking are not global assert_eq!(Ipv4Addr::new(198, 18, 0, 0).is_global(), false); // All the other addresses are global assert_eq!(Ipv4Addr::new(1, 1, 1, 1).is_global(), true); assert_eq!(Ipv4Addr::new(80, 9, 12, 3).is_global(), true); }Run
pub fn is_shared(&self) -> bool
[src]
🔬 This is a nightly-only experimental API. (ip
#27709)
extra functionality has not been scrutinized to the level that it should be to be stable
Returns true
if this address is part of the Shared Address Space defined in
IETF RFC 6598 (100.64.0.0/10
).
Examples
#![feature(ip)] use std::net::Ipv4Addr; fn main() { assert_eq!(Ipv4Addr::new(100, 64, 0, 0).is_shared(), true); assert_eq!(Ipv4Addr::new(100, 127, 255, 255).is_shared(), true); assert_eq!(Ipv4Addr::new(100, 128, 0, 0).is_shared(), false); }Run
pub fn is_ietf_protocol_assignment(&self) -> bool
[src]
🔬 This is a nightly-only experimental API. (ip
#27709)
extra functionality has not been scrutinized to the level that it should be to be stable
Returns true
if this address is part of 192.0.0.0/24
, which is reserved to
IANA for IETF protocol assignments, as documented in IETF RFC 6890.
Note that parts of this block are in use:
192.0.0.8/32
is the "IPv4 dummy address" (see IETF RFC 7600)192.0.0.9/32
is the "Port Control Protocol Anycast" (see IETF RFC 7723)192.0.0.10/32
is used for NAT traversal (see IETF RFC 8155)
Examples
#![feature(ip)] use std::net::Ipv4Addr; fn main() { assert_eq!(Ipv4Addr::new(192, 0, 0, 0).is_ietf_protocol_assignment(), true); assert_eq!(Ipv4Addr::new(192, 0, 0, 8).is_ietf_protocol_assignment(), true); assert_eq!(Ipv4Addr::new(192, 0, 0, 9).is_ietf_protocol_assignment(), true); assert_eq!(Ipv4Addr::new(192, 0, 0, 255).is_ietf_protocol_assignment(), true); assert_eq!(Ipv4Addr::new(192, 0, 1, 0).is_ietf_protocol_assignment(), false); assert_eq!(Ipv4Addr::new(191, 255, 255, 255).is_ietf_protocol_assignment(), false); }Run
pub fn is_benchmarking(&self) -> bool
[src]
🔬 This is a nightly-only experimental API. (ip
#27709)
extra functionality has not been scrutinized to the level that it should be to be stable
Returns true
if this address part of the 198.18.0.0/15
range, which is reserved for
network devices benchmarking. This range is defined in [IETF RFC 2544] as 192.18.0.0
through 198.19.255.255
but [errata 423] corrects it to 198.18.0.0/15
.
Examples
#![feature(ip)] use std::net::Ipv4Addr; fn main() { assert_eq!(Ipv4Addr::new(198, 17, 255, 255).is_benchmarking(), false); assert_eq!(Ipv4Addr::new(198, 18, 0, 0).is_benchmarking(), true); assert_eq!(Ipv4Addr::new(198, 19, 255, 255).is_benchmarking(), true); assert_eq!(Ipv4Addr::new(198, 20, 0, 0).is_benchmarking(), false); }Run
pub fn is_reserved(&self) -> bool
[src]
🔬 This is a nightly-only experimental API. (ip
#27709)
extra functionality has not been scrutinized to the level that it should be to be stable
Returns true
if this address is reserved by IANA for future use. IETF 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 explicitely excludes it, since
it is obviously not reserved for future use.
Warning
As IANA assigns new addresses, this method will be updated. This may result in non-reserved addresses being treated as reserved in code that relies on an outdated version of this method.
Examples
#![feature(ip)] use std::net::Ipv4Addr; fn main() { assert_eq!(Ipv4Addr::new(240, 0, 0, 0).is_reserved(), true); assert_eq!(Ipv4Addr::new(255, 255, 255, 254).is_reserved(), true); assert_eq!(Ipv4Addr::new(239, 255, 255, 255).is_reserved(), false); // The broadcast address is not considered as reserved for future use by this // implementation assert_eq!(Ipv4Addr::new(255, 255, 255, 255).is_reserved(), false); }Run
pub fn is_multicast(&self) -> bool
1.7.0[src]
Returns true
if this is a multicast address (224.0.0.0/4).
Multicast addresses have a most significant octet between 224 and 239, and is defined by IETF RFC 5771.
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(224, 254, 0, 0).is_multicast(), true); assert_eq!(Ipv4Addr::new(236, 168, 10, 65).is_multicast(), true); assert_eq!(Ipv4Addr::new(172, 16, 10, 65).is_multicast(), false);Run
pub fn is_broadcast(&self) -> bool
1.7.0[src]
Returns true
if this is a broadcast address (255.255.255.255).
A broadcast address has all octets set to 255 as defined in IETF RFC 919.
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(255, 255, 255, 255).is_broadcast(), true); assert_eq!(Ipv4Addr::new(236, 168, 10, 65).is_broadcast(), false);Run
pub fn is_documentation(&self) -> bool
1.7.0[src]
Returns true
if this address is in a range designated for documentation.
This is defined in IETF RFC 5737:
- 192.0.2.0/24 (TEST-NET-1)
- 198.51.100.0/24 (TEST-NET-2)
- 203.0.113.0/24 (TEST-NET-3)
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(192, 0, 2, 255).is_documentation(), true); assert_eq!(Ipv4Addr::new(198, 51, 100, 65).is_documentation(), true); assert_eq!(Ipv4Addr::new(203, 0, 113, 6).is_documentation(), true); assert_eq!(Ipv4Addr::new(193, 34, 17, 19).is_documentation(), false);Run
pub fn to_ipv6_compatible(&self) -> Ipv6Addr
[src]
Converts this address to an IPv4-compatible IPv6 address.
a.b.c.d becomes ::a.b.c.d
Examples
use std::net::{Ipv4Addr, Ipv6Addr}; assert_eq!(Ipv4Addr::new(192, 0, 2, 255).to_ipv6_compatible(), Ipv6Addr::new(0, 0, 0, 0, 0, 0, 49152, 767));Run
pub fn to_ipv6_mapped(&self) -> Ipv6Addr
[src]
Converts this address to an IPv4-mapped IPv6 address.
a.b.c.d becomes ::ffff:a.b.c.d
Examples
use std::net::{Ipv4Addr, Ipv6Addr}; assert_eq!(Ipv4Addr::new(192, 0, 2, 255).to_ipv6_mapped(), Ipv6Addr::new(0, 0, 0, 0, 0, 65535, 49152, 767));Run
Trait Implementations
impl PartialEq<Ipv4Addr> for Ipv4Addr
[src]
fn eq(&self, other: &Ipv4Addr) -> bool
[src]
#[must_use]
fn ne(&self, other: &Rhs) -> bool
[src]
This method tests for !=
.
impl PartialEq<Ipv4Addr> for IpAddr
1.16.0[src]
fn eq(&self, other: &Ipv4Addr) -> bool
[src]
#[must_use]
fn ne(&self, other: &Rhs) -> bool
[src]
This method tests for !=
.
impl PartialEq<IpAddr> for Ipv4Addr
1.16.0[src]
fn eq(&self, other: &IpAddr) -> bool
[src]
#[must_use]
fn ne(&self, other: &Rhs) -> bool
[src]
This method tests for !=
.
impl Eq for Ipv4Addr
[src]
impl Ord for Ipv4Addr
[src]
fn cmp(&self, other: &Ipv4Addr) -> Ordering
[src]
fn max(self, other: Self) -> Self
1.21.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
Compares and returns the minimum of two values. Read more
fn clamp(self, min: Self, max: Self) -> Self
[src]
Restrict a value to a certain interval. Read more
impl PartialOrd<Ipv4Addr> for Ipv4Addr
[src]
fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl PartialOrd<Ipv4Addr> for IpAddr
1.16.0[src]
fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl PartialOrd<IpAddr> for Ipv4Addr
1.16.0[src]
fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Hash for Ipv4Addr
[src]
fn hash<H: Hasher>(&self, s: &mut H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Copy for Ipv4Addr
[src]
impl Display for Ipv4Addr
[src]
impl Debug for Ipv4Addr
[src]
impl FromStr for Ipv4Addr
[src]
type Err = AddrParseError
The associated error which can be returned from parsing.
fn from_str(s: &str) -> Result<Ipv4Addr, AddrParseError>
[src]
impl From<Ipv4Addr> for IpAddr
1.16.0[src]
impl From<Ipv4Addr> for u32
1.1.0[src]
impl From<u32> for Ipv4Addr
1.1.0[src]
impl From<[u8; 4]> for Ipv4Addr
1.9.0[src]
impl Clone for Ipv4Addr
[src]
Auto Trait Implementations
Blanket Implementations
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
ⓘImportant traits for &'_ mut Ffn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,