std::net::Ipv4Addr - Rust
Description: API documentation for the Rust `Ipv4Addr` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, Ipv4Addr

# 1.0.0[−][src]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").

# 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`[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`[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`[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 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 address (10.0.0.0/8, 172.16.0.0/12 and 192.168.0.0/16)
- the loopback address (127.0.0.0/8)
- the link-local address (169.254.0.0/16)
- the broadcast address (255.255.255.255/32)
- test addresses used for documentation (192.0.2.0/24, 198.51.100.0/24 and 203.0.113.0/24)
- the unspecified address (0.0.0.0)

# Examples

    #![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);
    }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 Copy for Ipv4Addr`

[src]

###

`impl From<Ipv4Addr> for IpAddr`

1.16.0
[src]

####

`fn from(ipv4: Ipv4Addr) -> IpAddr`

[src]

Performs the conversion.

###

`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

####

`#[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]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

####

`#[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]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

####

`#[must_use] 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,`

1.3.0
[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

####

`#[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]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[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]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[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 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`

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

###

`impl From<Ipv4Addr> for u32`

1.1.0
[src]

####

`fn from(ip: Ipv4Addr) -> u32`

[src]

Convert an `Ipv4Addr` into a host byte order `u32`.

# Examples

    use std::net::Ipv4Addr;

    let addr = Ipv4Addr::new(13, 12, 11, 10);
    assert_eq!(0x0d0c0b0au32, u32::from(addr));Run

###

`impl From<u32> for Ipv4Addr`

1.1.0
[src]

####

`fn from(ip: u32) -> Ipv4Addr`

[src]

Convert a host byte order `u32` into an `Ipv4Addr`.

# Examples

    use std::net::Ipv4Addr;

    let addr = Ipv4Addr::from(0x0d0c0b0au32);
    assert_eq!(Ipv4Addr::new(13, 12, 11, 10), addr);Run

###

`impl From<[u8; 4]> for Ipv4Addr`

1.9.0
[src]

####

`fn from(octets: [u8; 4]) -> Ipv4Addr`

[src]

# Examples

    use std::net::Ipv4Addr;

    let addr = Ipv4Addr::from([13u8, 12u8, 11u8, 10u8]);
    assert_eq!(Ipv4Addr::new(13, 12, 11, 10), addr);Run

###

`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

## Auto Trait Implementations

###

`impl Send for Ipv4Addr`

###

`impl Sync for Ipv4Addr`

## Blanket Implementations

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

`impl<T, U> TryInto for T where U: TryFrom<T>,`

[src]

#### `type Error = <U as TryFrom<T>>::Error`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`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 Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

`impl<T> BorrowMut for T where T: ?Sized,`

[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`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 Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`fn borrow_mut(&mut self) -> &mut T`

[src]

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]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

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]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

###

`impl<T> ToString for T where T: Display + ?Sized,`

[src]

####

`fn to_string(&self) -> String`

[src]

Converts the given value to a `String`. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)