Struct Mac

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

A media access control (MAC) address.

MAC addresses are used to identify devices in the Ethernet protocol.

MAC addresses can be derived from multicast IP addresses; see the From implementation for more details.

Layout

Mac has the same layout as [u8; 6], which is the layout that most protocols use to represent a MAC address in their packet formats. This can be useful when parsing a MAC address from a packet. For example:

/// The header of an Ethernet frame.
///
/// `EthernetHeader` has the same layout as the header of an Ethernet frame.
#[repr(C)]
struct EthernetHeader {
    dst: Mac,
    src: Mac,
    ethertype: [u8; 2],
}

Implementations

impl Mac

pub const BYTES: usize = 6usize

The number of bytes in a Mac address.

pub const BROADCAST: Mac

The broadcast MAC address.

The broadcast MAC address, FF:FF:FF:FF:FF:FF, indicates that a frame should be received by all receivers regardless of their local MAC address.

pub const DEFAULT_EUI_MAGIC: [u8; 2]

The default RFC 4291 EUI-64 magic value used by the to_eui64 method.

pub const UNSPECIFIED: Mac

The all-zeroes MAC address.

pub const fn new(bytes: [u8; 6]) -> Mac

Constructs a new MAC address.

pub const fn bytes(self) -> [u8; 6]

Gets the bytes of the MAC address.

pub fn to_eui64(self) -> [u8; 8]

Returns the RFC 4291 EUI-64 interface identifier for this MAC address with the default EUI magic value.

mac.to_eui64() is equivalent to mac.to_eui64_with_magic(Mac::DEFAULT_EUI_MAGIC).

pub fn to_eui64_with_magic(self, eui_magic: [u8; 2]) -> [u8; 8]

Returns the RFC 4291 EUI-64 interface identifier for this MAC address with a custom EUI magic value.

eui_magic is the two bytes that are inserted between the bytes of the MAC address to form the identifier. Also see the to_eui64 method, which uses the default magic value of 0xFFFE.

pub fn to_ipv6_link_local( self, ) -> AddrSubnet<Ipv6Addr, LinkLocalUnicastAddr<Ipv6Addr>>

Returns the link-local unicast IPv6 address and subnet for this MAC address, as per [RFC 4862], with the default EUI magic value.

mac.to_ipv6_link_local() is equivalent to mac.to_ipv6_link_local_with_magic(Mac::DEFAULT_EUI_MAGIC).

pub fn to_ipv6_link_local_with_magic( self, eui_magic: [u8; 2], ) -> AddrSubnet<Ipv6Addr, LinkLocalUnicastAddr<Ipv6Addr>>

Returns the link-local unicast IPv6 address and subnet for this MAC address, as per RFC 4862.

eui_magic is the two bytes that are inserted between the bytes of the MAC address to form the identifier. Also see the to_ipv6_link_local method, which uses the default magic value of 0xFFFE.

The subnet prefix length is 128 - Ipv6::UNICAST_INTERFACE_IDENTIFIER_BITS.

Trait Implementations

impl AsMut<[u8]> for Mac

fn as_mut(&mut self) -> &mut [u8]

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

impl AsRef<[u8]> for Mac

fn as_ref(&self) -> &[u8]

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

impl BroadcastAddress for Mac

fn is_broadcast(&self) -> bool

Is this the broadcast MAC address?

Returns true if this is the broadcast MAC address, FF:FF:FF:FF:FF:FF. Note that the broadcast address is also considered a multicast address, so addr.is_broadcast() implies addr.is_multicast().

impl Clone for Mac

fn clone(&self) -> Mac

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mac

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

Formats the value using the given formatter.

impl Display for Mac

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

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

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

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

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 FromBytes for Mac

where [u8; 6]: FromBytes,

fn ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the given source as a &Self.

fn ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the prefix of the given source as a &Self without copying.

fn ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: Immutable + KnownLayout,

Interprets the suffix of the given bytes as a &Self.

fn mut_from_bytes( source: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the given source as a &mut Self.

fn mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the prefix of the given source as a &mut Self without copying.

fn mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the suffix of the given source as a &mut Self without copying.

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

impl FromZeros for Mac

where [u8; 6]: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl Hash for Mac

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 IntoBytes for Mac

where [u8; 6]: IntoBytes,

fn as_bytes(&self) -> &[u8]

where Self: Immutable,

Gets the bytes of this value.

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

impl KnownLayout for Mac

where Self: Sized,

type PointerMetadata = ()

The type of metadata stored in a pointer to Self.

impl MulticastAddress for Mac

fn is_multicast(&self) -> bool

Is this a multicast MAC address?

Returns true if the least significant bit of the first byte of the address is 1.

fn is_non_multicast(&self) -> bool

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

impl PartialEq for Mac

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

where [u8; 6]: TryFromBytes,

fn try_ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the given source as a &Self.

fn try_ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the prefix of the given source as a &Self.

fn try_ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the suffix of the given source as a &Self.

fn try_mut_from_bytes( bytes: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout,

Attempts to interpret the given source as a &mut Self without copying.

fn try_mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout,

Attempts to interpret the prefix of the given source as a &mut Self.

fn try_mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout,

Attempts to interpret the suffix of the given source as a &mut Self.

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.

impl UnicastAddress for Mac

fn is_unicast(&self) -> bool

Is this a unicast MAC address?

Returns true if the least significant bit of the first byte of the address is 0.

impl Copy for Mac

impl Eq for Mac

impl Immutable for Mac

where [u8; 6]: Immutable,

impl StructuralPartialEq for Mac

impl Unaligned for Mac

where [u8; 6]: Unaligned,