Enum IpInet

pub enum IpInet {
    V4(Ipv4Inet),
    V6(Ipv6Inet),
}

Inet type representing either an IPv4 or an IPv6 host within a network

Variants

V4(Ipv4Inet)

IPv4 host within network

V6(Ipv6Inet)

IPv6 host within network

Implementations

impl IpInet

pub const fn is_ipv4(&self) -> bool

Whether representing an IPv4 network

pub const fn is_ipv6(&self) -> bool

Whether representing an IPv6 network

pub const fn new( addr: IpAddr, len: u8, ) -> Result<Self, NetworkLengthTooLongError>

Create new host within a network from address and prefix length. If the network length exceeds the address length an error is returned.

pub const fn new_host(addr: IpAddr) -> Self

Create a network containing a single address as host and the network (network length = address length).

pub fn increment(&mut self) -> bool

increments host part (without changing the network part); returns true on wrap around

pub const fn next(self) -> Option<Self>

Returns next address in network or None if it was the last address in the network

pub fn decrement(&mut self) -> bool

decrements host part (without changing the network part); returns true on wrap around

pub const fn previous(self) -> Option<Self>

Returns previous address in network or None if it was the first address in the network

pub const fn overflowing_add(self, step: u128) -> (Self, bool)

Find the nth host after the current one in the current network

Returned boolean indicates whether an overflow occured.

pub const fn overflowing_sub(self, step: u128) -> (Self, bool)

Find the nth host before the current one in the current network

Returned boolean indicates whether an overflow occured.

pub const fn network(&self) -> IpCidr

network (i.e. drops the host information)

pub const fn address(&self) -> IpAddr

the host

pub const fn first_address(&self) -> IpAddr

first address in the network as plain address

pub const fn first(&self) -> Self

first address in the network

pub const fn last_address(&self) -> IpAddr

last address in the network as plain address

pub const fn last(&self) -> Self

last address in the network

pub const fn network_length(&self) -> u8

length in bits of the shared prefix of the contained addresses

pub const fn family(&self) -> Family

IP family of the contained address (Ipv4 or Ipv6).

pub const fn is_host_address(&self) -> bool

whether network represents a single host address

pub const fn mask(&self) -> IpAddr

network mask: an pseudo address which has the first network length bits set to 1 and the remaining to 0.

pub const fn contains(&self, addr: &IpAddr) -> bool

check whether an address is contained in the network

Trait Implementations

impl Add<u128> for IpInet

type Output = IpInet

The resulting type after applying the + operator.

fn add(self, step: u128) -> Self::Output

Performs the + operation.

impl Clone for IpInet

fn clone(&self) -> IpInet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IpInet

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

Formats the value using the given formatter.

impl Display for IpInet

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

Formats the value using the given formatter.

impl From<Ipv4Inet> for IpInet

fn from(c: Ipv4Inet) -> Self

Converts to this type from the input type.

impl From<Ipv6Inet> for IpInet

fn from(c: Ipv6Inet) -> Self

Converts to this type from the input type.

impl FromStr for IpInet

type Err = NetworkParseError

The associated error which can be returned from parsing.

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

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

impl Hash for IpInet

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Inet for IpInet

type Address = IpAddr

Type for the underlying address (IpAddr, Ipv4Addr or Ipv6Addr).

fn new(addr: IpAddr, len: u8) -> Result<Self, NetworkLengthTooLongError>

Create new host within a network from address and prefix length. If the network length exceeds the address length an error is returned.

fn new_host(addr: IpAddr) -> Self

Create a network containing a single address as host and the network (network length = address length).

fn increment(&mut self) -> bool

increments host part (without changing the network part); returns true on wrap around

fn next(self) -> Option<Self>

Returns next address in network or None if it was the last address in the network

fn decrement(&mut self) -> bool

decrements host part (without changing the network part); returns true on wrap around

fn previous(self) -> Option<Self>

Returns previous address in network or None if it was the first address in the network

fn overflowing_add(self, step: u128) -> (Self, bool)

Find the nth host after the current one in the current network

fn overflowing_sub(self, step: u128) -> (Self, bool)

Find the nth host before the current one in the current network

fn network(&self) -> IpCidr

network (i.e. drops the host information)

fn address(&self) -> IpAddr

the host

fn first_address(&self) -> IpAddr

first address in the network as plain address

fn first(&self) -> Self

first address in the network

fn last_address(&self) -> IpAddr

last address in the network as plain address

fn last(&self) -> Self

last address in the network

fn network_length(&self) -> u8

length in bits of the shared prefix of the contained addresses

fn family(&self) -> Family

IP family of the contained address (Ipv4 or Ipv6).

fn is_host_address(&self) -> bool

whether network represents a single host address

fn mask(&self) -> IpAddr

network mask: an pseudo address which has the first network length bits set to 1 and the remaining to 0.

fn contains(&self, addr: &IpAddr) -> bool

check whether an address is contained in the network

impl Ord for IpInet

fn cmp(&self, other: &IpInet) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for IpInet

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for IpInet

fn partial_cmp(&self, other: &IpInet) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<u128> for IpInet

type Output = IpInet

The resulting type after applying the - operator.

fn sub(self, step: u128) -> Self::Output

Performs the - operation.

impl Copy for IpInet

impl Eq for IpInet

impl StructuralPartialEq for IpInet