Enum cidr::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 always truncates the bit string to length 1.

The Cidr trait itself cannot be implemented because Any has no address family, but there is a very similar interface implemented directly.

Variants

Any

"any" network containing all IPv4 and IPv6 addresses

V4(Ipv4Cidr)

IPv4 network

V6(Ipv6Cidr)

IPv6 network

Methods

impl AnyIpCidr

pub fn is_any(&self) -> bool

Whether representing any address

pub fn is_ipv4(&self) -> bool

Whether representing an IPv4 network

pub fn is_ipv6(&self) -> bool

Whether representing an IPv6 network

impl AnyIpCidr

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

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

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

first address in the network as plain address

returns None for Any

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

first address in the network

returns None for Any

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

last address in the network as plain address

returns None for Any

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

last address in the network

returns None for Any

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

length in bits of the shared prefix of the contained addresses

returns None for Any

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

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

returns None for Any

pub 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 fn contains(&self, addr: &IpAddr) -> bool

check whether an address is contained in the network

Trait Implementations

impl PartialEq<AnyIpCidr> for AnyIpCidr

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

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

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

This method tests for !=.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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 From<Option<IpCidr>> for AnyIpCidr

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

Performs the conversion.

impl From<IpCidr> for AnyIpCidr

fn from(c: IpCidr) -> Self

Performs the conversion.

impl From<Ipv4Cidr> for AnyIpCidr

fn from(c: Ipv4Cidr) -> Self

Performs the conversion.

impl From<Ipv6Cidr> for AnyIpCidr

fn from(c: Ipv6Cidr) -> Self

Performs the conversion.

impl Into<Option<IpCidr>> for AnyIpCidr

fn into(self) -> Option<IpCidr>

Performs the conversion.

impl Eq for AnyIpCidr

impl PartialOrd<AnyIpCidr> 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: &AnyIpCidr) -> bool

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Display for AnyIpCidr

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

Formats the value using the given formatter.

impl Hash for AnyIpCidr

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

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

Formats the value using the given formatter.

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 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() -> Self

Create a new zero-length bit string.

fn shared_prefix_len(&self, other: &Self) -> 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 Serialize for AnyIpCidr

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

Serialize this value into the given Serde serializer.

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

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

Deserialize this value from the given Serde deserializer.