Struct MacAddress 

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

Available on crate feature net only.

A MAC address.

This type provides type-safe MAC addresses with IEEE 802 validation. It uses the newtype pattern with #[repr(transparent)] for zero-cost abstraction.

Invariants

• Exactly 6 bytes (48 bits)
• Each octet is 0-255

Examples

use bare_types::net::MacAddress;

// Create a MAC address
let mac = MacAddress::new([0x00, 0x11, 0x22, 0x33, 0x44, 0x55])?;

// Access the string representation
assert_eq!(mac.as_str(), "00:11:22:33:44:55");

// Check if it's unicast
assert!(mac.is_unicast());

// Get the octets
assert_eq!(mac.octets(), [0x00, 0x11, 0x22, 0x33, 0x44, 0x55]);

// Parse from string
let mac: MacAddress = "00:11:22:33:44:55".parse()?;

Implementations

impl MacAddress

pub const fn new(octets: [u8; 6]) -> Result<Self, MacAddressError>

Creates a new MAC address from an array of 6 bytes.

Errors

Returns MacAddressError if the array is not exactly 6 bytes.

Examples

use bare_types::net::MacAddress;

let mac = MacAddress::new([0x00, 0x11, 0x22, 0x33, 0x44, 0x55])?;
assert_eq!(mac.as_str(), "00:11:22:33:44:55");

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

Creates a new MAC address from a slice of bytes.

Errors

Returns MacAddressError if the slice is not exactly 6 bytes.

Examples

use bare_types::net::MacAddress;

let bytes = vec![0x00, 0x11, 0x22, 0x33, 0x44, 0x55];
let mac = MacAddress::from_bytes(&bytes)?;
assert_eq!(mac.as_str(), "00:11:22:33:44:55");

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

Creates a new MAC address from a string.

Errors

Returns MacAddressError if of string is not in a valid format.

Examples

use bare_types::net::MacAddress;

let mac = MacAddress::from_str("00:11:22:33:44:55")?;
assert_eq!(mac.as_str(), "00:11:22:33:44:55");

pub fn as_str(&self) -> String

Returns the MAC address as a string slice in colon-separated format.

Examples

use bare_types::net::MacAddress;

let mac = MacAddress::new([0x00, 0x11, 0x22, 0x33, 0x44, 0x55]).unwrap();
assert_eq!(mac.as_str(), "00:11:22:33:44:55");

pub fn as_str_dash(&self) -> String

Returns the MAC address as a string slice in dash-separated format.

Examples

use bare_types::net::MacAddress;

let mac = MacAddress::new([0x00, 0x11, 0x22, 0x33, 0x44, 0x55]).unwrap();
assert_eq!(mac.as_str_dash(), "00-11-22-33-44-55");

pub fn as_str_lower(&self) -> String

Returns the MAC address as a string slice in lowercase colon-separated format.

Examples

use bare_types::net::MacAddress;

let mac = MacAddress::new([0x00, 0x11, 0x22, 0x33, 0x44, 0x55]).unwrap();
assert_eq!(mac.as_str_lower(), "00:11:22:33:44:55");

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

Returns a reference to the underlying array of 6 bytes.

Examples

use bare_types::net::MacAddress;

let mac = MacAddress::new([0x00, 0x11, 0x22, 0x33, 0x44, 0x55]).unwrap();
let octets: &[u8; 6] = mac.as_inner();
assert_eq!(octets, &[0x00, 0x11, 0x22, 0x33, 0x44, 0x55]);

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

Consumes this MAC address and returns the underlying array of 6 bytes.

Examples

use bare_types::net::MacAddress;

let mac = MacAddress::new([0x00, 0x11, 0x22, 0x33, 0x44, 0x55]).unwrap();
let octets = mac.into_inner();
assert_eq!(octets, [0x00, 0x11, 0x22, 0x33, 0x44, 0x55]);

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

Returns the octets of the MAC address.

Examples

use bare_types::net::MacAddress;

let mac = MacAddress::new([0x00, 0x11, 0x22, 0x33, 0x44, 0x55]).unwrap();
assert_eq!(mac.octets(), [0x00, 0x11, 0x22, 0x33, 0x44, 0x55]);

pub const fn is_unicast(&self) -> bool

Returns true if this is a unicast MAC address.

The least significant bit of the first octet indicates unicast (0) or multicast (1).

Examples

use bare_types::net::MacAddress;

let mac = MacAddress::new([0x00, 0x11, 0x22, 0x33, 0x44, 0x55]).unwrap();
assert!(mac.is_unicast());

pub const fn is_multicast(&self) -> bool

Returns true if this is a multicast MAC address.

The least significant bit of the first octet indicates unicast (0) or multicast (1).

Examples

use bare_types::net::MacAddress;

let mac = MacAddress::new([0x01, 0x11, 0x22, 0x33, 0x44, 0x55]).unwrap();
assert!(mac.is_multicast());

pub const fn is_globally_administered(&self) -> bool

Returns true if this is a globally administered MAC address.

The second least significant bit of the first octet indicates globally (0) or locally (1) administered.

Examples

use bare_types::net::MacAddress;

let mac = MacAddress::new([0x00, 0x11, 0x22, 0x33, 0x44, 0x55]).unwrap();
assert!(mac.is_globally_administered());

pub const fn is_locally_administered(&self) -> bool

Returns true if this is a locally administered MAC address.

The second least significant bit of the first octet indicates globally (0) or locally (1) administered.

Examples

use bare_types::net::MacAddress;

let mac = MacAddress::new([0x02, 0x11, 0x22, 0x33, 0x44, 0x55]).unwrap();
assert!(mac.is_locally_administered());

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

Returns the OUI (Organizationally Unique Identifier) of the MAC address.

The OUI is the first 3 octets of the MAC address.

Examples

use bare_types::net::MacAddress;

let mac = MacAddress::new([0x00, 0x11, 0x22, 0x33, 0x44, 0x55]).unwrap();
assert_eq!(mac.oui(), [0x00, 0x11, 0x22]);

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

Returns the NIC (Network Interface Controller) specific part of the MAC address.

The NIC specific part is the last 3 octets of the MAC address.

Examples

use bare_types::net::MacAddress;

let mac = MacAddress::new([0x00, 0x11, 0x22, 0x33, 0x44, 0x55]).unwrap();
assert_eq!(mac.nic(), [0x33, 0x44, 0x55]);

Trait Implementations

impl<'a> Arbitrary<'a> for MacAddress

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for MacAddress

fn clone(&self) -> MacAddress

Returns a duplicate 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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MacAddress

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MacAddress

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

Formats the value using the given formatter.

impl From<[u8; 6]> for MacAddress

fn from(octets: [u8; 6]) -> Self

Converts to this type from the input type.

impl From<MacAddress> for [u8; 6]

fn from(mac: MacAddress) -> Self

Converts to this type from the input type.

impl FromStr for MacAddress

type Err = MacAddressError

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for MacAddress

type Error = MacAddressError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&str> for MacAddress

type Error = MacAddressError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Zeroize for MacAddress

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Copy for MacAddress

impl Eq for MacAddress

impl StructuralPartialEq for MacAddress