Enum cidr_map::AnyIpCidr

pub enum AnyIpCidr {
    Any,
    V4(Ipv4Cidr),
    V6(Ipv6Cidr),
}

Represents either an IPv4 or an IPv6 network or “any”.

Allows for a bit string representation which treats “any” as the empty string, IPv4 as starting with false and IPv6 as starting with true. After the first bit the normal represenation for the picked address-family follows.

Setting the first bit (using the bitstring API) always truncates the bit string to length 1 (i.e. /0 in the resulting family).

The Cidr trait cannot be implemented for this type.

Variants

Any

“any” network containing all IPv4 and IPv6 addresses

V4(Ipv4Cidr)

IPv4 network

V6(Ipv6Cidr)

IPv6 network

Implementations

impl AnyIpCidr

pub const fn is_any(&self) -> bool

Whether representing any address

pub const fn is_ipv4(&self) -> bool

Whether representing an IPv4 network

pub const fn is_ipv6(&self) -> bool

Whether representing an IPv6 network

impl AnyIpCidr

pub const fn new(addr: IpAddr, len: u8) -> Result<AnyIpCidr, 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) -> AnyIpCidr

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

pub const fn first_address(&self) -> Option<IpAddr>

first address in the network as plain address

returns None for Any

pub const fn first(&self) -> Option<IpInet>

first address in the network

returns None for Any

pub const fn last_address(&self) -> Option<IpAddr>

last address in the network as plain address

returns None for Any

pub const fn last(&self) -> Option<IpInet>

last address in the network

returns None for Any

pub const fn network_length(&self) -> Option<u8>

length in bits of the shared prefix of the contained addresses

returns None for Any

pub const fn family(&self) -> Option<Family>

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

returns None for Any

pub const fn is_host_address(&self) -> bool

whether network represents a single host address

pub const fn mask(&self) -> Option<IpAddr>

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

returns None for Any

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

check whether an address is contained in the network

Trait Implementations

impl BitString for AnyIpCidr

fn get(&self, ndx: usize) -> bool

Get the ndxth bit.

fn set(&mut self, ndx: usize, bit: bool)

Set the ndxth bit to bit.

fn flip(&mut self, ndx: usize)

Flips the ndxth bit.

fn len(&self) -> usize

Current length of the bit string in bits.

fn clip(&mut self, len: usize)

Set current length to len.

fn append(&mut self, bit: bool)

Append a bit.

fn null() -> AnyIpCidr

Create a new zero-length bit string.

fn shared_prefix_len(&self, other: &AnyIpCidr) -> usize

Length of the longest shared prefix of two bit strings.

fn shared_prefix(&self, other: &Self) -> Self

where Self: Clone,

Longest shared prefix of two bit strings.

fn subset_cmp(&self, other: &Self) -> Option<Ordering>

Partial ordering on bit strings.

fn lexicographic_cmp(&self, other: &Self) -> Ordering

Lexicographic ordering on bit strings.

impl Clone for AnyIpCidr

fn clone(&self) -> AnyIpCidr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnyIpCidr

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AnyIpCidr

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AnyIpCidr

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

Formats the value using the given formatter.

impl From<IpAddr> for AnyIpCidr

fn from(address: IpAddr) -> AnyIpCidr

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 AnyIpCidr

fn from(address: Ipv4Addr) -> AnyIpCidr

Converts to this type from the input type.

impl From<Ipv4Cidr> for AnyIpCidr

fn from(c: Ipv4Cidr) -> AnyIpCidr

Converts to this type from the input type.

impl From<Ipv6Addr> for AnyIpCidr

fn from(address: Ipv6Addr) -> AnyIpCidr

Converts to this type from the input type.

impl From<Ipv6Cidr> for AnyIpCidr

fn from(c: Ipv6Cidr) -> AnyIpCidr

Converts to this type from the input type.

impl From<Option<IpCidr>> for AnyIpCidr

fn from(a: Option<IpCidr>) -> AnyIpCidr

Converts to this type from the input type.

impl FromStr for AnyIpCidr

type Err = NetworkParseError

The associated error which can be returned from parsing.

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

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

impl Hash for AnyIpCidr

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 Ord for AnyIpCidr

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

Restrict a value to a certain interval.

impl PartialEq for AnyIpCidr

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

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

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 AnyIpCidr

impl Eq for AnyIpCidr

impl StructuralPartialEq for AnyIpCidr