Struct net_types::MulticastAddr

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

An address which is guaranteed to be multicast.

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

Implementations

impl<A: MulticastAddress> MulticastAddr<A>

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

Constructs a new MulticastAddr.

new returns None if !addr.is_multicast().

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

Constructs a new MulticastAddr from a witness type.

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

impl<A> MulticastAddr<A>

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

Constructs a new MulticastAddr without checking to see if addr is actually multicast.

Safety

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

impl<A: MulticastAddress + SpecifiedAddress> MulticastAddr<A>

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

Converts this MulticastAddr into a SpecifiedAddr.

MulticastAddress::is_multicast implies SpecifiedAddress::is_specified, so all MulticastAddrs are guaranteed to be specified, so this conversion is infallible.

impl<A: MulticastAddress + MappedAddress> MulticastAddr<A>

pub fn non_mapped(self) -> NonMappedAddr<MulticastAddr<A>>

Wraps self in the NonMappedAddr witness type.

Trait Implementations

impl<A: MulticastAddress> AsRef<A> for MulticastAddr<A>

fn as_ref(&self) -> &A

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

impl<A: MulticastAddress + LinkLocalAddress> AsRef<A> for MulticastAddr<LinkLocalAddr<A>>

fn as_ref(&self) -> &A

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

impl<A: MulticastAddress + MappedAddress> AsRef<A> for MulticastAddr<NonMappedAddr<A>>

fn as_ref(&self) -> &A

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

impl<A: MulticastAddress> AsRef<MulticastAddr<A>> for MulticastAddr<A>

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

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

impl<A: BroadcastAddress> BroadcastAddress for MulticastAddr<A>

fn is_broadcast(&self) -> bool

Is this a broadcast address?

impl<A: Clone> Clone for MulticastAddr<A>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug> Debug for MulticastAddr<A>

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

Formats the value using the given formatter.

impl<A: MulticastAddress> Deref for MulticastAddr<A>

type Target = A

The resulting type after dereferencing.

fn deref(&self) -> &A

Dereferences the value.

impl<A: Display> Display for MulticastAddr<A>

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

Formats the value using the given formatter.

impl<'a, A: IpAddress> From<&'a MulticastAddr<A>> for Mac

fn from(addr: &'a MulticastAddr<A>) -> Mac

Converts a multicast IP address to a MAC address.

This method is equivalent to MulticastAddr::<Mac>::from(addr).get().

impl<'a, A: IpAddress> From<&'a MulticastAddr<A>> for MulticastAddr<Mac>

fn from(addr: &'a MulticastAddr<A>) -> MulticastAddr<Mac>

Converts a multicast IP address to a multicast MAC address.

When a multicast IP packet is sent over an Ethernet link, the frame’s destination MAC address is a multicast MAC address that is derived from the destination IP address. This function performs that conversion.

See RFC 7042 Section 2.1.1 and Section 2.3.1 for details on how IPv4 and IPv6 addresses are mapped, respectively.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<A: Into<Ipv4Addr> + MulticastAddress + Copy> From<MulticastAddr<A>> for Ipv4Addr

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

Converts to this type from the input type.

impl<A: Into<Ipv6Addr> + MulticastAddress + Copy> From<MulticastAddr<A>> for Ipv6Addr

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

Converts to this type from the input type.

impl<A: IpAddress> From<MulticastAddr<A>> for Mac

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

Converts a multicast IP address to a MAC address.

This method is equivalent to (&addr).into().

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

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

Converts to this type from the input type.

impl<A: IpAddress> From<MulticastAddr<A>> for MulticastAddr<Mac>

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

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 From<MulticastAddr<IpAddr>> for IpAddr<MulticastAddr<Ipv4Addr>, MulticastAddr<Ipv6Addr>>

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

Converts to this type from the input type.

impl From<MulticastAddr<Ipv6Addr>> for UnicastOrMulticastIpv6Addr

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

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

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

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: IpAddress, I: Ip> GenericOverIp<I> for MulticastAddr<A>

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

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

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

type V4 = MulticastAddr<Ipv4Addr>

The IPv4-specific version of Self.

type V6 = MulticastAddr<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 MulticastAddr<A>

type IpAddrWitness = MulticastAddr<IpAddr>

The type-erased version of Self.

impl<A: LinkLocalAddress> LinkLocalAddress for MulticastAddr<A>

fn is_link_local(&self) -> bool

Is this a link-local address?

impl<A: MappedAddress> MappedAddress for MulticastAddr<A>

fn is_non_mapped(&self) -> bool

Is this a non-mapped address?

impl<A: Ord> Ord for MulticastAddr<A>

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

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

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

fn is_specified(&self) -> bool

Is this a specified address?

impl<A: MulticastAddress> TransposableWitness<A> for MulticastAddr<A>

type Map<T> = MulticastAddr<T>

Maps the type wrapped by this witness.

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 TryFrom<Ipv4Addr> for MulticastAddr<Ipv4Addr>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Ipv6Addr> for MulticastAddr<Ipv6Addr>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: LinkLocalAddress + MulticastAddress> TryFrom<LinkLocalAddr<A>> for MulticastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: LinkLocalBroadcastAddress + MulticastAddress> TryFrom<LinkLocalAddr<BroadcastAddr<A>>> for MulticastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: LinkLocalMulticastAddress + MulticastAddress> TryFrom<LinkLocalAddr<MulticastAddr<A>>> for MulticastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: LinkLocalUnicastAddress + MulticastAddress> TryFrom<LinkLocalAddr<UnicastAddr<A>>> for MulticastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(addr: LinkLocalUnicastAddr<A>) -> Result<MulticastAddr<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: MulticastAddress + LinkLocalAddress> TryFrom<MulticastAddr<A>> for LinkLocalAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: MulticastAddress + LinkLocalBroadcastAddress> TryFrom<MulticastAddr<A>> for LinkLocalBroadcastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: MulticastAddress + LinkLocalUnicastAddress> TryFrom<MulticastAddr<A>> for LinkLocalUnicastAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A: MulticastAddress + MappedAddress> TryFrom<MulticastAddr<A>> for NonMappedAddr<A>

type Error = ()

The type returned in the event of a conversion error.

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

type Error = ()

The type returned in the event of a conversion error.

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

fn is_unicast(&self) -> bool

Is this a unicast address?

impl<A: MulticastAddress> Witness<A> for MulticastAddr<A>

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

Constructs a new witness type.

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

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

Constructs a new witness type.

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

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

Constructs a new witness type.

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

impl<A: Eq> Eq for MulticastAddr<A>

impl<A> StructuralPartialEq for MulticastAddr<A>