Struct ipnetwork::Ipv4Network
source · [−]pub struct Ipv4Network { /* private fields */ }
Expand description
Represents a network range where the IP addresses are of v4
Implementations
sourceimpl Ipv4Network
impl Ipv4Network
sourcepub const fn new(
addr: Ipv4Addr,
prefix: u8
) -> Result<Ipv4Network, IpNetworkError>
pub const fn new(
addr: Ipv4Addr,
prefix: u8
) -> Result<Ipv4Network, IpNetworkError>
Constructs a new Ipv4Network
from any Ipv4Addr
and a prefix denoting the network size.
If the prefix is larger than 32 this will return an IpNetworkError::InvalidPrefix
.
sourcepub fn with_netmask(
netaddr: Ipv4Addr,
netmask: Ipv4Addr
) -> Result<Ipv4Network, IpNetworkError>
pub fn with_netmask(
netaddr: Ipv4Addr,
netmask: Ipv4Addr
) -> Result<Ipv4Network, IpNetworkError>
Constructs a new Ipv4Network
from a network address and a network mask.
If the netmask is not valid this will return an IpNetworkError::InvalidPrefix
.
sourcepub fn iter(self) -> Ipv4NetworkIteratorⓘNotable traits for Ipv4NetworkIteratorimpl Iterator for Ipv4NetworkIterator type Item = Ipv4Addr;
pub fn iter(self) -> Ipv4NetworkIteratorⓘNotable traits for Ipv4NetworkIteratorimpl Iterator for Ipv4NetworkIterator type Item = Ipv4Addr;
Returns an iterator over Ipv4Network
. Each call to next
will return the next
Ipv4Addr
in the given network. None
will be returned when there are no more
addresses.
pub fn ip(self) -> Ipv4Addr
pub fn prefix(self) -> u8
sourcepub fn is_subnet_of(self, other: Ipv4Network) -> bool
pub fn is_subnet_of(self, other: Ipv4Network) -> bool
Checks if the given Ipv4Network
is a subnet of the other.
sourcepub fn is_supernet_of(self, other: Ipv4Network) -> bool
pub fn is_supernet_of(self, other: Ipv4Network) -> bool
Checks if the given Ipv4Network
is a supernet of the other.
sourcepub fn overlaps(self, other: Ipv4Network) -> bool
pub fn overlaps(self, other: Ipv4Network) -> bool
Checks if the given Ipv4Network
is partly contained in other.
sourcepub fn mask(self) -> Ipv4Addr
pub fn mask(self) -> Ipv4Addr
Returns the mask for this Ipv4Network
.
That means the prefix
most significant bits will be 1 and the rest 0
Examples
use std::net::Ipv4Addr;
use ipnetwork::Ipv4Network;
let net: Ipv4Network = "127.0.0.0".parse().unwrap();
assert_eq!(net.mask(), Ipv4Addr::new(255, 255, 255, 255));
let net: Ipv4Network = "127.0.0.0/16".parse().unwrap();
assert_eq!(net.mask(), Ipv4Addr::new(255, 255, 0, 0));
sourcepub fn network(self) -> Ipv4Addr
pub fn network(self) -> Ipv4Addr
Returns the address of the network denoted by this Ipv4Network
.
This means the lowest possible IPv4 address inside of the network.
Examples
use std::net::Ipv4Addr;
use ipnetwork::Ipv4Network;
let net: Ipv4Network = "10.1.9.32/16".parse().unwrap();
assert_eq!(net.network(), Ipv4Addr::new(10, 1, 0, 0));
sourcepub fn broadcast(self) -> Ipv4Addr
pub fn broadcast(self) -> Ipv4Addr
Returns the broadcasting address of this Ipv4Network
.
This means the highest possible IPv4 address inside of the network.
Examples
use std::net::Ipv4Addr;
use ipnetwork::Ipv4Network;
let net: Ipv4Network = "10.9.0.32/16".parse().unwrap();
assert_eq!(net.broadcast(), Ipv4Addr::new(10, 9, 255, 255));
sourcepub fn contains(self, ip: Ipv4Addr) -> bool
pub fn contains(self, ip: Ipv4Addr) -> bool
Checks if a given Ipv4Addr
is in this Ipv4Network
Examples
use std::net::Ipv4Addr;
use ipnetwork::Ipv4Network;
let net: Ipv4Network = "127.0.0.0/24".parse().unwrap();
assert!(net.contains(Ipv4Addr::new(127, 0, 0, 70)));
assert!(!net.contains(Ipv4Addr::new(127, 0, 1, 70)));
sourcepub fn size(self) -> u32
pub fn size(self) -> u32
Returns number of possible host addresses in this Ipv4Network
.
Examples
use std::net::Ipv4Addr;
use ipnetwork::Ipv4Network;
let net: Ipv4Network = "10.1.0.0/16".parse().unwrap();
assert_eq!(net.size(), 65536);
let tinynet: Ipv4Network = "0.0.0.0/32".parse().unwrap();
assert_eq!(tinynet.size(), 1);
sourcepub fn nth(self, n: u32) -> Option<Ipv4Addr>
pub fn nth(self, n: u32) -> Option<Ipv4Addr>
Returns the n
:th address within this network.
The adresses are indexed from 0 and n
must be smaller than the size of the network.
Examples
use std::net::Ipv4Addr;
use ipnetwork::Ipv4Network;
let net: Ipv4Network = "192.168.0.0/24".parse().unwrap();
assert_eq!(net.nth(0).unwrap(), Ipv4Addr::new(192, 168, 0, 0));
assert_eq!(net.nth(15).unwrap(), Ipv4Addr::new(192, 168, 0, 15));
assert!(net.nth(256).is_none());
let net2: Ipv4Network = "10.0.0.0/16".parse().unwrap();
assert_eq!(net2.nth(256).unwrap(), Ipv4Addr::new(10, 0, 1, 0));
Trait Implementations
sourceimpl Clone for Ipv4Network
impl Clone for Ipv4Network
sourcefn clone(&self) -> Ipv4Network
fn clone(&self) -> Ipv4Network
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for Ipv4Network
impl Debug for Ipv4Network
sourceimpl<'de> Deserialize<'de> for Ipv4Network
impl<'de> Deserialize<'de> for Ipv4Network
sourcefn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Display for Ipv4Network
impl Display for Ipv4Network
sourceimpl From<Ipv4Addr> for Ipv4Network
impl From<Ipv4Addr> for Ipv4Network
sourcefn from(a: Ipv4Addr) -> Ipv4Network
fn from(a: Ipv4Addr) -> Ipv4Network
Converts to this type from the input type.
sourceimpl From<Ipv4Network> for IpNetwork
impl From<Ipv4Network> for IpNetwork
sourcefn from(v4: Ipv4Network) -> IpNetwork
fn from(v4: Ipv4Network) -> IpNetwork
Converts to this type from the input type.
sourceimpl FromStr for Ipv4Network
impl FromStr for Ipv4Network
Creates an Ipv4Network
from parsing a string in CIDR notation.
Examples
use std::net::Ipv4Addr;
use ipnetwork::Ipv4Network;
let new = Ipv4Network::new(Ipv4Addr::new(10, 1, 9, 32), 16).unwrap();
let from_cidr: Ipv4Network = "10.1.9.32/16".parse().unwrap();
assert_eq!(new.ip(), from_cidr.ip());
assert_eq!(new.prefix(), from_cidr.prefix());
sourceimpl Hash for Ipv4Network
impl Hash for Ipv4Network
sourceimpl IntoIterator for &Ipv4Network
impl IntoIterator for &Ipv4Network
type IntoIter = Ipv4NetworkIterator
type IntoIter = Ipv4NetworkIterator
Which kind of iterator are we turning this into?
sourcefn into_iter(self) -> Ipv4NetworkIteratorⓘNotable traits for Ipv4NetworkIteratorimpl Iterator for Ipv4NetworkIterator type Item = Ipv4Addr;
fn into_iter(self) -> Ipv4NetworkIteratorⓘNotable traits for Ipv4NetworkIteratorimpl Iterator for Ipv4NetworkIterator type Item = Ipv4Addr;
Creates an iterator from a value. Read more
sourceimpl Ord for Ipv4Network
impl Ord for Ipv4Network
sourceimpl PartialEq<Ipv4Network> for Ipv4Network
impl PartialEq<Ipv4Network> for Ipv4Network
sourcefn eq(&self, other: &Ipv4Network) -> bool
fn eq(&self, other: &Ipv4Network) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &Ipv4Network) -> bool
fn ne(&self, other: &Ipv4Network) -> bool
This method tests for !=
.
sourceimpl PartialOrd<Ipv4Network> for Ipv4Network
impl PartialOrd<Ipv4Network> for Ipv4Network
sourcefn partial_cmp(&self, other: &Ipv4Network) -> Option<Ordering>
fn partial_cmp(&self, other: &Ipv4Network) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
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
sourceimpl Serialize for Ipv4Network
impl Serialize for Ipv4Network
sourceimpl TryFrom<&str> for Ipv4Network
impl TryFrom<&str> for Ipv4Network
impl Copy for Ipv4Network
impl Eq for Ipv4Network
impl StructuralEq for Ipv4Network
impl StructuralPartialEq for Ipv4Network
Auto Trait Implementations
impl RefUnwindSafe for Ipv4Network
impl Send for Ipv4Network
impl Sync for Ipv4Network
impl Unpin for Ipv4Network
impl UnwindSafe for Ipv4Network
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more