Struct ipnetwork::Ipv4Network
source · pub struct Ipv4Network { /* private fields */ }
Expand description
Represents a network range where the IP addresses are of v4
Implementations§
source§impl 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 ⓘ
pub fn iter(self) -> Ipv4NetworkIterator ⓘ
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§
source§impl Clone for Ipv4Network
impl Clone for Ipv4Network
source§fn clone(&self) -> Ipv4Network
fn clone(&self) -> Ipv4Network
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for Ipv4Network
impl Debug for Ipv4Network
source§impl<'de> Deserialize<'de> for Ipv4Network
impl<'de> Deserialize<'de> for Ipv4Network
source§fn 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>,
source§impl Display for Ipv4Network
impl Display for Ipv4Network
source§impl From<Ipv4Addr> for Ipv4Network
impl From<Ipv4Addr> for Ipv4Network
source§fn from(a: Ipv4Addr) -> Ipv4Network
fn from(a: Ipv4Addr) -> Ipv4Network
source§impl From<Ipv4Network> for IpNetwork
impl From<Ipv4Network> for IpNetwork
source§fn from(v4: Ipv4Network) -> IpNetwork
fn from(v4: Ipv4Network) -> IpNetwork
source§impl 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());
source§impl Hash for Ipv4Network
impl Hash for Ipv4Network
source§impl IntoIterator for &Ipv4Network
impl IntoIterator for &Ipv4Network
source§impl Ord for Ipv4Network
impl Ord for Ipv4Network
source§fn cmp(&self, other: &Ipv4Network) -> Ordering
fn cmp(&self, other: &Ipv4Network) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for Ipv4Network
impl PartialEq for Ipv4Network
source§impl PartialOrd for Ipv4Network
impl PartialOrd for Ipv4Network
source§impl Serialize for Ipv4Network
impl Serialize for Ipv4Network
source§impl TryFrom<&str> for Ipv4Network
impl TryFrom<&str> for Ipv4Network
impl Copy for Ipv4Network
impl Eq for Ipv4Network
impl StructuralPartialEq for Ipv4Network
Auto Trait Implementations§
impl Freeze for Ipv4Network
impl RefUnwindSafe for Ipv4Network
impl Send for Ipv4Network
impl Sync for Ipv4Network
impl Unpin for Ipv4Network
impl UnwindSafe for Ipv4Network
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)