Struct std::net::Ipv4Addr
pub struct Ipv4Addr { /* fields omitted */ }
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”). Notably, octal numbers and hexadecimal numbers are not allowed per IETF RFC 6943.
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);Implementations
impl Ipv4Addr
pub const fn new(a: u8, b: u8, c: u8, d: u8) -> Ipv4Addr
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);
pub const LOCALHOST: Self
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));
pub const UNSPECIFIED: Self
An IPv4 address representing an unspecified address: 0.0.0.0
This corresponds to the constant INADDR_ANY in other languages.
Examples
use std::net::Ipv4Addr; let addr = Ipv4Addr::UNSPECIFIED; assert_eq!(addr, Ipv4Addr::new(0, 0, 0, 0));
pub const BROADCAST: Self
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));
pub const fn octets(&self) -> [u8; 4]
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]);
pub const fn is_unspecified(&self) -> bool
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);
pub const fn is_loopback(&self) -> bool
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);
pub const fn is_private(&self) -> bool
Returns true if this is a private address.
The private address ranges are defined in IETF RFC 1918 and include:
10.0.0.0/8172.16.0.0/12192.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);
pub const fn is_link_local(&self) -> bool
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);
pub fn is_global(&self) -> bool
Returns true if the address appears to be globally routable. See iana-ipv4-special-registry.
The following return false:
- private addresses (see
Ipv4Addr::is_private()) - the loopback address (see
Ipv4Addr::is_loopback()) - the link-local address (see
Ipv4Addr::is_link_local()) - the broadcast address (see
Ipv4Addr::is_broadcast()) - addresses used for documentation (see
Ipv4Addr::is_documentation()) - the unspecified address (see
Ipv4Addr::is_unspecified()), and the whole0.0.0.0/8block - addresses reserved for future protocols, except
192.0.0.9/32and192.0.0.10/32which are globally routable - addresses reserved for future use (see
Ipv4Addr::is_reserved() - addresses reserved for networking devices benchmarking (see
Ipv4Addr::is_benchmarking())
Examples
#![feature(ip)] use std::net::Ipv4Addr; // 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 address space designated for documentation 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);
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; 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);
pub fn is_benchmarking(&self) -> bool
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; 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);
pub fn is_reserved(&self) -> bool
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 explicitly 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; 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);
pub const fn is_multicast(&self) -> bool
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);
pub const fn is_broadcast(&self) -> bool
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);
pub const fn is_documentation(&self) -> bool
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);
pub const fn to_ipv6_compatible(&self) -> Ipv6Addr
Converts this address to an IPv4-compatible IPv6 address.
a.b.c.d becomes ::a.b.c.d
Note that IPv4-compatible addresses have been officially deprecated. If you don’t explicitly need an IPv4-compatible address for legacy reasons, consider using to_ipv6_mapped instead.
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, 0xc000, 0x2ff)
);pub const fn to_ipv6_mapped(&self) -> Ipv6Addr
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, 0xffff, 0xc000, 0x2ff));Trait Implementations
impl Clone for Ipv4Addr
fn clone(&self) -> Ipv4Addr
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
impl Debug for Ipv4Addr
fn fmt(&self, fmt: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
impl Display for Ipv4Addr
fn fmt(&self, fmt: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
impl From<[u8; 4]> for Ipv4Addr
fn from(octets: [u8; 4]) -> Ipv4Addr
Creates an Ipv4Addr from a four element byte array.
Examples
use std::net::Ipv4Addr; let addr = Ipv4Addr::from([13u8, 12u8, 11u8, 10u8]); assert_eq!(Ipv4Addr::new(13, 12, 11, 10), addr);
impl From<Ipv4Addr> for IpAddr
fn from(ipv4: Ipv4Addr) -> IpAddr
Copies this address to a new IpAddr::V4.
Examples
use std::net::{IpAddr, Ipv4Addr};
let addr = Ipv4Addr::new(127, 0, 0, 1);
assert_eq!(
IpAddr::V4(addr),
IpAddr::from(addr)
)impl From<Ipv4Addr> for u32
fn from(ip: Ipv4Addr) -> u32
Converts an Ipv4Addr into a host byte order u32.
Examples
use std::net::Ipv4Addr; let addr = Ipv4Addr::new(0xca, 0xfe, 0xba, 0xbe); assert_eq!(0xcafebabe, u32::from(addr));
impl From<u32> for Ipv4Addr
fn from(ip: u32) -> Ipv4Addr
Converts a host byte order u32 into an Ipv4Addr.
Examples
use std::net::Ipv4Addr; let addr = Ipv4Addr::from(0xcafebabe); assert_eq!(Ipv4Addr::new(0xca, 0xfe, 0xba, 0xbe), addr);
impl FromStr for Ipv4Addr
type Err = AddrParseError
The associated error which can be returned from parsing.
fn from_str(s: &str) -> Result<Ipv4Addr, AddrParseError>
Parses a string s to return a value of this type. Read more
impl Hash for Ipv4Addr
fn hash<H: Hasher>(&self, s: &mut H)
impl Ord for Ipv4Addr
fn cmp(&self, other: &Ipv4Addr) -> Ordering
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
fn clamp(self, min: Self, max: Self) -> Self
Restrict a value to a certain interval. Read more
impl PartialEq<IpAddr> for Ipv4Addr
fn eq(&self, other: &IpAddr) -> bool
This method tests for self and other values to be equal, and is used by ==. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=.
impl PartialEq<Ipv4Addr> for Ipv4Addr
fn eq(&self, other: &Ipv4Addr) -> bool
This method tests for self and other values to be equal, and is used by ==. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=.
impl PartialEq<Ipv4Addr> for IpAddr
fn eq(&self, other: &Ipv4Addr) -> bool
This method tests for self and other values to be equal, and is used by ==. Read more
fn ne(&self, other: &Rhs) -> bool
This method tests for !=.
impl PartialOrd<IpAddr> for Ipv4Addr
fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering>
This method returns an ordering between self and other values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self and other) and is used by the < operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self and other) and is used by the > operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
impl PartialOrd<Ipv4Addr> for Ipv4Addr
fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering>
This method returns an ordering between self and other values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self and other) and is used by the < operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self and other) and is used by the > operator. Read more
fn ge(&self, other: &Rhs) -> bool
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
fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering>
This method returns an ordering between self and other values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self and other) and is used by the < operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self and other) and is used by the > operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
impl Copy for Ipv4Addr
impl Eq for Ipv4Addr
Auto Trait Implementations
impl RefUnwindSafe for Ipv4Addr
impl Send for Ipv4Addr
impl Sync for Ipv4Addr
impl Unpin for Ipv4Addr
impl UnwindSafe for Ipv4Addr
Blanket Implementations
impl<T> From<T> for T
pub fn from(t: T) -> T
Performs the conversion.
pub fn into(self) -> U
Performs the conversion.
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
toowned_clone_into #41263)recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/net/struct.Ipv4Addr.html