Struct net_types::ip::Subnet

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

An IP subnet.

Subnet is a combination of an IP network address and a prefix length.

Implementations

impl<A> Subnet<A>

pub const unsafe fn new_unchecked(network: A, prefix: u8) -> Subnet<A>

Creates a new subnet without enforcing correctness.

Safety

Unlike new, new_unchecked does not validate that prefix is in the proper range, and does not check that network has only the top prefix bits set. It is up to the caller to guarantee that prefix is in the proper range, and that none of the bits of network beyond the prefix are set.

impl<A: IpAddress> Subnet<A>

pub fn new(network: A, prefix: u8) -> Result<Subnet<A>, SubnetError>

Creates a new subnet.

new creates a new subnet with the given network address and prefix length. It returns Err if prefix is longer than the number of bits in this type of IP address (32 for IPv4 and 128 for IPv6) or if any of the host bits (beyond the first prefix bits) are set in network.

pub fn from_host(host: A, prefix: u8) -> Result<Subnet<A>, PrefixTooLongError>

Creates a new subnet from the address of a host in that subnet.

Unlike new, the host address may have host bits set.

pub fn network(&self) -> A

Gets the network address component of this subnet.

Any bits beyond the prefix will be zero.

pub fn prefix(&self) -> u8

Gets the prefix length component of this subnet.

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

Tests whether an address is in this subnet.

Tests whether addr is in this subnet by testing whether the prefix bits match the prefix bits of the subnet’s network address. This is equivalent to sub.network() == addr.mask(sub.prefix()).

impl Subnet<Ipv4Addr>

pub fn broadcast(self) -> Ipv4Addr

Gets the broadcast address in this IPv4 subnet.

Trait Implementations

impl<A: Clone> Clone for Subnet<A>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: IpAddress> Debug for Subnet<A>

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

Formats the value using the given formatter.

impl<A: IpAddress> Display for Subnet<A>

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

Formats the value using the given formatter.

impl<A: IpAddress> From<Subnet<A>> for SubnetEither

fn from(subnet: Subnet<A>) -> SubnetEither

Converts to this type from the input type.

impl<A, I: Ip> GenericOverIp<I> for Subnet<A>

type Type = Subnet<<I as Ip>::Addr>

The type of Self when its IP-generic parameter is replaced with the type NewIp.

impl<A: Hash> Hash for Subnet<A>

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<A: Ord> Ord for Subnet<A>

Subnet ordering always orders from least-specific to most-specific subnet.

fn cmp(&self, other: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<A: PartialEq> PartialEq for Subnet<A>

fn eq(&self, other: &Subnet<A>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<A: Ord> PartialOrd for Subnet<A>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<A: Copy> Copy for Subnet<A>

impl<A: Eq> Eq for Subnet<A>

impl<A> StructuralPartialEq for Subnet<A>