pub struct MemoryResource {
pub id: String,
pub name: String,
pub kind: MemoryResourceKind,
pub total_bytes: Option<u64>,
pub available_bytes: Option<u64>,
pub capacity_source: CapacitySource,
pub device_identity: Option<DeviceIdentity>,
}Expand description
Snapshot of one physical memory resource.
Fields§
§id: StringStable resource identifier.
name: StringHuman-readable resource name.
kind: MemoryResourceKindHost or accelerator memory.
total_bytes: Option<u64>Total capacity when observable.
available_bytes: Option<u64>Currently available capacity when observable.
capacity_source: CapacitySourceSource of capacity information.
device_identity: Option<DeviceIdentity>Accelerator identity used to refresh platform telemetry.
Implementations§
Source§impl MemoryResource
impl MemoryResource
Sourcepub fn adaptive_device(
id: impl Into<String>,
name: impl Into<String>,
) -> MemoryResource
pub fn adaptive_device( id: impl Into<String>, name: impl Into<String>, ) -> MemoryResource
Creates an accelerator resource whose physical capacity is unavailable.
Sourcepub fn discover_device(
id: impl Into<String>,
name: impl Into<String>,
identity: DeviceIdentity,
fallback_bytes: u64,
) -> MemoryResource
pub fn discover_device( id: impl Into<String>, name: impl Into<String>, identity: DeviceIdentity, fallback_bytes: u64, ) -> MemoryResource
Discovers accelerator capacity from platform telemetry, falling back to an adaptive backend limit when dedicated-memory telemetry is absent.
Sourcepub fn with_capacity(
self,
total_bytes: u64,
available_bytes: Option<u64>,
) -> MemoryResource
pub fn with_capacity( self, total_bytes: u64, available_bytes: Option<u64>, ) -> MemoryResource
Creates a resource with an explicit user-provided capacity.
Sourcepub const fn budget(&self, budget: MemoryBudget) -> MemoryBudget
pub const fn budget(&self, budget: MemoryBudget) -> MemoryBudget
Creates a budget bound to this resource.
Trait Implementations§
Source§impl Clone for MemoryResource
impl Clone for MemoryResource
Source§fn clone(&self) -> MemoryResource
fn clone(&self) -> MemoryResource
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for MemoryResource
impl Debug for MemoryResource
Source§impl<'de> Deserialize<'de> for MemoryResource
impl<'de> Deserialize<'de> for MemoryResource
Source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<MemoryResource, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<MemoryResource, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl Eq for MemoryResource
Source§impl PartialEq for MemoryResource
impl PartialEq for MemoryResource
Source§impl Serialize for MemoryResource
impl Serialize for MemoryResource
Source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl StructuralPartialEq for MemoryResource
Auto Trait Implementations§
impl Freeze for MemoryResource
impl RefUnwindSafe for MemoryResource
impl Send for MemoryResource
impl Sync for MemoryResource
impl Unpin for MemoryResource
impl UnsafeUnpin for MemoryResource
impl UnwindSafe for MemoryResource
Blanket Implementations§
impl<T> Allocation for T
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key and return true if they are equal.Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
impl<T> Scalar for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.