Struct IpScopes 

pub struct IpScopes(/* private fields */);

Available on crate feature net only.

Special-use scope an IP address belongs to.

ip_scope returns exactly one bit per address (the most specific category, or IpScopes::GLOBAL for an ordinary public address). The bits are meant to be combined into masks — see IpScopes::LOCAL and IpScopes::NON_GLOBAL — so a caller can ask “is this in any of these scopes?” with IpScopes::intersects.

Implementations

impl IpScopes

pub const LOOPBACK: IpScopes

Loopback: 127.0.0.0/8, ::1.

pub const PRIVATE: IpScopes

RFC 1918 private (10/8, 172.16/12, 192.168/16) and IPv6 unique-local (fc00::/7).

pub const LINK_LOCAL: IpScopes

Link-local: 169.254.0.0/16, fe80::/10.

pub const SHARED: IpScopes

RFC 6598 shared / CGNAT address space: 100.64.0.0/10.

pub const UNSPECIFIED: IpScopes

Unspecified / “this network”: 0.0.0.0/8, ::.

pub const MULTICAST: IpScopes

Multicast: 224.0.0.0/4, ff00::/8.

pub const DOCUMENTATION: IpScopes

Documentation ranges (e.g. 192.0.2.0/24, 2001:db8::/32).

pub const BENCHMARKING: IpScopes

Benchmarking ranges (198.18.0.0/15, 2001:2::/48).

pub const RESERVED: IpScopes

Everything else that is non-global: reserved/future-use, broadcast, protocol-assignment sub-ranges, deprecated site-local, and the v6 discard / dummy / local-use-translation prefixes.

pub const GLOBAL: IpScopes

Ordinary, globally-routable public address (none of the above).

impl IpScopes

pub const fn empty() -> IpScopes

Get a flags value with all bits unset.

pub const fn all() -> IpScopes

Get a flags value with all known bits set.

pub const fn bits(&self) -> u16

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u16) -> Option<IpScopes>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u16) -> IpScopes

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u16) -> IpScopes

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<IpScopes>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in self are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: IpScopes) -> bool

Whether any set bits in other are also set in self.

pub const fn contains(&self, other: IpScopes) -> bool

Whether all set bits in other are also set in self.

pub fn insert(&mut self, other: IpScopes)

The bitwise or (|) of the bits in self and other.

pub fn remove(&mut self, other: IpScopes)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: IpScopes)

The bitwise exclusive-or (^) of the bits in self and other.

pub fn set(&mut self, other: IpScopes, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: IpScopes) -> IpScopes

The bitwise and (&) of the bits in self and other.

pub const fn union(self, other: IpScopes) -> IpScopes

The bitwise or (|) of the bits in self and other.

pub const fn difference(self, other: IpScopes) -> IpScopes

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: IpScopes) -> IpScopes

The bitwise exclusive-or (^) of the bits in self and other.

pub const fn complement(self) -> IpScopes

The bitwise negation (!) of the bits in self, truncating the result.

impl IpScopes

pub const fn iter(&self) -> Iter<IpScopes>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<IpScopes>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl IpScopes

pub const NON_GLOBAL: IpScopes

Every scope except IpScopes::GLOBAL — i.e. exactly the set that is_private_ip treats as non-public.

pub const LOCAL: IpScopes

The local-network-ish scopes most commonly excluded from interception: loopback, RFC 1918 private, link-local and CGNAT/shared.

Trait Implementations

impl Binary for IpScopes

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

Formats the value using the given formatter.

impl BitAnd for IpScopes

fn bitand(self, other: IpScopes) -> IpScopes

The bitwise and (&) of the bits in self and other.

type Output = IpScopes

The resulting type after applying the & operator.

impl BitAndAssign for IpScopes

fn bitand_assign(&mut self, other: IpScopes)

The bitwise and (&) of the bits in self and other.

impl BitOr for IpScopes

fn bitor(self, other: IpScopes) -> IpScopes

The bitwise or (|) of the bits in self and other.

type Output = IpScopes

The resulting type after applying the | operator.

impl BitOrAssign for IpScopes

fn bitor_assign(&mut self, other: IpScopes)

The bitwise or (|) of the bits in self and other.

impl BitXor for IpScopes

fn bitxor(self, other: IpScopes) -> IpScopes

The bitwise exclusive-or (^) of the bits in self and other.

type Output = IpScopes

The resulting type after applying the ^ operator.

impl BitXorAssign for IpScopes

fn bitxor_assign(&mut self, other: IpScopes)

The bitwise exclusive-or (^) of the bits in self and other.

impl Clone for IpScopes

fn clone(&self) -> IpScopes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for IpScopes

impl Debug for IpScopes

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

Formats the value using the given formatter.

impl Eq for IpScopes

impl Extend<IpScopes> for IpScopes

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = IpScopes>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for IpScopes

const FLAGS: &'static [Flag<IpScopes>]

The set of defined flags.

type Bits = u16

The underlying bits type.

fn bits(&self) -> u16

Get the underlying bits value.

fn from_bits_retain(bits: u16) -> IpScopes

Convert from a bits value exactly.

fn all_named() -> IpScopes

Get a flags value with all bits from named flags set.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by [Self::FLAGS].

fn iter_equal_names(&self) -> IterEqualNames<Self>

Get an iterator over all defined names for this flags value.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in other are also set in self.

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

where Self: Sized,

Whether all set bits in other are also set in self.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in self and other.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of self with the complement of other (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in self and other.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in self and other.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in self and other.

fn difference(self, other: Self) -> Self

The intersection of self with the complement of other (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in self and other.

fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl FromIterator<IpScopes> for IpScopes

fn from_iter<T>(iterator: T) -> IpScopes

where T: IntoIterator<Item = IpScopes>,

The bitwise or (|) of the bits in each flags value.

impl Hash for IpScopes

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 IntoIterator for IpScopes

type Item = IpScopes

The type of the elements being iterated over.

type IntoIter = Iter<IpScopes>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <IpScopes as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for IpScopes

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

Formats the value using the given formatter.

impl Not for IpScopes

fn not(self) -> IpScopes

The bitwise negation (!) of the bits in self, truncating the result.

type Output = IpScopes

The resulting type after applying the ! operator.

impl Octal for IpScopes

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

Formats the value using the given formatter.

impl PartialEq for IpScopes

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

impl Sub for IpScopes

fn sub(self, other: IpScopes) -> IpScopes

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = IpScopes

The resulting type after applying the - operator.

impl SubAssign for IpScopes

fn sub_assign(&mut self, other: IpScopes)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for IpScopes

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

Formats the value using the given formatter.