Enum IpNet

pub enum IpNet {
    V4(Ipv4Net),
    V6(Ipv6Net),
}

A subnet, either IPv4 or IPv6

Variants

V4(Ipv4Net)

An IPv4 subnet

V6(Ipv6Net)

An IPv6 subnet

Implementations

impl IpNet

pub fn new(addr: IpAddr, prefix: u8) -> Result<Self, IpNetPrefixError>

Create an IpNet with the given address and prefix width.

pub const fn new_unchecked(addr: IpAddr, prefix: u8) -> Self

Create an IpNet with the given address and prefix width with no checks for the validity of the prefix length.

pub fn host_net(addr: IpAddr) -> Self

Create an IpNet that contains exclusively the given address.

pub const fn addr(&self) -> IpAddr

Return the base address.

pub fn prefix(&self) -> IpAddr

Return the prefix address (the base address with the mask applied).

pub const fn width(&self) -> u8

Return the prefix length.

pub fn mask_addr(&self) -> IpAddr

Return the netmask address derived from prefix length.

pub const fn is_host_net(&self) -> bool

Return true iff the subnet contains only the base address i.e. the size is exactly one address.

pub fn is_network_address(&self) -> bool

Return true iff the base address corresponds to the all-zeroes host ID in the subnet.

pub const fn is_multicast(&self) -> bool

Return true iff this subnet is in a multicast address range.

pub const fn is_admin_scoped_multicast(&self) -> bool

Return true iff this subnet is in a multicast address range with administrative scope (admin-local, site-local or organization-local) as defined in RFC 7346 and RFC 4291.

pub const fn is_unique_local(&self) -> bool

Return true iff this subnet is in a Unique Local Address range. This is only valid for IPv6 addresses.

pub const fn is_loopback(&self) -> bool

Return true iff this subnet is in a loopback address range.

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

Return true if the provided address is contained in self.

This returns false if the address and the network are of different IP families.

pub fn is_subnet_of(&self, other: &Self) -> bool

Returns true iff this subnet is wholly contained within other.

This returns false if the address and the network are of different IP families.

pub fn is_supernet_of(&self, other: &Self) -> bool

Returns true iff other is wholly contained within this subnet.

This returns false if the address and the network are of different IP families.

pub fn overlaps(&self, other: &Self) -> bool

Return true if the provided IpNet shares any IP addresses with self (e.g., self.is_subnet_of(other), or vice-versa).

This returns false if the networks are of different IP families.

pub const fn is_ipv4(&self) -> bool

Return true if this is an IPv4 network.

pub const fn is_ipv6(&self) -> bool

Return true if this is an IPv6 network.

Trait Implementations

impl Clone for IpNet

fn clone(&self) -> IpNet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IpNet

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IpNet

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for IpNet

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

Formats the value using the given formatter.

impl From<IpNet> for IpNetwork

fn from(value: IpNet) -> Self

Converts to this type from the input type.

impl From<IpNetwork> for IpNet

fn from(value: IpNetwork) -> Self

Converts to this type from the input type.

impl From<Ipv4Net> for IpNet

fn from(n: Ipv4Net) -> IpNet

Converts to this type from the input type.

impl From<Ipv6Net> for IpNet

fn from(n: Ipv6Net) -> IpNet

Converts to this type from the input type.

impl FromStr for IpNet

type Err = IpNetParseError

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 IpNet

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 JsonSchema for IpNet

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl Ord for IpNet

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

Restrict a value to a certain interval.

impl PartialEq for IpNet

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for IpNet

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 IpNet

impl Eq for IpNet

impl StructuralPartialEq for IpNet