Skip to main content

ResourceGuard

Struct ResourceGuard 

Source
pub struct ResourceGuard { /* private fields */ }
Expand description

Resource guard for preventing system overload.

Tracks memory allocation and provides checks before large allocations.

Implementations§

Source§

impl ResourceGuard

Source

pub fn new() -> Self

Creates a new resource guard with default limits.

Source

pub fn with_max_memory(max_bytes: u64) -> Self

Creates a resource guard with a specific memory limit.

Source

pub fn with_safety_margin(self, margin: f32) -> Self

Creates a resource guard with custom safety margin.

Source

pub fn unguarded() -> Self

Creates a resource guard that doesn’t enforce limits (for testing).

Source

pub fn set_max_memory(&self, max_bytes: u64)

Sets the maximum memory limit.

Source

pub fn max_memory(&self) -> u64

Gets the maximum memory limit.

Source

pub fn current_memory(&self) -> u64

Gets the current tracked memory usage.

Source

pub fn reserved_memory(&self) -> u64

Gets the currently reserved memory.

Source

pub fn available_memory(&self) -> u64

Gets the effective available memory (max - current - reserved).

Source

pub fn can_allocate(&self, bytes: u64) -> bool

Checks if a given allocation can proceed.

Source

pub fn can_allocate_safe(&self, bytes: u64) -> ResourceResult<()>

Checks if an allocation can proceed, also checking system memory.

Source

pub fn record_allocation(&self, bytes: u64)

Records a memory allocation.

Source

pub fn record_deallocation(&self, bytes: u64)

Records a memory deallocation.

Source

pub fn reserve(&self, bytes: u64) -> ResourceResult<ReservationGuard<'_>>

Reserves memory for a future allocation.

Returns a guard that releases the reservation on drop.

Source

pub fn validate(&self, estimate: &MemoryEstimate) -> ResourceResult<()>

Validates a memory estimate before allocation.

Source

pub fn max_safe_elements(&self, bytes_per_element: usize) -> usize

Returns the maximum safe element count for a given per-element byte cost.

Source

pub fn set_enforce_limits(&self, enforce: bool)

Enables or disables limit enforcement.

Source

pub fn is_enforcing(&self) -> bool

Returns whether limits are being enforced.

Trait Implementations§

Source§

impl Debug for ResourceGuard

Source§

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

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

impl Default for ResourceGuard

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

Source§

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Gets the layout of the type.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The type for metadata in pointers and references to Self.
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more