Struct MlxDeviceHandle 

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

Owned MLX device handle released exactly once through the official C API.

Implementations

impl MlxDeviceHandle

pub fn of_type( device_type: mlx_device_type, device_index: i32, ) -> Result<Self, MlxCError>

Creates an owned device handle for one backend device type and index.

pub fn default_device() -> Result<Self, MlxCError>

The process’s default device.

pub fn set_as_default(&self) -> Result<(), MlxCError>

Replaces the process’s default device.

pub fn set(&mut self, source: &Self) -> Result<(), MlxCError>

Copies the source device handle into this handle.

pub fn equals(&self, other: &Self) -> bool

Whether both handles reference the same device.

pub fn index(&self) -> Result<i32, MlxCError>

The device’s index within its backend.

pub fn device_type(&self) -> Result<mlx_device_type, MlxCError>

The device’s backend type.

pub fn is_available(&self) -> Result<bool, MlxCError>

Whether the backend device is available in this process.

pub fn count_of_type(device_type: mlx_device_type) -> Result<i32, MlxCError>

How many devices the backend exposes.

pub fn to_string_lossy(&self) -> Result<String, MlxCError>

Renders the device description text.

pub fn information(&self) -> Result<MlxDeviceInfo, MlxCError>

The device’s key/value information table.

Trait Implementations

impl Debug for MlxDeviceHandle

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

Formats the value using the given formatter.

impl Drop for MlxDeviceHandle

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.