Struct Cidr 

pub struct Cidr { /* private fields */ }

An IP network in CIDR notation: a base address plus a prefix length.

Cidr validates that the prefix length is in range for the address family (0..=32 for IPv4, 0..=128 for IPv6) at construction. It accepts both IPv4 and IPv6 via core::net::IpAddr, stores the address exactly as supplied (host bits are not cleared), and offers membership testing with contains and the canonical network base with network.

This type is allocation-free and no_std-friendly.

Examples

use reliakit_primitives::Cidr;

let net: Cidr = "192.168.1.0/24".parse().unwrap();
assert!(net.contains("192.168.1.42".parse().unwrap()));
assert!(!net.contains("192.168.2.1".parse().unwrap()));
assert_eq!(net.prefix_len(), 24);

Implementations

impl Cidr

pub fn new(addr: IpAddr, prefix_len: u8) -> PrimitiveResult<Self>

Creates a Cidr from an address and prefix length.

Returns PrimitiveError::Invalid if prefix_len exceeds the maximum for the address family (32 for IPv4, 128 for IPv6).

pub const fn address(&self) -> IpAddr

Returns the base address exactly as supplied (host bits not cleared).

pub const fn prefix_len(&self) -> u8

Returns the prefix length (number of leading network bits).

pub const fn is_ipv4(&self) -> bool

Returns true if the network is IPv4.

pub const fn is_ipv6(&self) -> bool

Returns true if the network is IPv6.

pub fn network(&self) -> IpAddr

Returns the canonical network address with host bits cleared.

For 192.168.1.42/24 this returns 192.168.1.0.

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

Returns true if ip falls within this network.

An address of a different family than the network is never contained.

Trait Implementations

impl Clone for Cidr

fn clone(&self) -> Cidr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Cidr

impl Debug for Cidr

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

Formats the value using the given formatter.

impl Display for Cidr

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

Formats the value using the given formatter.

impl Eq for Cidr

impl FromStr for Cidr

type Err = PrimitiveError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for Cidr

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

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

impl TryFrom<&str> for Cidr

type Error = PrimitiveError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.