Struct bdrck::net::IpNet

pub struct IpNet { /* fields omitted */ }

An IpNet represents an IP network. Networks are typically identified in CIDR notation, like (for example) "192.0.0.0/24".

Methods

impl IpNet

pub fn get_ip(&self) -> IpAddr

Return the network IP. This address will have been normalized, such that any non-masked bits will have been turned off during construction.

pub fn get_mask(&self) -> &[u8]

Return the network mask, as a byte slice. This slice will always be 16 bytes long, even if this is an IPv4 network.

pub fn apply_mask(&self, ip: IpAddr, invert: bool, set: bool) -> IpAddr

Apply this network's mask to the given IP address, returning the modified copy.

The "default" behavior is when invert=false and set=false. In this case, any bits which are "0" in the mask are turned off in the given IP address' bytes.

If invert=true, then each bit in the mask is flipped before it is applied - in other words, we apply the inverse mask.

If set=true, then we switch from bitwise AND to bitwise OR, meaning instead of the behavior described above, any bits which are "1" in the mask are turned on in the IP address, and other bits are left unchanged.

pub fn get_one_bits(&self) -> usize

Returns the number of "1" bits in this network's mask. Although the mask is always 16 bytes long, for IPv4 networks only the last 4 bytes of the mask are considered.

pub fn is_canonical(&self) -> bool

Returns whether or not this network's mask is "canonical" - i.e., if all of its mask's "1" bits are contiguous (no "0" bits in-between them).

pub fn netmask(&self) -> IpAddr

Return the netmask IP address for this network.

pub fn broadcast(&self) -> IpAddr

Return the broadcast IP address for this network.

pub fn contains(&self, ip: IpAddr, strict: bool) -> bool

Return whether or not the given IP address is contained within this network. If strict=true, then the "network address" and "broadcast address" are both not considered to be "within" this network (this is useful if you want to check if the given IP address is actually usable for a host on the network).

pub fn increment_in(&self, ip: IpAddr, strict: bool) -> Option<IpAddr>

Increment the given IP address as if with increment_ip(), but returning None if the resulting IP address does not lie within this network. The "strict" parameter behaves as IpNet::contains() describes.

pub fn first(&self) -> Option<IpAddr>

Return the first IP address which falls within this network.

pub fn last(&self) -> IpAddr

Return the last non-broadcast IP address which falls within this network.

Trait Implementations

impl Clone for IpNet

fn clone(&self) -> IpNet

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for IpNet

impl Debug for IpNet

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IpNet

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for IpNet

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for IpNet

impl FromStr for IpNet

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Hash for IpNet

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<IpNet> for IpNet

fn eq(&self, other: &IpNet) -> bool

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

fn ne(&self, other: &IpNet) -> bool

This method tests for !=.

impl Serialize for IpNet

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralEq for IpNet

impl StructuralPartialEq for IpNet