Struct net_types::UnicastAddr

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

An address which is guaranteed to be unicast.

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

Implementations

impl<A: UnicastAddress> UnicastAddr<A>

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

Constructs a new UnicastAddr.

new returns None if !addr.is_unicast().

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

Constructs a new UnicastAddr from a witness type.

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

impl<A> UnicastAddr<A>

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

Constructs a new UnicastAddr without checking to see if addr is actually unicast.

Safety

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

impl<A: UnicastAddress + SpecifiedAddress> UnicastAddr<A>

pub fn into_specified(self) -> SpecifiedAddr<A>

Converts this UnicastAddr into a SpecifiedAddr.

UnicastAddress::is_unicast implies SpecifiedAddress::is_specified, so all UnicastAddrs are guaranteed to be specified, so this conversion is infallible.

impl<A: UnicastAddress + LinkLocalAddress> UnicastAddr<LinkLocalAddr<A>>

pub fn new_link_local(addr: A) -> Option<UnicastAddr<LinkLocalAddr<A>>>

Constructs a new UnicastAddr<LinkLocalAddr<A>>.

new_link_local(addr) is equivalent to LinkLocalAddr::new(addr).and_then(UnicastAddr::new)).

impl<A: UnicastAddress + MappedAddress> UnicastAddr<NonMappedAddr<A>>

pub fn new_non_mapped(addr: A) -> Option<UnicastAddr<NonMappedAddr<A>>>

Constructs a new UnicastAddr<NonMappedAddr<A>>.

new_non_mapped(addr) is equivalent to NonMappedAddr::new(addr).and_then(UnicastAddr::new)).

Trait Implementations

impl<A: UnicastAddress> AsRef<A> for UnicastAddr<A>

fn as_ref(&self) -> &A

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

impl<A: UnicastAddress + LinkLocalAddress> AsRef<A> for UnicastAddr<LinkLocalAddr<A>>

fn as_ref(&self) -> &A

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

impl<A: UnicastAddress + MappedAddress> AsRef<A> for UnicastAddr<NonMappedAddr<A>>

fn as_ref(&self) -> &A

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

impl<A: UnicastAddress> AsRef<UnicastAddr<A>> for UnicastAddr<A>

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

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

impl<A: BroadcastAddress> BroadcastAddress for UnicastAddr<A>

fn is_broadcast(&self) -> bool

Is this a broadcast address?

impl<A: Clone> Clone for UnicastAddr<A>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug> Debug for UnicastAddr<A>

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

Formats the value using the given formatter.

impl<A: UnicastAddress> Deref for UnicastAddr<A>

type Target = A

The resulting type after dereferencing.

fn deref(&self) -> &A

Dereferences the value.

impl<A: Display> Display for UnicastAddr<A>

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

Formats the value using the given formatter.

impl<A: Into<Ipv6Addr> + UnicastAddress + Copy> From<UnicastAddr<A>> for Ipv6Addr

fn from(addr: UnicastAddr<A>) -> 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 From<UnicastAddr<Ipv6Addr>> for UnicastAddr<IpAddr>

fn from(addr: UnicastAddr<Ipv6Addr>) -> UnicastAddr<IpAddr>

Converts to this type from the input type.

impl From<UnicastAddr<Ipv6Addr>> for UnicastOrMulticastIpv6Addr

fn from(addr: UnicastAddr<Ipv6Addr>) -> UnicastOrMulticastIpv6Addr

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 From<UnicastAddr<Mac>> for Mac

fn from(addr: UnicastAddr<Mac>) -> Mac

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: Hash> Hash for UnicastAddr<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: LinkLocalAddress> LinkLocalAddress for UnicastAddr<A>

fn is_link_local(&self) -> bool

Is this a link-local address?

impl<A: MappedAddress> MappedAddress for UnicastAddr<A>

fn is_non_mapped(&self) -> bool

Is this a non-mapped address?

impl<A: MulticastAddress> MulticastAddress for UnicastAddr<A>

fn is_multicast(&self) -> bool

Is this a unicast address?

impl<A: Ord> Ord for UnicastAddr<A>

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

Restrict a value to a certain interval.

impl<A: PartialEq> PartialEq for UnicastAddr<A>

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

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

fn is_specified(&self) -> bool

Is this a specified address?

impl<A: UnicastAddress> TransposableWitness<A> for UnicastAddr<A>

type Map<T> = UnicastAddr<T>

Maps the type wrapped by this witness.

impl<A: BroadcastAddress + UnicastAddress> TryFrom<BroadcastAddr<A>> for UnicastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Ipv6Addr> for UnicastAddr<Ipv6Addr>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: LinkLocalAddress + UnicastAddress> TryFrom<LinkLocalAddr<A>> for UnicastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: UnicastAddress + LinkLocalAddress> TryFrom<LinkLocalAddr<A>> for UnicastAddr<LinkLocalAddr<A>>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: LinkLocalBroadcastAddress + UnicastAddress> TryFrom<LinkLocalAddr<BroadcastAddr<A>>> for UnicastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: LinkLocalMulticastAddress + UnicastAddress> TryFrom<LinkLocalAddr<MulticastAddr<A>>> for UnicastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: LinkLocalUnicastAddress + UnicastAddress> TryFrom<LinkLocalAddr<UnicastAddr<A>>> for UnicastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: MulticastAddress + UnicastAddress> TryFrom<MulticastAddr<A>> for UnicastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: MappedAddress + UnicastAddress> TryFrom<NonMappedAddr<A>> for UnicastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: UnicastAddress + MappedAddress> TryFrom<NonMappedAddr<A>> for UnicastAddr<NonMappedAddr<A>>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(addr: NonMappedAddr<A>) -> Result<UnicastAddr<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 + BroadcastAddress> TryFrom<UnicastAddr<A>> for BroadcastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: UnicastAddress + LinkLocalAddress> TryFrom<UnicastAddr<A>> for LinkLocalAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: UnicastAddress + LinkLocalBroadcastAddress> TryFrom<UnicastAddr<A>> for LinkLocalBroadcastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: UnicastAddress + LinkLocalMulticastAddress> TryFrom<UnicastAddr<A>> for LinkLocalMulticastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: LinkLocalAddress + UnicastAddress> TryFrom<UnicastAddr<A>> for LinkLocalAddr<UnicastAddr<A>>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: UnicastAddress + MulticastAddress> TryFrom<UnicastAddr<A>> for MulticastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: UnicastAddress + MappedAddress> TryFrom<UnicastAddr<A>> for NonMappedAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: MappedAddress + UnicastAddress> TryFrom<UnicastAddr<A>> for NonMappedAddr<UnicastAddr<A>>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: UnicastAddress + LinkLocalAddress> TryFrom<UnicastAddr<A>> for UnicastAddr<LinkLocalAddr<A>>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: UnicastAddress + MappedAddress> TryFrom<UnicastAddr<A>> for UnicastAddr<NonMappedAddr<A>>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: UnicastAddress> Witness<A> for UnicastAddr<A>

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

Constructs a new witness type.

unsafe fn new_unchecked(addr: A) -> UnicastAddr<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 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: UnicastAddress + LinkLocalAddress> Witness<A> for UnicastAddr<LinkLocalAddr<A>>

fn new(addr: A) -> Option<UnicastAddr<LinkLocalAddr<A>>>

Constructs a new witness type.

unsafe fn new_unchecked(addr: A) -> UnicastAddr<LinkLocalAddr<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.

impl<A: UnicastAddress + MappedAddress> Witness<A> for UnicastAddr<NonMappedAddr<A>>

fn new(addr: A) -> Option<UnicastAddr<NonMappedAddr<A>>>

Constructs a new witness type.

unsafe fn new_unchecked(addr: A) -> UnicastAddr<NonMappedAddr<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.

impl<A: Copy> Copy for UnicastAddr<A>

impl<A: Eq> Eq for UnicastAddr<A>

impl<A> StructuralPartialEq for UnicastAddr<A>