Struct TypedParticipation 

pub struct TypedParticipation<T> { /* private fields */ }

A Participation for use only for tracking the memory use of objects of type T

Wrapping a Participation in a TypedParticipation helps prevent accidentally passing wrongly calculated costs to claim and release.

Implementations

impl<T> TypedParticipation<T>

pub fn new(raw: Participation) -> Self

Wrap a Participation, ensuring that future calls claim and release only T

pub fn claim(&mut self, t: &impl HasTypedMemoryCost<T>) -> Result<(), Error>

Record increase in memory use, of a T: HasMemoryCost or a TypedMemoryCost<T>

pub fn release(&mut self, t: &impl HasTypedMemoryCost<T>)

Record decrease in memory use, of a T: HasMemoryCost or a TypedMemoryCost<T>

pub fn try_claim<C, F, E, R>( &mut self, item: C, call: F, ) -> Result<Result<R, E>, Error>

where C: HasTypedMemoryCost<T>, F: FnOnce(C) -> Result<R, E>,

Claiming wrapper for a closure

Claims the memory, iff call succeeds.

Specifically: Claims memory for item. If that fails, returns the error. If the claim succeeded, calls call. If it fails or panics, the memory is released, undoing the claim, and the error is returned (or the panic propagated).

In these error cases, item will typically be dropped by call, it is not convenient for call to do otherwise. If that’s wanted, use try_claim_or_return.

pub fn try_claim_or_return<C, F, E, R>( &mut self, item: C, call: F, ) -> Result<Result<R, E>, (Error, C)>

where C: HasTypedMemoryCost<T>, F: FnOnce(C) -> Result<R, E>,

Claiming wrapper for a closure

Claims the memory, iff call succeeds.

Like try_claim, but returns the item if memory claim fails. Typically, a failing call will need to return the item in E.

pub fn as_raw(&mut self) -> &mut Participation

Mutably access the inner Participation

This bypasses the type check. It is up to you to make sure that the claim and release calls are only made with properly calculated costs.

pub fn into_raw(self) -> Participation

Unwrap, and obtain the inner Participation

Methods from Deref<Target = Participation>

pub fn account(&self) -> WeakAccount

Obtain a handle onto the account

The returned handle is weak, and needs to be upgraded before use, since a Participation doesn’t keep its Account alive.

The returned WeakAccount is equivalent to all the other account handles for the same account.

Trait Implementations

impl<T> Clone for TypedParticipation<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for TypedParticipation<T>

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

Formats the value using the given formatter.

impl<T> Deref for TypedParticipation<T>

type Target = Participation

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> From<Participation> for TypedParticipation<T>

fn from(untyped: Participation) -> TypedParticipation<T>

Converts to this type from the input type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes