Skip to main content

ResourcePermit

Struct ResourcePermit 

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

Represents resource permit.

Implementations§

Source§

impl ResourcePermit

Source

pub fn try_resize(&mut self, bytes: usize) -> Result<(), BudgetRejection>

Changes the byte reservation without acquiring another count or rate token.

Growth reserves only the difference at each ancestor. A rejection rolls back every added byte and leaves this permit unchanged. Shrinking is allowed after budget closure; callers release the removed payload before shrinking its charge. This method does not block on available capacity.

§Errors

Returns a rejection if growth exceeds any ancestor’s byte limit or a dynamic ancestor has closed admission.

Source

pub const fn bytes(&self) -> usize

Returns the bytes.

Source

pub const fn class(&self) -> BudgetClass

Returns the class.

Source

pub fn promote_to_control(&mut self)

Promotes a data reservation to the control class without releasing capacity.

The total count and byte ownership remain unchanged at every budget level. Data-only counters and rate tokens are released before a same-tree rebind can use control reserve.

Source

pub fn try_rebind( &mut self, target: &ResourceBudget, ) -> Result<PermitRebindOutcome, RuntimeContractViolation>

Moves this reservation to another budget in the same resource tree.

Reservations for the common ancestor chain remain owned throughout the transfer. Target-only reservations are acquired before source-only reservations are released, so the payload is always covered without charging common ancestors twice.

Returns a normal rejection when the target is full. Contract failures and rejections leave this permit unchanged and valid for its source.

§Errors

Returns crate::RuntimeContractViolation::PermitTargetInDifferentTree when target is outside this permit’s resource-budget tree.

Trait Implementations§

Source§

impl Debug for ResourcePermit

Source§

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

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

impl Drop for ResourcePermit

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. 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> 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<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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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