Struct advmac::MacAddr8

#[repr(transparent)]
pub struct MacAddr8(_);

MAC address, represented as EUI-64

Implementations

impl MacAddr8

pub const fn new(eui: [u8; 8]) -> Self

pub fn random() -> Self

Available on crate feature rand only.

pub const fn broadcast() -> Self

pub const fn nil() -> Self

pub fn set_local(&mut self, v: bool)

Sets locally administered flag

pub const fn is_local(&self) -> bool

Returns the state of locally administered flag

pub fn set_multicast(&mut self, v: bool)

Sets multicast flag

pub const fn is_multicast(&self) -> bool

Returns the state of multicast flag

pub const fn oui(&self) -> [u8; 3]

Returns organizationally unique identifier (OUI) of this MAC address

pub fn set_oui(&mut self, oui: [u8; 3])

Sets organizationally unique identifier (OUI) for this MAC address

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

Returns internal array representation for this MAC address, consuming it

pub const fn as_slice(&self) -> &[u8]

Returns internal array representation for this MAC address as u8 slice

pub fn as_mut_slice(&mut self) -> &mut [u8]

Returns internal array representation for this MAC address as mutable u8 slice

pub const fn as_c_slice(&self) -> &[c_char]

Returns internal array representation for this MAC address as core::ffi::c_char slice. This can be useful in parsing ifr_hwaddr, for example.

pub const fn parse_str(s: &str) -> Result<Self, ParseError>

Parse MAC address from string and return it as MacAddr. This function can be used in const context, so MAC address can be parsed in compile-time.

pub fn format_write<T: Write>(&self, f: &mut T, format: MacAddrFormat) -> Result

Write MAC address to impl core::fmt::Write, which can be used in no_std environments.

It can be used like this with arrayvec::ArrayString without allocations:

use arrayvec::ArrayString;
use advmac::{MacAddr6, MacAddrFormat, MAC_CANONICAL_SIZE6};

let mac = MacAddr6::parse_str("AA:BB:CC:DD:EE:FF").unwrap();

let mut buf = ArrayString::<MAC_CANONICAL_SIZE6>::new();
mac.format_write(&mut buf, MacAddrFormat::Canonical).unwrap();

pub fn format_string(&self, format: MacAddrFormat) -> String

Available on crate feature std only.

Write MAC address to String. This function uses Self::format_write internally and produces the same result, but in string form, which can be convenient in non-constrainted environments.

Trait Implementations

impl Clone for MacAddr8

fn clone(&self) -> MacAddr8

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MacAddr8

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

Formats the value using the given formatter.

impl Default for MacAddr8

fn default() -> MacAddr8

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MacAddr8

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for MacAddr8

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

Formats the value using the given formatter.

impl From<[u8; 8]> for MacAddr8

fn from(arr: [u8; 8]) -> Self

Converts to this type from the input type.

impl FromStr for MacAddr8

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for MacAddr8

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,

Feeds a slice of this type into the given Hasher.

impl Ord for MacAddr8

fn cmp(&self, other: &MacAddr8) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<MacAddr8> for MacAddr8

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

fn partial_cmp(&self, other: &MacAddr8) -> 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 Serialize for MacAddr8

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl TryFrom<&[i8]> for MacAddr8

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: &[c_char]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&[u8]> for MacAddr8

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for MacAddr8

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for MacAddr8

Available on crate feature std only.

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for MacAddr8

impl Eq for MacAddr8

impl StructuralEq for MacAddr8

impl StructuralPartialEq for MacAddr8