Skip to main content

BackendKind

Enum BackendKind 

Source
pub enum BackendKind {
    Cuda,
    Rocm,
    LevelZero,
    Vulkan,
    Metal,
    WebGpu,
    Cpu,
}
Expand description

One of the concrete compute backends OxiCUDA targets.

Variants are ordered from most- to least-preferred for a typical discrete-GPU workstation; see BackendKind::default_priority.

Variants§

§

Cuda

NVIDIA CUDA (oxicuda).

§

Rocm

AMD ROCm / HIP (oxicuda-rocm).

§

LevelZero

Intel oneAPI Level Zero (oxicuda-levelzero).

§

Vulkan

Khronos Vulkan compute (oxicuda-vulkan).

§

Metal

Apple Metal (oxicuda-metal).

§

WebGpu

W3C WebGPU (oxicuda-webgpu).

§

Cpu

Pure-Rust host fallback (the CPU reference backend).

Implementations§

Source§

impl BackendKind

Source

pub const ALL: [BackendKind; 7]

Every backend kind, in declaration order.

Source

pub const fn as_str(self) -> &'static str

Short lowercase identifier matching the backend’s name() ("cuda", "rocm", "level_zero", "vulkan", "metal", "webgpu", "cpu").

Source

pub const fn default_priority(self) -> u32

Default selection priority — higher wins.

Native vendor stacks (CUDA, ROCm, Level Zero, Metal) outrank the portable APIs (Vulkan, WebGPU), which in turn outrank the CPU fallback. The CPU backend is deliberately the global minimum so it is only ever chosen when nothing else is available.

Source

pub const fn is_gpu(self) -> bool

true for every backend that targets a real GPU (i.e. everything except BackendKind::Cpu).

Source

pub fn from_name(name: &str) -> Option<Self>

Parse a backend kind from its short identifier (case-insensitive), accepting a few common aliases ("hip", "l0", "wgpu", "host").

Trait Implementations§

Source§

impl Clone for BackendKind

Source§

fn clone(&self) -> BackendKind

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for BackendKind

Source§

impl Debug for BackendKind

Source§

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

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

impl Display for BackendKind

Source§

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

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

impl Eq for BackendKind

Source§

impl Hash for BackendKind

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for BackendKind

Source§

fn eq(&self, other: &BackendKind) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for BackendKind

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, 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.