Enum std::net::IpAddr 1.7.0[−][src]
An IP address, either IPv4 or IPv6.
This enum can contain either an Ipv4Addr or an Ipv6Addr, see their
respective documentation for more details.
The size of an IpAddr instance may vary depending on the target operating
system.
Examples
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr}; let localhost_v4 = IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)); let localhost_v6 = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)); assert_eq!("127.0.0.1".parse(), Ok(localhost_v4)); assert_eq!("::1".parse(), Ok(localhost_v6)); assert_eq!(localhost_v4.is_ipv6(), false); assert_eq!(localhost_v4.is_ipv4(), true);Run
Variants
V4(Ipv4Addr)An IPv4 address.
V6(Ipv6Addr)An IPv6 address.
Methods
impl IpAddr[src]
impl IpAddrpub fn is_unspecified(&self) -> bool1.12.0[src]
pub fn is_unspecified(&self) -> boolReturns true for the special 'unspecified' address.
See the documentation for Ipv4Addr::is_unspecified and
Ipv6Addr::is_unspecified for more details.
Examples
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr}; assert_eq!(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)).is_unspecified(), true); assert_eq!(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)).is_unspecified(), true);Run
pub fn is_loopback(&self) -> bool1.12.0[src]
pub fn is_loopback(&self) -> boolReturns true if this is a loopback address.
See the documentation for Ipv4Addr::is_loopback and
Ipv6Addr::is_loopback for more details.
Examples
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr}; assert_eq!(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)).is_loopback(), true); assert_eq!(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1)).is_loopback(), true);Run
pub fn is_global(&self) -> bool[src]
pub fn is_global(&self) -> bool🔬 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 the documentation for Ipv4Addr::is_global and
Ipv6Addr::is_global for more details.
Examples
#![feature(ip)] use std::net::{IpAddr, Ipv4Addr, Ipv6Addr}; fn main() { assert_eq!(IpAddr::V4(Ipv4Addr::new(80, 9, 12, 3)).is_global(), true); assert_eq!(IpAddr::V6(Ipv6Addr::new(0, 0, 0x1c9, 0, 0, 0xafc8, 0, 0x1)).is_global(), true); }Run
pub fn is_multicast(&self) -> bool1.12.0[src]
pub fn is_multicast(&self) -> boolReturns true if this is a multicast address.
See the documentation for Ipv4Addr::is_multicast and
Ipv6Addr::is_multicast for more details.
Examples
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr}; assert_eq!(IpAddr::V4(Ipv4Addr::new(224, 254, 0, 0)).is_multicast(), true); assert_eq!(IpAddr::V6(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0)).is_multicast(), true);Run
pub fn is_documentation(&self) -> bool[src]
pub fn is_documentation(&self) -> bool🔬 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 in a range designated for documentation.
See the documentation for Ipv4Addr::is_documentation and
Ipv6Addr::is_documentation for more details.
Examples
#![feature(ip)] use std::net::{IpAddr, Ipv4Addr, Ipv6Addr}; fn main() { assert_eq!(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 6)).is_documentation(), true); assert_eq!(IpAddr::V6(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0)) .is_documentation(), true); }Run
pub fn is_ipv4(&self) -> bool1.16.0[src]
pub fn is_ipv4(&self) -> boolReturns true if this address is an IPv4 address, and false otherwise.
Examples
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr}; fn main() { assert_eq!(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 6)).is_ipv4(), true); assert_eq!(IpAddr::V6(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0)).is_ipv4(), false); }Run
pub fn is_ipv6(&self) -> bool1.16.0[src]
pub fn is_ipv6(&self) -> boolReturns true if this address is an IPv6 address, and false otherwise.
Examples
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr}; fn main() { assert_eq!(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 6)).is_ipv6(), false); assert_eq!(IpAddr::V6(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0)).is_ipv6(), true); }Run
Trait Implementations
impl Copy for IpAddr[src]
impl Copy for IpAddrimpl Clone for IpAddr[src]
impl Clone for IpAddrfn clone(&self) -> IpAddr[src]
fn clone(&self) -> IpAddrReturns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src]
fn clone_from(&mut self, source: &Self)Performs copy-assignment from source. Read more
impl Eq for IpAddr[src]
impl Eq for IpAddrimpl PartialEq for IpAddr[src]
impl PartialEq for IpAddrfn eq(&self, other: &IpAddr) -> bool[src]
fn eq(&self, other: &IpAddr) -> boolThis method tests for self and other values to be equal, and is used by ==. Read more
fn ne(&self, other: &IpAddr) -> bool[src]
fn ne(&self, other: &IpAddr) -> boolThis method tests for !=.
impl Debug for IpAddr[src]
impl Debug for IpAddrfn fmt(&self, f: &mut Formatter) -> Result[src]
fn fmt(&self, f: &mut Formatter) -> ResultFormats the value using the given formatter. Read more
impl Hash for IpAddr[src]
impl Hash for IpAddrfn hash<__H: Hasher>(&self, state: &mut __H)[src]
fn hash<__H: Hasher>(&self, state: &mut __H)Feeds this value into the given [Hasher]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher, 1.3.0[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher, Feeds a slice of this type into the given [Hasher]. Read more
impl PartialOrd for IpAddr[src]
impl PartialOrd for IpAddrfn partial_cmp(&self, other: &IpAddr) -> Option<Ordering>[src]
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: &IpAddr) -> bool[src]
fn lt(&self, other: &IpAddr) -> boolThis method tests less than (for self and other) and is used by the < operator. Read more
fn le(&self, other: &IpAddr) -> bool[src]
fn le(&self, other: &IpAddr) -> boolThis method tests less than or equal to (for self and other) and is used by the <= operator. Read more
fn gt(&self, other: &IpAddr) -> bool[src]
fn gt(&self, other: &IpAddr) -> boolThis method tests greater than (for self and other) and is used by the > operator. Read more
fn ge(&self, other: &IpAddr) -> bool[src]
fn ge(&self, other: &IpAddr) -> boolThis method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
impl Ord for IpAddr[src]
impl Ord for IpAddrfn cmp(&self, other: &IpAddr) -> Ordering[src]
fn cmp(&self, other: &IpAddr) -> OrderingThis method returns an Ordering between self and other. Read more
fn max(self, other: Self) -> Self1.21.0[src]
fn max(self, other: Self) -> SelfCompares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self1.21.0[src]
fn min(self, other: Self) -> SelfCompares and returns the minimum of two values. Read more
impl Display for IpAddr[src]
impl Display for IpAddrfn fmt(&self, fmt: &mut Formatter) -> Result[src]
fn fmt(&self, fmt: &mut Formatter) -> ResultFormats the value using the given formatter. Read more
impl From<Ipv4Addr> for IpAddr1.16.0[src]
impl From<Ipv4Addr> for IpAddrimpl From<Ipv6Addr> for IpAddr1.16.0[src]
impl From<Ipv6Addr> for IpAddrimpl PartialEq<Ipv4Addr> for IpAddr1.16.0[src]
impl PartialEq<Ipv4Addr> for IpAddrfn eq(&self, other: &Ipv4Addr) -> bool[src]
fn eq(&self, other: &Ipv4Addr) -> boolThis method tests for self and other values to be equal, and is used by ==. Read more
#[must_use]
fn ne(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]
fn ne(&self, other: &Rhs) -> boolThis method tests for !=.
impl PartialEq<IpAddr> for Ipv4Addr1.16.0[src]
impl PartialEq<IpAddr> for Ipv4Addrfn eq(&self, other: &IpAddr) -> bool[src]
fn eq(&self, other: &IpAddr) -> boolThis method tests for self and other values to be equal, and is used by ==. Read more
#[must_use]
fn ne(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]
fn ne(&self, other: &Rhs) -> boolThis method tests for !=.
impl PartialOrd<Ipv4Addr> for IpAddr1.16.0[src]
impl PartialOrd<Ipv4Addr> for IpAddrfn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering>[src]
fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering>This method returns an ordering between self and other values if one exists. Read more
#[must_use]
fn lt(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]
fn lt(&self, other: &Rhs) -> boolThis method tests less than (for self and other) and is used by the < operator. Read more
#[must_use]
fn le(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]
fn le(&self, other: &Rhs) -> boolThis 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) -> bool1.0.0[src]
#[must_use]
fn gt(&self, other: &Rhs) -> boolThis method tests greater than (for self and other) and is used by the > operator. Read more
#[must_use]
fn ge(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]
fn ge(&self, other: &Rhs) -> boolThis method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
impl PartialOrd<IpAddr> for Ipv4Addr1.16.0[src]
impl PartialOrd<IpAddr> for Ipv4Addrfn partial_cmp(&self, other: &IpAddr) -> Option<Ordering>[src]
fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering>This method returns an ordering between self and other values if one exists. Read more
#[must_use]
fn lt(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]
fn lt(&self, other: &Rhs) -> boolThis method tests less than (for self and other) and is used by the < operator. Read more
#[must_use]
fn le(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]
fn le(&self, other: &Rhs) -> boolThis 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) -> bool1.0.0[src]
#[must_use]
fn gt(&self, other: &Rhs) -> boolThis method tests greater than (for self and other) and is used by the > operator. Read more
#[must_use]
fn ge(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]
fn ge(&self, other: &Rhs) -> boolThis method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
impl From<[u8; 4]> for IpAddr1.17.0[src]
impl From<[u8; 4]> for IpAddrimpl PartialEq<IpAddr> for Ipv6Addr1.16.0[src]
impl PartialEq<IpAddr> for Ipv6Addrfn eq(&self, other: &IpAddr) -> bool[src]
fn eq(&self, other: &IpAddr) -> boolThis method tests for self and other values to be equal, and is used by ==. Read more
#[must_use]
fn ne(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]
fn ne(&self, other: &Rhs) -> boolThis method tests for !=.
impl PartialEq<Ipv6Addr> for IpAddr1.16.0[src]
impl PartialEq<Ipv6Addr> for IpAddrfn eq(&self, other: &Ipv6Addr) -> bool[src]
fn eq(&self, other: &Ipv6Addr) -> boolThis method tests for self and other values to be equal, and is used by ==. Read more
#[must_use]
fn ne(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]
fn ne(&self, other: &Rhs) -> boolThis method tests for !=.
impl PartialOrd<Ipv6Addr> for IpAddr1.16.0[src]
impl PartialOrd<Ipv6Addr> for IpAddrfn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering>[src]
fn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering>This method returns an ordering between self and other values if one exists. Read more
#[must_use]
fn lt(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]
fn lt(&self, other: &Rhs) -> boolThis method tests less than (for self and other) and is used by the < operator. Read more
#[must_use]
fn le(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]
fn le(&self, other: &Rhs) -> boolThis 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) -> bool1.0.0[src]
#[must_use]
fn gt(&self, other: &Rhs) -> boolThis method tests greater than (for self and other) and is used by the > operator. Read more
#[must_use]
fn ge(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]
fn ge(&self, other: &Rhs) -> boolThis method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
impl PartialOrd<IpAddr> for Ipv6Addr1.16.0[src]
impl PartialOrd<IpAddr> for Ipv6Addrfn partial_cmp(&self, other: &IpAddr) -> Option<Ordering>[src]
fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering>This method returns an ordering between self and other values if one exists. Read more
#[must_use]
fn lt(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]
fn lt(&self, other: &Rhs) -> boolThis method tests less than (for self and other) and is used by the < operator. Read more
#[must_use]
fn le(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]
fn le(&self, other: &Rhs) -> boolThis 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) -> bool1.0.0[src]
#[must_use]
fn gt(&self, other: &Rhs) -> boolThis method tests greater than (for self and other) and is used by the > operator. Read more
#[must_use]
fn ge(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]
fn ge(&self, other: &Rhs) -> boolThis method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
impl From<[u8; 16]> for IpAddr1.17.0[src]
impl From<[u8; 16]> for IpAddrfn from(octets: [u8; 16]) -> IpAddr[src]
fn from(octets: [u8; 16]) -> IpAddrCreate an IpAddr::V6 from a sixteen element byte array.
Examples
use std::net::{IpAddr, Ipv6Addr}; let addr = IpAddr::from([ 25u8, 24u8, 23u8, 22u8, 21u8, 20u8, 19u8, 18u8, 17u8, 16u8, 15u8, 14u8, 13u8, 12u8, 11u8, 10u8, ]); assert_eq!( IpAddr::V6(Ipv6Addr::new( 0x1918, 0x1716, 0x1514, 0x1312, 0x1110, 0x0f0e, 0x0d0c, 0x0b0a )), addr );Run
impl From<[u16; 8]> for IpAddr1.17.0[src]
impl From<[u16; 8]> for IpAddrfn from(segments: [u16; 8]) -> IpAddr[src]
fn from(segments: [u16; 8]) -> IpAddrCreate an IpAddr::V6 from an eight element 16-bit array.
Examples
use std::net::{IpAddr, Ipv6Addr}; let addr = IpAddr::from([ 525u16, 524u16, 523u16, 522u16, 521u16, 520u16, 519u16, 518u16, ]); assert_eq!( IpAddr::V6(Ipv6Addr::new( 0x20d, 0x20c, 0x20b, 0x20a, 0x209, 0x208, 0x207, 0x206 )), addr );Run
impl FromStr for IpAddr[src]
impl FromStr for IpAddrtype Err = AddrParseError
The associated error which can be returned from parsing.
fn from_str(s: &str) -> Result<IpAddr, AddrParseError>[src]
fn from_str(s: &str) -> Result<IpAddr, AddrParseError>Parses a string s to return a value of this type. Read more