Enum Residency

#[non_exhaustive]
pub enum Residency {
    Host,
    Device(BackendId),
    Unified(BackendId),
}

Where an operation’s data physically lives.

Device preference says where to run; residency says where the bytes already are. Routing needs both: a GPU-resident batch is cheap to run on the GPU and expensive to run on the CPU, and the reverse holds for a host-resident one. Without this, a planner cannot see a transfer that dominates the operation it is scheduling.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Host

Host (CPU) memory.

Device(BackendId)

Memory owned by the named device.

Unified(BackendId)

Host-visible memory shared with the named device; no copy is needed.

Implementations

impl Residency

pub fn is_local_to(self, backend: BackendId) -> bool

Whether backend can read this data without a host/device transfer.

pub const fn is_host_readable(self) -> bool

Whether the host can read this data without a transfer.

Trait Implementations

impl Clone for Residency

fn clone(&self) -> Residency

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Residency

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

Formats the value using the given formatter.

impl Hash for Residency

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 Residency

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

impl Eq for Residency

impl StructuralPartialEq for Residency