Struct netsim::SubnetV4

pub struct SubnetV4 { /* fields omitted */ }

An Ipv4 subnet

Methods

impl SubnetV4

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

Create a subnet with the given base IP address and number of netmask bits.

Example

Create the subnet 192.168.0.0/24 with SubnetV4::new(ipv4!("192.168.0.0"), 24)

fn global() -> SubnetV4

Return the global subnet, eg. 0.0.0.0/0

fn local_10() -> SubnetV4

Returns the local network subnet 10.0.0.0/8

fn local_172(block: u8) -> SubnetV4

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

fn local_192(block: u8) -> SubnetV4

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

fn random_local() -> SubnetV4

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

fn netmask(&self) -> Ipv4Addr

Get the netmask as an IP address

fn netmask_bits(&self) -> u8

Get the number of netmask bits

fn base_addr(&self) -> Ipv4Addr

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

fn gateway_ip(&self) -> Ipv4Addr

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

fn random_client_addr(&self) -> Ipv4Addr

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

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

Check whether this subnet contains the given IP address

Trait Implementations

impl Debug for SubnetV4

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for SubnetV4

fn clone(&self) -> SubnetV4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SubnetV4

impl FromStr for SubnetV4

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<SubnetV4, ParseError>

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