Struct Ipv4Range

pub struct Ipv4Range { /* private fields */ }

A range of IPv4 addresses with a common prefix

Implementations

impl Ipv4Range

pub fn new(addr: Ipv4Addr, bits: u8) -> Self

Create an IPv4 range with the given base address and netmask prefix length.

Example

Create the subnet 192.168.0.0/24 with Ipv4Range::new("192.168.0.0".parse().unwrap(), 24)

pub fn global() -> Self

Return the entire IPv4 range, eg. 0.0.0.0/0

pub fn local_subnet_10() -> Self

Returns the local network subnet 10.0.0.0/8

pub fn local_subnet_172(block: u8) -> Self

Returns a local network subnet 172.(16 | x).0.0/16 where x is a 4-bit number given by block

Panics

If block & 0xf0 != 0

pub fn local_subnet_192(block: u8) -> Self

Returns the local subnet 192.168.x.0/24 where x is given by block.

pub fn random_local_subnet() -> Self

Returns a random local network subnet from one of the ranges 10.0.0.0, 172.16.0.0 or 192.168.0.0

pub fn netmask(&self) -> Ipv4Addr

Get the netmask as an IP address

pub fn netmask_prefix_length(&self) -> u8

Get the number of netmask prefix bits

pub fn base_addr(&self) -> Ipv4Addr

Get the base address of the range, ie. the lowest IP address which is part of the range.

pub fn gateway_addr(&self) -> Ipv4Addr

Get a default IP address for the range’s gateway. This is one higher than the base address of the range. eg. for 10.0.0.0/8, the default address for the gateway will be 10.0.0.1

pub fn broadcast_addr(&self) -> Ipv4Addr

Get the broadcast address, ie. the highest IP address which is part of the range.

pub fn random_client_addr(&self) -> Ipv4Addr

Get a random IP address from the range which is not the base address or the default for the gateway address.

pub fn address_for(&self, device: u32) -> Ipv4Addr

Generate an IP address for a device.

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

Check whether this range contains the given IP address

pub fn split(self, num: u32) -> Vec<Self>

Split a range into num sub-ranges

Panics

If the range is too small to be split up that much.

Trait Implementations

impl Clone for Ipv4Range

fn clone(&self) -> Ipv4Range

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ipv4Range

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

Formats the value using the given formatter.

impl From<Ipv4Addr> for Ipv4Range

fn from(addr: Ipv4Addr) -> Self

Converts to this type from the input type.

impl From<Ipv4Range> for Ipv4Route

fn from(range: Ipv4Range) -> Self

Converts to this type from the input type.

impl FromStr for Ipv4Range

type Err = IpRangeParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Ipv4Range, IpRangeParseError>

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

impl PartialEq for Ipv4Range

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

impl Eq for Ipv4Range

impl StructuralPartialEq for Ipv4Range