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.
Ipv4Addr
provides a FromStr
implementation. The four octets are in decimal notation, divided by .
(this is called "dot-decimal notation").
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);
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
.
use std::net::Ipv4Addr; let addr = Ipv4Addr::new(127, 0, 0, 1);
pub const LOCALHOST: Self
[src]An IPv4 address with the address pointing to localhost: 127.0.0.1.
use std::net::Ipv4Addr; let addr = Ipv4Addr::LOCALHOST; assert_eq!(addr, Ipv4Addr::new(127, 0, 0, 1));
pub const UNSPECIFIED: Self
[src]An IPv4 address representing an unspecified address: 0.0.0.0
use std::net::Ipv4Addr; let addr = Ipv4Addr::UNSPECIFIED; assert_eq!(addr, Ipv4Addr::new(0, 0, 0, 0));
pub const BROADCAST: Self
[src]An IPv4 address representing the broadcast address: 255.255.255.255
use std::net::Ipv4Addr; let addr = Ipv4Addr::BROADCAST; assert_eq!(addr, Ipv4Addr::new(255, 255, 255, 255));
pub fn octets(&self) -> [u8; 4]
[src]Returns the four eight-bit integers that make up this address.
use std::net::Ipv4Addr; let addr = Ipv4Addr::new(127, 0, 0, 1); assert_eq!(addr.octets(), [127, 0, 0, 1]);
pub fn is_unspecified(&self) -> bool
[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.
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 fn is_loopback(&self) -> bool
[src]Returns true
if this is a loopback address (127.0.0.0/8).
This property is defined by IETF RFC 1122.
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 fn is_private(&self) -> bool
[src]Returns true
if this is a private address.
The private address ranges are defined in IETF RFC 1918 and include:
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 fn is_link_local(&self) -> bool
[src]Returns true
if the address is link-local (169.254.0.0/16).
This property is defined by IETF RFC 3927.
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
[src]Returns true
if the address appears to be globally routable. See iana-ipv4-special-registry.
The following return false:
#![feature(ip)] use std::net::Ipv4Addr; fn main() { 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); assert_eq!(Ipv4Addr::new(0, 0, 0, 0).is_global(), false); assert_eq!(Ipv4Addr::new(80, 9, 12, 3).is_global(), true); }
pub fn is_multicast(&self) -> bool
[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.
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 fn is_broadcast(&self) -> bool
[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.
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 fn is_documentation(&self) -> bool
[src]Returns true
if this address is in a range designated for documentation.
This is defined in IETF RFC 5737:
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 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
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));
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
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));
impl Copy for Ipv4Addr
[src]impl From<Ipv4Addr> for IpAddr
[src]impl Display for Ipv4Addr
[src]fn fmt(&self, fmt: &mut Formatter) -> Result
[src]Formats the value using the given formatter. Read more
impl Debug for Ipv4Addr
[src]fn fmt(&self, fmt: &mut Formatter) -> Result
[src]Formats the value using the given formatter. Read more
impl Clone for Ipv4Addr
[src]fn clone(&self) -> Ipv4Addr
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
[src]Performs copy-assignment from source
. Read more
impl PartialEq for Ipv4Addr
[src]fn eq(&self, other: &Ipv4Addr) -> bool
[src]This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
[src]This method tests for !=
.
impl PartialEq<Ipv4Addr> for IpAddr
[src]fn eq(&self, other: &Ipv4Addr) -> bool
[src]This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
[src]This method tests for !=
.
impl PartialEq<IpAddr> for Ipv4Addr
[src]fn eq(&self, other: &IpAddr) -> bool
[src]This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
[src]This method tests for !=
.
impl Eq for Ipv4Addr
[src]impl Hash for Ipv4Addr
[src]fn hash<H:Â Hasher>(&self, s: &mut H)
[src]Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher,Â
[src]Feeds a slice of this type into the given [Hasher
]. Read more
impl PartialOrd for Ipv4Addr
[src]fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
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
fn gt(&self, other: &Rhs) -> bool
[src]This method tests greater than (for self
and other
) and is used by the >
operator. Read more
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
[src]fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
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
fn gt(&self, other: &Rhs) -> bool
[src]This method tests greater than (for self
and other
) and is used by the >
operator. Read more
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
[src]fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
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
fn gt(&self, other: &Rhs) -> bool
[src]This method tests greater than (for self
and other
) and is used by the >
operator. Read more
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 Ord for Ipv4Addr
[src]fn cmp(&self, other: &Ipv4Addr) -> Ordering
[src]This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
[src]Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
[src]Compares and returns the minimum of two values. Read more
impl From<Ipv4Addr> for u32
[src]fn from(ip: Ipv4Addr) -> u32
[src]Convert an Ipv4Addr
into a host byte order u32
.
use std::net::Ipv4Addr; let addr = Ipv4Addr::new(13, 12, 11, 10); assert_eq!(0x0d0c0b0au32, u32::from(addr));
impl From<u32> for Ipv4Addr
[src]fn from(ip: u32) -> Ipv4Addr
[src]Convert a host byte order u32
into an Ipv4Addr
.
use std::net::Ipv4Addr; let addr = Ipv4Addr::from(0x0d0c0b0au32); assert_eq!(Ipv4Addr::new(13, 12, 11, 10), addr);
impl From<[u8; 4]> for Ipv4Addr
[src]fn from(octets: [u8; 4]) -> Ipv4Addr
[src]use std::net::Ipv4Addr; let addr = Ipv4Addr::from([13u8, 12u8, 11u8, 10u8]); assert_eq!(Ipv4Addr::new(13, 12, 11, 10), addr);
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]Parses a string s
to return a value of this type. Read more
impl<T, U> TryFrom for T where
    T: From<U>,Â
[src]type Error = !
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]Performs the conversion.
impl<T> From for T
[src]impl<T, U> TryInto for T where
    U: TryFrom<T>,Â
[src]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]Performs the conversion.
impl<T, U> Into for T where
    U: From<T>,Â
[src]impl<T> Borrow for T where
    T: ?Sized,Â
[src]fn borrow(&self) -> &T
[src]impl<'a, I> Iterator for &'a mut I where     I: Iterator + ?Sized, type Item = <I as Iterator>::Item; impl<'a, R: Read + ?Sized> Read for &'a mut R impl<'a, W: Write + ?Sized> Write for &'a mut W
Immutably borrows from an owned value. Read more
impl<T> BorrowMut for T where
    T: ?Sized,Â
[src]fn borrow_mut(&mut self) -> &mut T
[src]impl<'a, I> Iterator for &'a mut I where     I: Iterator + ?Sized, type Item = <I as Iterator>::Item; impl<'a, R: Read + ?Sized> Read for &'a mut R impl<'a, W: Write + ?Sized> Write for &'a mut W
Mutably borrows from an owned value. Read more
impl<T> Any for T where
    T: 'static + ?Sized,Â
[src]fn get_type_id(&self) -> TypeId
[src]Gets the TypeId
of self
. Read more
impl<T> ToOwned for T where
    T: Clone,Â
[src]type Owned = T
fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
fn clone_into(&self, target: &mut T)
[src]Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> ToString for T where
    T: Display + ?Sized,Â
[src]
© 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