Enum IpCidr

pub enum IpCidr {
    V4(Ipv4Cidr),
    V6(Ipv6Cidr),
}

Cidr type representing either an IPv4 or an IPv6 network

Variants

V4(Ipv4Cidr)

IPv4 network

V6(Ipv6Cidr)

IPv6 network

Implementations

impl IpCidr

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<IpCidr, NetworkParseError>

Create new network from address and prefix length. If the network length exceeds the address length or the address is not the first address in the network (“host part not zero”) an error is returned.

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

Create a network containing a single address (network length = address length).

pub const fn iter(&self) -> InetIterator<IpAddr>

Iterate over all addresses in the range. With IPv6 addresses this can produce really long iterations (up to 2¹²⁸ addresses).

pub const fn first_address(&self) -> IpAddr

first address in the network as plain address

pub const fn first(&self) -> IpInet

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) -> IpInet

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 Cidr for IpCidr

type Address = IpAddr

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

fn new(addr: IpAddr, len: u8) -> Result<IpCidr, NetworkParseError>

Create new network from address and prefix length. If the network length exceeds the address length or the address is not the first address in the network (“host part not zero”) an error is returned.

fn new_host(addr: IpAddr) -> IpCidr

Create a network containing a single address (network length = address length).

fn iter(&self) -> InetIterator<IpAddr>

Iterate over all addresses in the range. With IPv6 addresses this can produce really long iterations (up to 2¹²⁸ addresses).

fn first_address(&self) -> IpAddr

first address in the network as plain address

fn first(&self) -> IpInet

first address in the network

fn last_address(&self) -> IpAddr

last address in the network as plain address

fn last(&self) -> IpInet

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 Clone for IpCidr

fn clone(&self) -> IpCidr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IpCidr

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IpCidr

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for IpCidr

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

Formats the value using the given formatter.

impl From<IpAddr> for IpCidr

fn from(address: IpAddr) -> IpCidr

Converts to this type from the input type.

impl From<IpCidr> for AnyIpCidr

fn from(c: IpCidr) -> AnyIpCidr

Converts to this type from the input type.

impl From<Ipv4Addr> for IpCidr

fn from(address: Ipv4Addr) -> IpCidr

Converts to this type from the input type.

impl From<Ipv4Cidr> for IpCidr

fn from(c: Ipv4Cidr) -> IpCidr

Converts to this type from the input type.

impl From<Ipv6Addr> for IpCidr

fn from(address: Ipv6Addr) -> IpCidr

Converts to this type from the input type.

impl From<Ipv6Cidr> for IpCidr

fn from(c: Ipv6Cidr) -> IpCidr

Converts to this type from the input type.

impl FromStr for IpCidr

type Err = NetworkParseError

The associated error which can be returned from parsing.

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

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

impl Hash for IpCidr

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

where __H: Hasher,

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 IntoIterator for IpCidr

type IntoIter = InetIterator<IpAddr>

Which kind of iterator are we turning this into?

type Item = IpInet

The type of the elements being iterated over.

fn into_iter(self) -> <IpCidr as IntoIterator>::IntoIter

Creates an iterator from a value.

impl Ord for IpCidr

fn cmp(&self, other: &IpCidr) -> 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 IpCidr

fn eq(&self, other: &IpCidr) -> 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 IpCidr

fn partial_cmp(&self, other: &IpCidr) -> 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 Serialize for IpCidr

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for IpCidr

impl Eq for IpCidr

impl StructuralPartialEq for IpCidr