Skip to main content

DeviceAlias

Struct DeviceAlias 

Source
pub struct DeviceAlias {
    pub alias: String,
    pub serial: Option<String>,
    pub name: Option<String>,
    pub mac_address: Option<String>,
    pub macos_uuid: Option<String>,
    pub notes: Option<String>,
    pub created_at: Option<String>,
    pub updated_at: Option<String>,
}
Expand description

A cross-platform device alias that can store multiple identifiers.

This allows identifying the same physical device across different platforms and machines, where the identifier format varies.

§Example

use aranet_core::platform::DeviceAlias;

let alias = DeviceAlias::new("Living Room")
    .with_serial("SN123456")
    .with_name("Aranet4 12345")
    .with_mac("AA:BB:CC:DD:EE:FF");

// Get the best identifier for the current platform
let id = alias.resolve();

Fields§

§alias: String

User-friendly name for this device.

§serial: Option<String>

Device serial number (most reliable cross-platform ID).

§name: Option<String>

Device name (e.g., “Aranet4 12345”).

§mac_address: Option<String>

Bluetooth MAC address (Linux/Windows).

§macos_uuid: Option<String>

CoreBluetooth UUID (macOS only).

§notes: Option<String>

Notes or description for this device.

§created_at: Option<String>

When this alias was created.

§updated_at: Option<String>

When this alias was last updated.

Implementations§

Source§

impl DeviceAlias

Source

pub fn new(alias: impl Into<String>) -> Self

Create a new device alias with the given user-friendly name.

Source

pub fn with_serial(self, serial: impl Into<String>) -> Self

Set the device serial number.

Source

pub fn with_name(self, name: impl Into<String>) -> Self

Set the device name.

Source

pub fn with_mac(self, mac: impl Into<String>) -> Self

Set the MAC address (for Linux/Windows).

Source

pub fn with_uuid(self, uuid: impl Into<String>) -> Self

Set the macOS UUID.

Source

pub fn with_notes(self, notes: impl Into<String>) -> Self

Set notes for this device.

Source

pub fn resolve(&self) -> Option<String>

Resolve the alias to a platform-appropriate identifier.

Resolution order:

  1. On macOS: macos_uuid → name → serial
  2. On Linux/Windows: mac_address → name → serial

Returns None if no suitable identifier is available.

Source

pub fn matches(&self, identifier: &str) -> bool

Check if this alias matches a given identifier.

This checks against all stored identifiers (serial, name, MAC, UUID).

Source

pub fn update_identifier(&mut self, identifier: &str)

Update the platform-specific identifier.

Call this after connecting to a device to update the alias with the current platform’s identifier.

Trait Implementations§

Source§

impl Clone for DeviceAlias

Source§

fn clone(&self) -> DeviceAlias

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DeviceAlias

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for DeviceAlias

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for DeviceAlias

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,