Struct MemoryDeviceProperties 

#[non_exhaustive]
pub struct MemoryDeviceProperties {
    pub max_page_size: u64,
    pub alignment: u64,
    /* private fields */
}

Properties of the device related to allocation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_page_size: u64

The maximum nr. of bytes that can be allocated in one go.

alignment: u64

The required memory offset alignment in bytes.

Implementations

impl MemoryDeviceProperties

pub const fn new(max_page_size: u64, alignment: u64) -> Self

Properties that state no capacity. A runtime that can read one adds it with with_max_memory.

pub const fn max_memory(&self) -> Option<u64>

How many bytes this memory may be asked to hold at once, or None, never Some(0), where the runtime has no figure.

This sizes a whole workload, while max_page_size bounds a single allocation and is often derived from it. It is a budget, not a hardware census: each runtime reports the largest figure its own API stands behind, and staying under it is what keeps the device off its paging path.

A runtime with no figure leaves it None rather than guess, because a guess reads as a measurement to every caller downstream.

pub const fn with_max_memory(self, max_memory: u64) -> Self

States the capacity, as set_max_memory does.

pub const fn set_max_memory(&mut self, max_memory: u64)

States the capacity, dropping a zero: an API with nothing to report reports 0, and max_memory says that as None.

Trait Implementations

impl Clone for MemoryDeviceProperties

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryDeviceProperties

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

Formats the value using the given formatter.

impl Eq for MemoryDeviceProperties

impl Hash for MemoryDeviceProperties

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 MemoryDeviceProperties

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MemoryDeviceProperties