Struct cidr::Ipv4Cidr

pub struct Ipv4Cidr { /* private fields */ }

Cidr type representing an IPv4 network

Ordering based on lexicographic bitstring representation.

Implementations

impl Ipv4Cidr

pub const fn new(addr: Ipv4Addr, 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 const fn new_host(addr: Ipv4Addr) -> Self

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

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

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

first address in the network as plain address

pub const fn first(&self) -> Ipv4Inet

first address in the network

pub const fn last_address(&self) -> Ipv4Addr

last address in the network as plain address

pub const fn last(&self) -> Ipv4Inet

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

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: &Ipv4Addr) -> bool

check whether an address is contained in the network

Trait Implementations

impl BitString for Ipv4Cidr

Available on crate feature bitstring only.

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) -> Selfwhere 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 Cidr for Ipv4Cidr

type Address = Ipv4Addr

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

fn new(addr: Ipv4Addr, 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.

fn new_host(addr: Ipv4Addr) -> Self

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

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

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

fn first_address(&self) -> Ipv4Addr

first address in the network as plain address

fn first(&self) -> Ipv4Inet

first address in the network

fn last_address(&self) -> Ipv4Addr

last address in the network as plain address

fn last(&self) -> Ipv4Inet

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

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

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

check whether an address is contained in the network

impl Clone for Ipv4Cidr

fn clone(&self) -> Ipv4Cidr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ipv4Cidr

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Ipv4Cidr

Available on crate feature serde only.

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

Deserialize this value from the given Serde deserializer.

impl Display for Ipv4Cidr

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

Formats the value using the given formatter.

impl From<Ipv4Cidr> for AnyIpCidr

fn from(c: Ipv4Cidr) -> Self

Converts to this type from the input type.

impl From<Ipv4Cidr> for IpCidr

fn from(c: Ipv4Cidr) -> Self

Converts to this type from the input type.

impl FromStr for Ipv4Cidr

type Err = NetworkParseError

The associated error which can be returned from parsing.

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

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

impl Hash for Ipv4Cidr

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

Iterate over all the addresses in the CIDR.

type IntoIter = InetIterator<Ipv4Addr>

Which kind of iterator are we turning this into?

type Item = Ipv4Inet

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for Ipv4Cidr

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Ipv4Cidr> for Ipv4Cidr

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

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

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

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

impl PartialOrd<Ipv4Cidr> for Ipv4Cidr

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

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

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

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

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

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

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

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

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

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

impl Serialize for Ipv4Cidr

Available on crate feature serde only.

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

Serialize this value into the given Serde serializer.

impl Copy for Ipv4Cidr

impl Eq for Ipv4Cidr

impl StructuralEq for Ipv4Cidr

impl StructuralPartialEq for Ipv4Cidr