# Enum ipnet::IpNet [−] [src]

    pub enum IpNet {
        V4(Ipv4Net),
        V6(Ipv6Net),
    }

An IP network address, either IPv4 or IPv6.

This enum can contain either an `Ipv4Net` or an `Ipv6Net`. A `From` implementation is provided to convert these into an `IpNet`.

# Textual representation

`IpNet` provides a `FromStr` implementation for parsing network addresses represented in CIDR notation. See IETF RFC 4632 for the CIDR notation.

# Examples

    use std::net::IpAddr;
    use ipnet::IpNet;

    let net: IpNet = "10.1.1.0/24".parse().unwrap();
    assert_eq!(Ok(net.network()), "10.1.1.0".parse());

    let net: IpNet = "fd00::/32".parse().unwrap();
    assert_eq!(Ok(net.network()), "fd00::".parse());

## Variants

`V4(Ipv4Net)`
`V6(Ipv6Net)`

## Implementations

### `impl IpNet` [src]

#### `pub fn trunc(&self) -> IpNet` [src]

Returns a copy of the network with the address truncated to the prefix length.

# Examples

    assert_eq!(
        "192.168.12.34/16".parse::<IpNet>().unwrap().trunc(),
        "192.168.0.0/16".parse().unwrap()
    );

    assert_eq!(
        "fd00::1:2:3:4/16".parse::<IpNet>().unwrap().trunc(),
        "fd00::/16".parse().unwrap()
    );

#### `pub fn addr(&self) -> IpAddr` [src]

Returns the address.

#### `pub fn prefix_len(&self) -> u8` [src]

Returns the prefix length.

#### `pub fn max_prefix_len(&self) -> u8` [src]

Returns the maximum valid prefix length.

#### `pub fn netmask(&self) -> IpAddr` [src]

Returns the network mask.

# Examples

    let net: IpNet = "10.1.0.0/20".parse().unwrap();
    assert_eq!(Ok(net.netmask()), "255.255.240.0".parse());

    let net: IpNet = "fd00::/24".parse().unwrap();
    assert_eq!(Ok(net.netmask()), "ffff:ff00::".parse());

#### `pub fn hostmask(&self) -> IpAddr` [src]

Returns the host mask.

# Examples

    let net: IpNet = "10.1.0.0/20".parse().unwrap();
    assert_eq!(Ok(net.hostmask()), "0.0.15.255".parse());

    let net: IpNet = "fd00::/24".parse().unwrap();
    assert_eq!(Ok(net.hostmask()), "::ff:ffff:ffff:ffff:ffff:ffff:ffff".parse());

#### `pub fn network(&self) -> IpAddr` [src]

Returns the network address.

# Examples

    let net: IpNet = "172.16.123.123/16".parse().unwrap();
    assert_eq!(Ok(net.network()), "172.16.0.0".parse());

    let net: IpNet = "fd00:1234:5678::/24".parse().unwrap();
    assert_eq!(Ok(net.network()), "fd00:1200::".parse());

#### `pub fn broadcast(&self) -> IpAddr` [src]

Returns the broadcast address.

# Examples

    let net: IpNet = "172.16.0.0/22".parse().unwrap();
    assert_eq!(Ok(net.broadcast()), "172.16.3.255".parse());

    let net: IpNet = "fd00:1234:5678::/24".parse().unwrap();
    assert_eq!(Ok(net.broadcast()), "fd00:12ff:ffff:ffff:ffff:ffff:ffff:ffff".parse());

#### `pub fn supernet(&self) -> Option<IpNet>` [src]

Returns the `IpNet` that contains this one.

# Examples

    let n1: IpNet = "172.16.1.0/24".parse().unwrap();
    let n2: IpNet = "172.16.0.0/23".parse().unwrap();
    let n3: IpNet = "172.16.0.0/0".parse().unwrap();

    assert_eq!(n1.supernet().unwrap(), n2);
    assert_eq!(n3.supernet(), None);

    let n1: IpNet = "fd00:ff00::/24".parse().unwrap();
    let n2: IpNet = "fd00:fe00::/23".parse().unwrap();
    let n3: IpNet = "fd00:fe00::/0".parse().unwrap();

    assert_eq!(n1.supernet().unwrap(), n2);
    assert_eq!(n3.supernet(), None);

#### `pub fn is_sibling(&self, other: &IpNet) -> bool` [src]

Returns `true` if this network and the given network are children of the same supernet.

# Examples

    let n4_1: IpNet = "10.1.0.0/24".parse().unwrap();
    let n4_2: IpNet = "10.1.1.0/24".parse().unwrap();
    let n4_3: IpNet = "10.1.2.0/24".parse().unwrap();
    let n6_1: IpNet = "fd00::/18".parse().unwrap();
    let n6_2: IpNet = "fd00:4000::/18".parse().unwrap();
    let n6_3: IpNet = "fd00:8000::/18".parse().unwrap();

    assert!( n4_1.is_sibling(&n4_2));
    assert!(!n4_2.is_sibling(&n4_3));
    assert!( n6_1.is_sibling(&n6_2));
    assert!(!n6_2.is_sibling(&n6_3));
    assert!(!n4_1.is_sibling(&n6_2));

#### `pub fn hosts(&self) -> IpAddrRangeⓘ

### Notable traits for IpAddrRange

`impl Iterator for IpAddrRange type Item = IpAddr;`
` [src]

Return an `Iterator` over the host addresses in this network.

# Examples

    let net: IpNet = "10.0.0.0/30".parse().unwrap();
    assert_eq!(net.hosts().collect::<Vec<IpAddr>>(), vec![
        "10.0.0.1".parse::<IpAddr>().unwrap(),
        "10.0.0.2".parse().unwrap(),
    ]);

    let net: IpNet = "10.0.0.0/31".parse().unwrap();
    assert_eq!(net.hosts().collect::<Vec<IpAddr>>(), vec![
        "10.0.0.0".parse::<IpAddr>().unwrap(),
        "10.0.0.1".parse().unwrap(),
    ]);

    let net: IpNet = "fd00::/126".parse().unwrap();
    assert_eq!(net.hosts().collect::<Vec<IpAddr>>(), vec![
        "fd00::".parse::<IpAddr>().unwrap(),
        "fd00::1".parse().unwrap(),
        "fd00::2".parse().unwrap(),
        "fd00::3".parse().unwrap(),
    ]);

#### `pub fn subnets(&self, new_prefix_len: u8) -> Result<IpSubnets, PrefixLenError>` [src]

Returns an `Iterator` over the subnets of this network with the given prefix length.

# Examples

    let net: IpNet = "10.0.0.0/24".parse().unwrap();
    assert_eq!(net.subnets(26).unwrap().collect::<Vec<IpNet>>(), vec![
        "10.0.0.0/26".parse::<IpNet>().unwrap(),
        "10.0.0.64/26".parse().unwrap(),
        "10.0.0.128/26".parse().unwrap(),
        "10.0.0.192/26".parse().unwrap(),
    ]);

    let net: IpNet = "fd00::/16".parse().unwrap();
    assert_eq!(net.subnets(18).unwrap().collect::<Vec<IpNet>>(), vec![
        "fd00::/18".parse::<IpNet>().unwrap(),
        "fd00:4000::/18".parse().unwrap(),
        "fd00:8000::/18".parse().unwrap(),
        "fd00:c000::/18".parse().unwrap(),
    ]);

    let net: IpNet = "10.0.0.0/24".parse().unwrap();
    assert_eq!(net.subnets(23), Err(PrefixLenError));

    let net: IpNet = "10.0.0.0/24".parse().unwrap();
    assert_eq!(net.subnets(33), Err(PrefixLenError));

    let net: IpNet = "fd00::/16".parse().unwrap();
    assert_eq!(net.subnets(15), Err(PrefixLenError));

    let net: IpNet = "fd00::/16".parse().unwrap();
    assert_eq!(net.subnets(129), Err(PrefixLenError));

#### `pub fn contains<T>(&self, other: T) -> bool where
Self: Contains<T>,` [src]

Test if a network address contains either another network address or an IP address.

# Examples

    let net4: IpNet = "192.168.0.0/24".parse().unwrap();
    let net4_yes: IpNet = "192.168.0.0/25".parse().unwrap();
    let net4_no: IpNet = "192.168.0.0/23".parse().unwrap();
    let ip4_yes: IpAddr = "192.168.0.1".parse().unwrap();
    let ip4_no: IpAddr = "192.168.1.0".parse().unwrap();

    assert!(net4.contains(&net4));
    assert!(net4.contains(&net4_yes));
    assert!(!net4.contains(&net4_no));
    assert!(net4.contains(&ip4_yes));
    assert!(!net4.contains(&ip4_no));

    let net6: IpNet = "fd00::/16".parse().unwrap();
    let net6_yes: IpNet = "fd00::/17".parse().unwrap();
    let net6_no: IpNet = "fd00::/15".parse().unwrap();
    let ip6_yes: IpAddr = "fd00::1".parse().unwrap();
    let ip6_no: IpAddr = "fd01::".parse().unwrap();

    assert!(net6.contains(&net6));
    assert!(net6.contains(&net6_yes));
    assert!(!net6.contains(&net6_no));
    assert!(net6.contains(&ip6_yes));
    assert!(!net6.contains(&ip6_no));

    assert!(!net4.contains(&net6));
    assert!(!net6.contains(&net4));
    assert!(!net4.contains(&ip6_no));
    assert!(!net6.contains(&ip4_no));

#### `pub fn aggregate(networks: &Vec<IpNet>) -> Vec<IpNet>` [src]

Aggregate a `Vec` of `IpNet`s and return the result as a new `Vec`.

# Examples

    let nets = vec![
        "10.0.0.0/24".parse::<IpNet>().unwrap(),
        "10.0.1.0/24".parse().unwrap(),
        "10.0.2.0/24".parse().unwrap(),
        "fd00::/18".parse().unwrap(),
        "fd00:4000::/18".parse().unwrap(),
        "fd00:8000::/18".parse().unwrap(),
    ];

    assert_eq!(IpNet::aggregate(&nets), vec![
        "10.0.0.0/23".parse::<IpNet>().unwrap(),
        "10.0.2.0/24".parse().unwrap(),
        "fd00::/17".parse().unwrap(),
        "fd00:8000::/18".parse().unwrap(),
    ]);

## Trait Implementations

### `impl Clone for IpNet` [src]

#### `fn clone(&self) -> IpNet` [src]

Returns a copy of the value. Read more

#### `pub fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

### `impl Copy for IpNet` [src]

### `impl Debug for IpNet` [src]

#### `fn fmt(&self, fmt: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl Default for IpNet` [src]

#### `fn default() -> Self` [src]

Returns the “default value” for a type. Read more

### `impl Display for IpNet` [src]

#### `fn fmt(&self, fmt: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl Eq for IpNet` [src]

### `impl From<IpAddr> for IpNet` [src]

#### `fn from(addr: IpAddr) -> IpNet` [src]

Performs the conversion.

### `impl From<Ipv4Net> for IpNet` [src]

#### `fn from(net: Ipv4Net) -> IpNet` [src]

Performs the conversion.

### `impl From<Ipv6Net> for IpNet` [src]

#### `fn from(net: Ipv6Net) -> IpNet` [src]

Performs the conversion.

### `impl FromStr for IpNet` [src]

#### `type Err = AddrParseError`

The associated error which can be returned from parsing.

#### `fn from_str(s: &str) -> Result<IpNet, AddrParseError>` [src]

Parses a string `s` to return a value of this type. Read more

### `impl Hash for IpNet` [src]

#### `fn hash<__H: Hasher>(&self, state: &mut __H)` [src]

Feeds this value into the given `Hasher`. Read more

#### `pub 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 Ord for IpNet` [src]

#### `fn cmp(&self, other: &IpNet) -> Ordering` [src]

This method returns an `Ordering` between `self` and `other`. Read more

#### `#[must_use]pub fn max(self, other: Self) -> Self` 1.21.0 [src]

Compares and returns the maximum of two values. Read more

#### `#[must_use]pub fn min(self, other: Self) -> Self` 1.21.0 [src]

Compares and returns the minimum of two values. Read more

#### `#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self` 1.50.0 [src]

Restrict a value to a certain interval. Read more

### `impl PartialEq<IpNet> for IpNet` [src]

#### `fn eq(&self, other: &IpNet) -> bool` [src]

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

#### `fn ne(&self, other: &IpNet) -> bool` [src]

This method tests for `!=`.

### `impl PartialOrd<IpNet> for IpNet` [src]

#### `fn partial_cmp(&self, other: &IpNet) -> Option<Ordering>` [src]

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

#### `#[must_use]pub fn lt(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

#### `#[must_use]pub fn le(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

#### `#[must_use]pub fn gt(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

#### `#[must_use]pub fn ge(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

### `impl StructuralEq for IpNet` [src]

### `impl StructuralPartialEq for IpNet` [src]

## Auto Trait Implementations

### `impl RefUnwindSafe for IpNet`

### `impl Send for IpNet`

### `impl Sync for IpNet`

### `impl Unpin for IpNet`

### `impl UnwindSafe for IpNet`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T` [src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `pub fn clone_into(&self, target: &mut T)` [src]

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

recently added

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

### `impl<T> ToString for T where
T: Display + ?Sized,` [src]

#### `pub default fn to_string(&self) -> String` [src]

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

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

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

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

Performs the conversion.