Struct MemoryPool

Source

pub struct MemoryPool { /* private fields */ }

Expand description

A resolved, reservable limit within one physical resource.

Implementations§

Source §

impl MemoryPool

Source

pub fn requested(&self) -> MemoryBudget

Requested budget specification.

Source

pub fn capacity(&self) -> u64

Resolved pool capacity in bytes.

Source

pub fn reserved(&self) -> u64

Currently reserved bytes.

Source

pub fn remaining(&self) -> u64

Remaining reservable bytes.

Source

pub fn high_water(&self) -> u64

Highest concurrent reservation observed by this pool.

Source

pub fn reserve(&self, bytes: u64) -> Result<MemoryLease, MemoryError>

Attempts to reserve bytes until the returned lease is dropped.

§Errors

Returns MemoryError::BudgetExceeded if the local or shared resource limit lacks sufficient remaining capacity.

Source

pub fn report(&self) -> MemoryPoolReport

Returns a snapshot of this pool’s planning and usage.

Trait Implementations§

Source §

impl Clone for MemoryPool

Source §

fn clone(&self) -> MemoryPool

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 Debug for MemoryPool

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for MemoryPool

Blanket Implementations§

Source §

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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> Any for T
where T: Any,

Source §

fn into_any(self: Box<T>) -> Box<dyn Any>

Source §

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Source §

fn type_name(&self) -> &'static str

Source §

impl<T> AnySync for T
where T: Any + Send + Sync,

Source §

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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 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> IntoEither for T

Source §

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 more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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 more

Source §