Struct Account

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

Handle onto an Account

An Account is a handle. All clones refer to the same underlying conceptual Account.

Accounts are created using MemoryQuotaTracker::new_account.

Use in Arti

In Arti, we usually use a newtype around Account, rather than a bare Account. See tor_proto::memquota.

Implementations

impl Account

pub fn register_participant( &self, particip: Weak<dyn IsParticipant>, ) -> Result<Participation, Error>

Register a new Participant

Returns the Participation, which can be used to record memory allocations.

Often, your implementation of IsParticipant wants to contain the Participation. If so, use register_participant_with instead.

pub fn register_participant_with<P: IsParticipant, X, E>( &self, now: CoarseInstant, constructor: impl FnOnce(Participation) -> Result<(Arc<P>, X), E>, ) -> Result<Result<(Arc<P>, X), E>, Error>

Register a new Participant using a constructor

Passes constructor a Participation for the nascent Participant. Returns the P: IsParticipant provided by the constructor.

For use when your impl IsParticipant wants to own the Participation.

Re-entrancy guarantees

The Participation may be used by constructor for claiming memory use, even during construction. constructor may also clone the Participation, etc.

Reclamation callbacks (via the P as IsParticipant impl) cannot occur until constructor returns.

Error handling

Failures can occur before constructor is called, or be detected afterwards. If a failure is detected after constructor returns, the Arc<P> from constructor will be dropped (resulting in P being dropped, unless constructor kept another clone of it).

constructor may also fail (throwing a different error type, E), in which case register_participant_with returns Ok(Err(E)).

On successful setup of the Participant, returns Ok(Ok(Arc<P>)).

pub fn new_child(&self) -> Result<Self>

Obtain a new Account which is a child of this one

Equivalent to MemoryQuotaTracker.new_account(Some(..))

pub fn tracker(&self) -> Arc<MemoryQuotaTracker>

Obtains a handle for the MemoryQuotaTracker

pub fn downgrade(&self) -> WeakAccount

Downgrade to a weak handle for the same Account

pub fn new_noop() -> Self

Obtain a new Account that does nothing and has no associated tracker

All methods on this succeed, but they don’t do anything.

Trait Implementations

impl Clone for Account

fn clone(&self) -> Account

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Account

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

Formats the value using the given formatter.

impl Drop for Account

fn drop(&mut self)

Executes the destructor for this type.