Struct MacAddress

#[repr(C)]
pub struct MacAddress { /* private fields */ }

A MAC address (EUI-48)

Implementations

impl MacAddress

pub const fn new(eui: Eui48) -> MacAddress

Create a new MacAddress from [u8; 6].

pub fn from_bytes(bytes: &[u8]) -> Result<Self, ParseError>

Create a new MacAddress from a byte slice.

Returns an error (without any description) if the slice doesn’t have the proper length.

pub fn nil() -> MacAddress

Returns empty EUI-48 address

pub fn broadcast() -> MacAddress

Returns ‘ff:ff:ff:ff:ff:ff’, a MAC broadcast address

pub fn is_nil(&self) -> bool

Returns true if the address is ‘00:00:00:00:00:00’

pub fn is_broadcast(&self) -> bool

Returns true if the address is ‘ff:ff:ff:ff:ff:ff’

pub fn is_unicast(&self) -> bool

Returns true if bit 1 of Y is 0 in address ‘xY:xx:xx:xx:xx:xx’

pub fn is_multicast(&self) -> bool

Returns true if bit 1 of Y is 1 in address ‘xY:xx:xx:xx:xx:xx’

pub fn is_universal(&self) -> bool

Returns true if bit 2 of Y is 0 in address ‘xY:xx:xx:xx:xx:xx’

pub fn is_local(&self) -> bool

Returns true if bit 2 of Y is 1 in address ‘xY:xx:xx:xx:xx:xx’

pub fn to_canonical(&self) -> String

Returns a String representation in the format ‘00-00-00-00-00-00’

pub fn to_hex_string(&self) -> String

Returns a String representation in the format ‘00:00:00:00:00:00’

pub fn to_dot_string(&self) -> String

Returns a String representation in the format ‘0000.0000.0000’

pub fn to_hexadecimal(&self) -> String

Returns a String representation in the format ‘0x000000000000’

pub fn to_interfaceid(&self) -> String

Returns a String representation in the EUI-64 interface ID format ‘0000:00ff:fe00:0000’

pub fn to_link_local(&self) -> String

Returns a String representation in the IPv6 link local format ‘fe80::0000:00ff:fe00:0000’

pub fn to_string(&self, fmt: MacAddressFormat) -> String

Returns a String in the format selected by fmt

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

Parses a String representation from any format supported

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

Return the internal structure as a slice of bytes

pub fn to_array(&self) -> Eui48

Returns an array in Eui48. Works as an inverse function of new()

pub fn get_display_format() -> MacAddressFormat

Returns Display MacAddressFormat, determined at compile time.

Trait Implementations

impl Clone for MacAddress

fn clone(&self) -> MacAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MacAddress

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

Debug format for MacAddress is HexString notation

impl Decodable for MacAddress

fn decode<D: Decoder>(d: &mut D) -> Result<MacAddress, D::Error>

Decode a MacAddress from a string in canonical form

impl Default for MacAddress

fn default() -> MacAddress

Create a Default MacAddress (00-00-00-00-00-00)

impl Display for MacAddress

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

Display format is canonical format (00-00-00-00-00-00) by default

impl Encodable for MacAddress

fn encode<E: Encoder>(&self, e: &mut E) -> Result<(), E::Error>

Encode a MacAddress using the default format

impl FromStr for MacAddress

fn from_str(us: &str) -> Result<MacAddress, ParseError>

Create a MacAddress from String

type Err = ParseError

The associated error which can be returned from parsing.

impl Hash for MacAddress

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 Ord for MacAddress

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

Restrict a value to a certain interval.

impl PartialEq for MacAddress

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

fn partial_cmp(&self, other: &MacAddress) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for MacAddress

impl Eq for MacAddress

impl StructuralPartialEq for MacAddress