Struct Cidr

pub struct Cidr<A> { /* private fields */ }

CIDR representation of IPv4 network

Implementations

impl<A: NetworkAddress> Cidr<A>

pub const fn new(addr: A, prefix: u8) -> Option<Self>

Constructs new CIDR verifying that prefix fits provided addrs

Returns None if prefix is greater than address length

pub const fn new_single(addr: A) -> Self

Constructs new CIDR with single addr

pub const fn addr(&self) -> A

Returns address

pub const fn prefix(&self) -> u8

Returns prefix

impl Cidr<Ipv4Addr>

pub const fn network_addr(&self) -> Ipv4Addr

Computes network address from provided addr and prefix, which is lowest possible address within CIDR block

pub const fn broadcast_addr(&self) -> Ipv4Addr

Computes network address from provided addr and prefix, which is highest possible address within CIDR block

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

Checks if a given addr is contained within self

pub const fn size(&self) -> u32

Returns number of possible addresses

pub const fn get(&self, idx: u32) -> Option<Ipv4Addr>

Attempts to fetch address by idx within the block self

pub const fn get_unchecked(&self, idx: u32) -> Ipv4Addr

Returns address corresponding idx without checking size according to the prefix

This is safe in a sense as it is only wrapping math operation, but it should be only used when you know need to iterate over possible addresses by pre-computing size

impl Cidr<Ipv6Addr>

pub const fn network_addr(&self) -> Ipv6Addr

Computes network address from provided addr and prefix, which is lowest possible address within CIDR block

pub const fn broadcast_addr(&self) -> Ipv6Addr

Computes network address from provided addr and prefix, which is highest possible address within CIDR block

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

Checks if a given addr is contained within self

pub const fn size(&self) -> u128

Returns number of possible addresses

pub const fn get(&self, idx: u128) -> Option<Ipv6Addr>

Attempts to fetch address by idx within the block self

pub const fn get_unchecked(&self, idx: u128) -> Ipv6Addr

Returns address corresponding idx without checking size according to the prefix

This is safe in a sense as it is only wrapping math operation, but it should be only used when you know need to iterate over possible addresses by pre-computing size

Trait Implementations

impl<A: Clone> Clone for Cidr<A>

fn clone(&self) -> Cidr<A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Debug> Debug for Cidr<A>

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

Formats the value using the given formatter.

impl<A: NetworkAddress> Display for Cidr<A>

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

Formats the value using the given formatter.

impl<A: Ord> Ord for Cidr<A>

fn cmp(&self, other: &Cidr<A>) -> 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<A: PartialEq> PartialEq for Cidr<A>

fn eq(&self, other: &Cidr<A>) -> 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<A: PartialOrd> PartialOrd for Cidr<A>

fn partial_cmp(&self, other: &Cidr<A>) -> 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<A: Copy> Copy for Cidr<A>

impl<A: Eq> Eq for Cidr<A>

impl<A> StructuralPartialEq for Cidr<A>