Enum DeviceType 

pub enum DeviceType {
    Cpu,
    Cuda,
    WebGpu,
    DirectMl,
    CoreMl,
}

Execution backend for ML inference.

Variants

Cpu

Pure-Rust CPU execution (always available).

Cuda

NVIDIA CUDA via oxionnx-cuda (feature cuda).

WebGpu

WebGPU / wgpu compute backend via oxionnx-gpu (feature webgpu).

DirectMl

Microsoft DirectML (feature directml, Windows-only at runtime).

CoreMl

Apple CoreML. Reserved variant; no coreml feature exists yet, so this device is never reported as available and auto() never selects it. It exists so API consumers can exhaustively match on DeviceType without having to guess whether CoreML will be added later.

Implementations

impl DeviceType

pub fn auto() -> Self

Return the preferred device available in this build, in the order CUDA → DirectML → WebGPU → CPU. Always succeeds because CPU is unconditionally available.

The result is memoised for the lifetime of the process.

pub fn is_available(self) -> bool

Report whether this device is usable in the current build / runtime environment. A device may be compiled in (feature-gated) yet still unavailable at runtime — e.g. no GPU detected.

pub fn name(self) -> &'static str

Short canonical name matching the feature flag / CLI spelling.

Retained for backward compatibility with existing call sites; DeviceType::display_name is preferred for human-facing output.

pub fn display_name(self) -> &'static str

Human-facing label — identical to Self::name for now, but conceptually distinct so downstream UIs can swap in a friendlier string later without affecting programmatic lookups.

pub fn probe_caps(self) -> DeviceCapabilities

Run the full cascade probe and return the richer DeviceCapabilities record for this device.

pub fn list_available() -> Vec<Self>

Return every DeviceType whose backend is currently usable.

The returned vector always contains DeviceType::Cpu and is ordered by the probe cascade (CPU last).

pub const fn all_variants() -> [Self; 5]

Every variant in enum declaration order.

Used by DeviceCapabilities::probe_all and the test suite.

Trait Implementations

impl Clone for DeviceType

fn clone(&self) -> DeviceType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DeviceType

impl Debug for DeviceType

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

Formats the value using the given formatter.

impl Default for DeviceType

fn default() -> Self

Returns the “default value” for a type.

impl Display for DeviceType

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

Formats the value using the given formatter.

impl Eq for DeviceType

impl Hash for DeviceType

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 PartialEq for DeviceType

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