Struct Cidr 

pub struct Cidr { /* private fields */ }

Available on crate feature net only.

A CIDR (Classless Inter-Domain Routing) notation for IP networks.

This type represents an IP network prefix in the form address/prefix_length, where address is an IP address and prefix_length is the number of leading bits that represent the network portion.

Examples

use bare_types::net::{Cidr, IpAddr};

// Create CIDR from string
let cidr: Cidr = "192.168.1.0/24".parse().unwrap();

// Check if IP is in network
let check_ip: IpAddr = "192.168.1.100".parse().unwrap();
assert!(cidr.contains(&check_ip));

// Get network address
let network = cidr.network_address();

// Get broadcast address (only for IPv4)
let broadcast = cidr.broadcast_address();

// Create from IP address and prefix length
let ip: IpAddr = "10.0.0.0".parse().unwrap();
let cidr2 = Cidr::new(ip, 8).unwrap();

Implementations

impl Cidr

pub const fn new(address: IpAddr, prefix_length: u8) -> Result<Self, CidrError>

Creates a new CIDR from an IP address and prefix length.

Errors

Returns CidrError::InvalidPrefixLength if the prefix length is invalid:

• IPv4: 0-32
• IPv6: 0-128

Examples

use bare_types::net::{Cidr, IpAddr};

let ip: IpAddr = "192.168.1.0".parse().unwrap();
let cidr = Cidr::new(ip, 24).unwrap();

pub const fn address(&self) -> IpAddr

Returns the IP address.

Examples

use bare_types::net::{Cidr, IpAddr};

let cidr: Cidr = "192.168.1.0/24".parse().unwrap();
let ip = cidr.address();

pub const fn prefix_length(&self) -> u8

Returns the prefix length.

Examples

use bare_types::net::{Cidr, IpAddr};

let cidr: Cidr = "192.168.1.0/24".parse().unwrap();
assert_eq!(cidr.prefix_length(), 24);

pub fn network_address(&self) -> IpAddr

Returns the network address.

The network address is the IP address with all host bits set to zero.

Examples

use bare_types::net::Cidr;

let cidr: Cidr = "192.168.1.100/24".parse().unwrap();
let network = cidr.network_address();
assert_eq!(network.to_string(), "192.168.1.0");

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

Returns the broadcast address.

The broadcast address is the IP address with all host bits set to one. Only applicable for IPv4 networks.

Examples

use bare_types::net::Cidr;

let cidr: Cidr = "192.168.1.0/24".parse().unwrap();
let broadcast = cidr.broadcast_address().unwrap();
assert_eq!(broadcast.to_string(), "192.168.1.255");

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

Checks if an IP address is contained in this CIDR network.

Examples

use bare_types::net::{Cidr, IpAddr};

let cidr: Cidr = "192.168.1.0/24".parse().unwrap();
let ip1: IpAddr = "192.168.1.100".parse().unwrap();
let ip2: IpAddr = "192.168.2.100".parse().unwrap();

assert!(cidr.contains(&ip1));
assert!(!cidr.contains(&ip2));

pub fn size(&self) -> u128

Returns the number of addresses in this network.

Examples

use bare_types::net::Cidr;

let cidr: Cidr = "192.168.1.0/24".parse().unwrap();
assert_eq!(cidr.size(), 256);

Trait Implementations

impl<'a> Arbitrary<'a> for Cidr

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

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

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Cidr

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Cidr

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

Formats the value using the given formatter.

impl FromStr for Cidr

type Err = CidrError

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

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 Cidr

impl Eq for Cidr

impl StructuralPartialEq for Cidr