Struct net_types::BroadcastAddr

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

An address which is guaranteed to be broadcast.

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

Implementations

impl<A: BroadcastAddress> BroadcastAddr<A>

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

Constructs a new BroadcastAddr.

new returns None if !addr.is_broadcast().

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

Constructs a new BroadcastAddr from a witness type.

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

impl<A> BroadcastAddr<A>

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

Constructs a new BroadcastAddr without checking to see if addr is actually broadcast.

Safety

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

impl<A: BroadcastAddress + SpecifiedAddress> BroadcastAddr<A>

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

Converts this BroadcastAddr into a SpecifiedAddr.

BroadcastAddress::is_broadcast implies SpecifiedAddress::is_specified, so all BroadcastAddrs are guaranteed to be specified, so this conversion is infallible.

impl<A: BroadcastAddress + LinkLocalAddress> BroadcastAddr<LinkLocalAddr<A>>

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

Constructs a new BroadcastAddr<LinkLocalAddr<A>>.

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

impl<A: BroadcastAddress + MappedAddress> BroadcastAddr<NonMappedAddr<A>>

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

Constructs a new BroadcastAddr<NonMappedAddr<A>>.

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

Trait Implementations

impl<A: BroadcastAddress> AsRef<A> for BroadcastAddr<A>

fn as_ref(&self) -> &A

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

impl<A: BroadcastAddress + LinkLocalAddress> AsRef<A> for BroadcastAddr<LinkLocalAddr<A>>

fn as_ref(&self) -> &A

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

impl<A: BroadcastAddress + MappedAddress> AsRef<A> for BroadcastAddr<NonMappedAddr<A>>

fn as_ref(&self) -> &A

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

impl<A: BroadcastAddress> AsRef<BroadcastAddr<A>> for BroadcastAddr<A>

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

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

impl<A: Clone> Clone for BroadcastAddr<A>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug> Debug for BroadcastAddr<A>

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

Formats the value using the given formatter.

impl<A: BroadcastAddress> Deref for BroadcastAddr<A>

type Target = A

The resulting type after dereferencing.

fn deref(&self) -> &A

Dereferences the value.

impl<A: Display> Display for BroadcastAddr<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 From<BroadcastAddr<Mac>> for Mac

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

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

fn is_link_local(&self) -> bool

Is this a link-local address?

impl<A: MappedAddress> MappedAddress for BroadcastAddr<A>

fn is_non_mapped(&self) -> bool

Is this a non-mapped address?

impl<A: MulticastAddress> MulticastAddress for BroadcastAddr<A>

fn is_multicast(&self) -> bool

Is this a unicast address?

impl<A: Ord> Ord for BroadcastAddr<A>

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

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

fn partial_cmp(&self, other: &BroadcastAddr<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 BroadcastAddr<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 BroadcastAddr<A>

fn is_specified(&self) -> bool

Is this a specified address?

impl<A: BroadcastAddress> TransposableWitness<A> for BroadcastAddr<A>

type Map<T> = BroadcastAddr<T>

Maps the type wrapped by this witness.

impl<A: BroadcastAddress + LinkLocalAddress> TryFrom<BroadcastAddr<A>> for BroadcastAddr<LinkLocalAddr<A>>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: BroadcastAddress + MappedAddress> TryFrom<BroadcastAddr<A>> for BroadcastAddr<NonMappedAddr<A>>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: BroadcastAddress + LinkLocalAddress> TryFrom<BroadcastAddr<A>> for LinkLocalAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: LinkLocalAddress + BroadcastAddress> TryFrom<BroadcastAddr<A>> for LinkLocalAddr<BroadcastAddr<A>>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: BroadcastAddress + LinkLocalMulticastAddress> TryFrom<BroadcastAddr<A>> for LinkLocalMulticastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: BroadcastAddress + LinkLocalUnicastAddress> TryFrom<BroadcastAddr<A>> for LinkLocalUnicastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: BroadcastAddress + MulticastAddress> TryFrom<BroadcastAddr<A>> for MulticastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: BroadcastAddress + MappedAddress> TryFrom<BroadcastAddr<A>> for NonMappedAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: MappedAddress + BroadcastAddress> TryFrom<BroadcastAddr<A>> for NonMappedAddr<BroadcastAddr<A>>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

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<A: LinkLocalAddress + BroadcastAddress> TryFrom<LinkLocalAddr<A>> for BroadcastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: BroadcastAddress + LinkLocalAddress> TryFrom<LinkLocalAddr<A>> for BroadcastAddr<LinkLocalAddr<A>>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: MulticastAddress + BroadcastAddress> TryFrom<MulticastAddr<A>> for BroadcastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: MappedAddress + BroadcastAddress> TryFrom<NonMappedAddr<A>> for BroadcastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: BroadcastAddress + MappedAddress> TryFrom<NonMappedAddr<A>> for BroadcastAddr<NonMappedAddr<A>>

type Error = ()

The type returned in the event of a conversion error.

fn try_from( addr: NonMappedAddr<A> ) -> Result<BroadcastAddr<NonMappedAddr<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: 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> UnicastAddress for BroadcastAddr<A>

fn is_unicast(&self) -> bool

Is this a unicast address?

impl<A: BroadcastAddress> Witness<A> for BroadcastAddr<A>

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

Constructs a new witness type.

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

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

Constructs a new witness type.

unsafe fn new_unchecked(addr: A) -> BroadcastAddr<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: BroadcastAddress + MappedAddress> Witness<A> for BroadcastAddr<NonMappedAddr<A>>

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

Constructs a new witness type.

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

impl<A: Eq> Eq for BroadcastAddr<A>

impl<A> StructuralPartialEq for BroadcastAddr<A>