Struct Participation

pub struct Participation(/* private fields */);

Handle onto a participant’s participation in a tracker

Participation is a handle. All clones are for use by the same conceptual Participant. It doesn’t keep the underlying Account alive.

Participations are created by registering new participants, for example using Account::register_participant.

Variables of this type are often named partn.

Implementations

impl Participation

pub fn claim(&mut self, want: usize) -> Result<()>

Record that some memory has been (or will be) allocated

pub fn release(&mut self, have: usize)

Record that some memory has been (or will be) freed by a participant

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.

pub fn destroy_participant(self)

Destroy this participant

Treat as freed all the memory allocated via this Participation and its clones. After this, other clones of this Participation are no longer usable: attempts to do so will give errors. (although they can still be used to get at the Account, if it still exists).

The actual memory should be freed promptly.

(It is not necessary to call this function in order to get the memory tracker to free its handle onto the IsParticipant, because the memory quota system holds only a Weak reference.)

pub fn new_dangling() -> Self

Creates a new dangling, dummy, Participation

This can be used as a standin where a value of type Participation is needed. The returned value cannot be used to claim memory, or find an Account or MemoryQuotaTracker.

Trait Implementations

impl Clone for Participation

fn clone(&self) -> Participation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Participation

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

Formats the value using the given formatter.

impl Drop for Participation

fn drop(&mut self)

Executes the destructor for this type.

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

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

Converts to this type from the input type.