Struct SpecifiedAddr

pub struct SpecifiedAddr<A>(/* private fields */);

An address which is guaranteed to be specified.

SpecifiedAddr wraps an address of type A and guarantees that it is a specified address. Note that this guarantee is contingent on a correct implementation of the SpecifiedAddress trait. Since that trait is not unsafe, unsafe code may NOT rely on this guarantee for its soundness.

Implementations

impl<A: SpecifiedAddress> SpecifiedAddr<A>

pub fn new(addr: A) -> Option<SpecifiedAddr<A>>

Constructs a new SpecifiedAddr.

new returns None if !addr.is_specified().

pub fn from_witness<W: Witness<A>>(addr: W) -> Option<SpecifiedAddr<A>>

Constructs a new SpecifiedAddr from a witness type.

from_witness(witness) is equivalent to new(witness.into_addr()).

impl<A> SpecifiedAddr<A>

pub const unsafe fn new_unchecked(addr: A) -> SpecifiedAddr<A>

Constructs a new SpecifiedAddr without checking to see if addr is actually specified.

Safety

It is up to the caller to make sure that addr is specified to avoid breaking the guarantees of SpecifiedAddr. See SpecifiedAddr for more details.

Trait Implementations

impl<A: SpecifiedAddress> AsRef<A> for SpecifiedAddr<A>

fn as_ref(&self) -> &A

Converts this type into a shared reference of the (usually inferred) input type.

impl<A: SpecifiedAddress> AsRef<SpecifiedAddr<A>> for SpecifiedAddr<A>

fn as_ref(&self) -> &SpecifiedAddr<A>

Converts this type into a shared reference of the (usually inferred) input type.

impl<A: BroadcastAddress> BroadcastAddress for SpecifiedAddr<A>

fn is_broadcast(&self) -> bool

Is this a broadcast address?

impl<A: Clone> Clone for SpecifiedAddr<A>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug> Debug for SpecifiedAddr<A>

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

Formats the value using the given formatter.

impl<A: SpecifiedAddress> Deref for SpecifiedAddr<A>

type Target = A

The resulting type after dereferencing.

fn deref(&self) -> &A

Dereferences the value.

impl<A: Display> Display for SpecifiedAddr<A>

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

Formats the value using the given formatter.

impl<A: BroadcastAddress + SpecifiedAddress> From<BroadcastAddr<A>> for SpecifiedAddr<A>

fn from(addr: BroadcastAddr<A>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: BroadcastAddress + LinkLocalAddress + SpecifiedAddress> From<BroadcastAddr<LinkLocalAddr<A>>> for SpecifiedAddr<A>

fn from(addr: BroadcastAddr<LinkLocalAddr<A>>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: BroadcastAddress + MappedAddress + SpecifiedAddress> From<BroadcastAddr<NonMappedAddr<A>>> for SpecifiedAddr<A>

fn from(addr: BroadcastAddr<NonMappedAddr<A>>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl From<IpAddr<SpecifiedAddr<Ipv4Addr>, SpecifiedAddr<Ipv6Addr>>> for SpecifiedAddr<IpAddr>

fn from( addr: IpAddr<SpecifiedAddr<Ipv4Addr>, SpecifiedAddr<Ipv6Addr>>, ) -> SpecifiedAddr<IpAddr>

Converts to this type from the input type.

impl<A: LinkLocalAddress + SpecifiedAddress> From<LinkLocalAddr<A>> for SpecifiedAddr<A>

fn from(addr: LinkLocalAddr<A>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: LinkLocalAddress + BroadcastAddress + SpecifiedAddress> From<LinkLocalAddr<BroadcastAddr<A>>> for SpecifiedAddr<A>

fn from(addr: LinkLocalAddr<BroadcastAddr<A>>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: LinkLocalAddress + MulticastAddress + SpecifiedAddress> From<LinkLocalAddr<MulticastAddr<A>>> for SpecifiedAddr<A>

fn from(addr: LinkLocalAddr<MulticastAddr<A>>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: LinkLocalAddress + MappedAddress + SpecifiedAddress> From<LinkLocalAddr<NonMappedAddr<A>>> for SpecifiedAddr<A>

fn from(addr: LinkLocalAddr<NonMappedAddr<A>>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: LinkLocalAddress + UnicastAddress + SpecifiedAddress> From<LinkLocalAddr<UnicastAddr<A>>> for SpecifiedAddr<A>

fn from(addr: LinkLocalAddr<UnicastAddr<A>>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: MulticastAddress + SpecifiedAddress> From<MulticastAddr<A>> for SpecifiedAddr<A>

fn from(addr: MulticastAddr<A>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: MulticastAddress + LinkLocalAddress + SpecifiedAddress> From<MulticastAddr<LinkLocalAddr<A>>> for SpecifiedAddr<A>

fn from(addr: MulticastAddr<LinkLocalAddr<A>>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: MulticastAddress + MappedAddress + SpecifiedAddress> From<MulticastAddr<NonMappedAddr<A>>> for SpecifiedAddr<A>

fn from(addr: MulticastAddr<NonMappedAddr<A>>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: MappedAddress + BroadcastAddress + SpecifiedAddress> From<NonMappedAddr<BroadcastAddr<A>>> for SpecifiedAddr<A>

fn from(addr: NonMappedAddr<BroadcastAddr<A>>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: MappedAddress + LinkLocalAddress + SpecifiedAddress> From<NonMappedAddr<LinkLocalAddr<A>>> for SpecifiedAddr<A>

fn from(addr: NonMappedAddr<LinkLocalAddr<A>>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: MappedAddress + MulticastAddress + SpecifiedAddress> From<NonMappedAddr<MulticastAddr<A>>> for SpecifiedAddr<A>

fn from(addr: NonMappedAddr<MulticastAddr<A>>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: MappedAddress + SpecifiedAddress> From<NonMappedAddr<SpecifiedAddr<A>>> for SpecifiedAddr<A>

fn from(addr: NonMappedAddr<SpecifiedAddr<A>>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: MappedAddress + UnicastAddress + SpecifiedAddress> From<NonMappedAddr<UnicastAddr<A>>> for SpecifiedAddr<A>

fn from(addr: NonMappedAddr<UnicastAddr<A>>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: MulticastAddress + MappedAddress + SpecifiedAddress> From<NonMulticastAddr<NonMappedAddr<SpecifiedAddr<A>>>> for SpecifiedAddr<A>

fn from( addr: NonMulticastAddr<NonMappedAddr<SpecifiedAddr<A>>>, ) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: IpAddress> From<SpecifiedAddr<A>> for IpAddr<SpecifiedAddr<Ipv4Addr>, SpecifiedAddr<Ipv6Addr>>

fn from( addr: SpecifiedAddr<A>, ) -> IpAddr<SpecifiedAddr<Ipv4Addr>, SpecifiedAddr<Ipv6Addr>>

Converts to this type from the input type.

impl<A: Into<Ipv4Addr> + SpecifiedAddress + Copy> From<SpecifiedAddr<A>> for Ipv4Addr

fn from(addr: SpecifiedAddr<A>) -> Ipv4Addr

Converts to this type from the input type.

impl<A: Into<Ipv6Addr> + SpecifiedAddress + Copy> From<SpecifiedAddr<A>> for Ipv6Addr

fn from(addr: SpecifiedAddr<A>) -> Ipv6Addr

Converts to this type from the input type.

impl<A: IpAddress> From<SpecifiedAddr<A>> for SpecifiedAddr<IpAddr>

fn from(addr: SpecifiedAddr<A>) -> SpecifiedAddr<IpAddr>

Converts to this type from the input type.

impl From<SpecifiedAddr<IpAddr>> for IpAddr<SpecifiedAddr<Ipv4Addr>, SpecifiedAddr<Ipv6Addr>>

fn from( addr: SpecifiedAddr<IpAddr>, ) -> IpAddr<SpecifiedAddr<Ipv4Addr>, SpecifiedAddr<Ipv6Addr>>

Converts to this type from the input type.

impl<A: UnicastAddress + SpecifiedAddress> From<UnicastAddr<A>> for SpecifiedAddr<A>

fn from(addr: UnicastAddr<A>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: UnicastAddress + LinkLocalAddress + SpecifiedAddress> From<UnicastAddr<LinkLocalAddr<A>>> for SpecifiedAddr<A>

fn from(addr: UnicastAddr<LinkLocalAddr<A>>) -> SpecifiedAddr<A>

Converts to this type from the input type.

impl<A: UnicastAddress + MappedAddress + SpecifiedAddress> From<UnicastAddr<NonMappedAddr<A>>> for SpecifiedAddr<A>

fn from(addr: UnicastAddr<NonMappedAddr<A>>) -> SpecifiedAddr<A>

Converts to this type from the input type.

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

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

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

impl<A: Hash> Hash for SpecifiedAddr<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 IpAddrWitness for SpecifiedAddr<IpAddr>

type V4 = SpecifiedAddr<Ipv4Addr>

The IPv4-specific version of Self.

type V6 = SpecifiedAddr<Ipv6Addr>

The IPv6-specific version of Self.

fn from_v4(addr: Self::V4) -> Self

Converts an IPv4-specific witness into a general witness.

fn from_v6(addr: Self::V6) -> Self

Converts an IPv6-specific witness into a general witness.

impl<A: IpAddress> IpAddressWitness<A> for SpecifiedAddr<A>

type IpAddrWitness = SpecifiedAddr<IpAddr>

The type-erased version of Self.

impl<A: LinkLocalAddress> LinkLocalAddress for SpecifiedAddr<A>

fn is_link_local(&self) -> bool

Is this a link-local address?

impl<A: MappedAddress> MappedAddress for SpecifiedAddr<A>

fn is_non_mapped(&self) -> bool

Is this a non-mapped address?

impl<A: MulticastAddress> MulticastAddress for SpecifiedAddr<A>

fn is_multicast(&self) -> bool

Is this a multicast address?

fn is_non_multicast(&self) -> bool

Is this a non-multicast address? The inverse of is_multicast().

impl<A: Ord> Ord for SpecifiedAddr<A>

fn cmp(&self, other: &SpecifiedAddr<A>) -> 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<A: PartialEq> PartialEq for SpecifiedAddr<A>

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

fn partial_cmp(&self, other: &SpecifiedAddr<A>) -> 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<A: ScopeableAddress> ScopeableAddress for SpecifiedAddr<A>

type Scope = <A as ScopeableAddress>::Scope

The type of all non-global scopes.

fn scope(&self) -> Self::Scope

The scope of this address.

impl<A: SpecifiedAddress> TransposableWitness<A> for SpecifiedAddr<A>

type Map<T> = SpecifiedAddr<T>

Maps the type wrapped by this witness.

impl TryFrom<Ipv4Addr> for SpecifiedAddr<Ipv4Addr>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(addr: Ipv4Addr) -> Result<SpecifiedAddr<Ipv4Addr>, ()>

Performs the conversion.

impl TryFrom<Ipv6Addr> for SpecifiedAddr<Ipv6Addr>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(addr: Ipv6Addr) -> Result<SpecifiedAddr<Ipv6Addr>, ()>

Performs the conversion.

impl<A: MappedAddress + SpecifiedAddress> TryFrom<NonMappedAddr<A>> for SpecifiedAddr<A>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(addr: NonMappedAddr<A>) -> Result<SpecifiedAddr<A>, ()>

Performs the conversion.

impl<A: SpecifiedAddress + BroadcastAddress> TryFrom<SpecifiedAddr<A>> for BroadcastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(addr: SpecifiedAddr<A>) -> Result<BroadcastAddr<A>, ()>

Performs the conversion.

impl<A: SpecifiedAddress + LinkLocalAddress> TryFrom<SpecifiedAddr<A>> for LinkLocalAddr<A>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(addr: SpecifiedAddr<A>) -> Result<LinkLocalAddr<A>, ()>

Performs the conversion.

impl<A: SpecifiedAddress + LinkLocalBroadcastAddress> TryFrom<SpecifiedAddr<A>> for LinkLocalBroadcastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(addr: SpecifiedAddr<A>) -> Result<LinkLocalBroadcastAddr<A>, ()>

Performs the conversion.

impl<A: SpecifiedAddress + LinkLocalMulticastAddress> TryFrom<SpecifiedAddr<A>> for LinkLocalMulticastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(addr: SpecifiedAddr<A>) -> Result<LinkLocalMulticastAddr<A>, ()>

Performs the conversion.

impl<A: SpecifiedAddress + LinkLocalUnicastAddress> TryFrom<SpecifiedAddr<A>> for LinkLocalUnicastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(addr: SpecifiedAddr<A>) -> Result<LinkLocalUnicastAddr<A>, ()>

Performs the conversion.

impl<A: SpecifiedAddress + MulticastAddress> TryFrom<SpecifiedAddr<A>> for MulticastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(addr: SpecifiedAddr<A>) -> Result<MulticastAddr<A>, ()>

Performs the conversion.

impl<A: SpecifiedAddress + MappedAddress> TryFrom<SpecifiedAddr<A>> for NonMappedAddr<A>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(addr: SpecifiedAddr<A>) -> Result<NonMappedAddr<A>, ()>

Performs the conversion.

impl<A: SpecifiedAddress + UnicastAddress> TryFrom<SpecifiedAddr<A>> for UnicastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(addr: SpecifiedAddr<A>) -> Result<UnicastAddr<A>, ()>

Performs the conversion.

impl<A: UnicastAddress> UnicastAddress for SpecifiedAddr<A>

fn is_unicast(&self) -> bool

Is this a unicast address?

impl<A: SpecifiedAddress> Witness<A> for SpecifiedAddr<A>

fn new(addr: A) -> Option<SpecifiedAddr<A>>

Constructs a new witness type.

unsafe fn new_unchecked(addr: A) -> SpecifiedAddr<A>

Constructs a new witness type without checking to see if addr actually satisfies the required property.

fn into_addr(self) -> A

Consumes this witness and returns the contained A.

fn from_witness<W: Witness<A>>(addr: W) -> Option<Self>

Constructs a new witness type from an existing witness type.

fn get(&self) -> A

where A: Copy,

Gets a copy of the address.

fn transpose<T>(self) -> A::Map<Self::Map<T>>

where Self: TransposableWitness<A>, A: TransposableWitness<T>, Self::Map<T>: Witness<T>, A::Map<Self::Map<T>>: Witness<Self::Map<T>>,

Transposes this witness type with another witness type layered inside of it. (e.g. UnicastAddr<SpecifiedAddr> -> SpecifiedAddr<UnicastAddr>)

impl<A: Copy> Copy for SpecifiedAddr<A>

impl<A: Eq> Eq for SpecifiedAddr<A>

impl<A> StructuralPartialEq for SpecifiedAddr<A>