Struct trillium_server_common::CloneCounter

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

an atomic counter that increments on clone & decrements on drop

One-indexed, because the first CloneCounter is included. If you don’t want the original to count, construct a CloneCounterObserver instead and use CloneCounterObserver::counter to increment.

Awaiting a CloneCounter will be pending until it is the only remaining counter and resolve to () when the count is 1.

Implementations

impl CloneCounter

pub fn new() -> Self

Constructs a new CloneCounter. Identical to CloneCounter::default()

pub fn current(&self) -> usize

Returns the current count. The first CloneCounter is one, so this can either be considered a one-indexed count of the total number of CloneCounters in memory

pub fn decrement(&self)

Manually decrement the count. This is useful when taking a clone of the counter that does not represent an increase in the underlying property or resource being counted. This is called automatically on drop and is usually unnecessary to call directly

pub fn increment(&self)

Manually increment the count. unless paired with a decrement, this will prevent the clone counter from ever reaching zero. This is called automatically on clone.

pub fn observer(&self) -> CloneCounterObserver

Returns an observer that can be cloned any number of times without modifying the clone counter. See CloneCounterObserver for more.

Trait Implementations

impl Clone for CloneCounter

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CloneCounter

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

Formats the value using the given formatter.

impl Default for CloneCounter

fn default() -> Self

Returns the “default value” for a type.

impl Drop for CloneCounter

fn drop(&mut self)

Executes the destructor for this type.

impl From<CloneCounter> for CloneCounterObserver

fn from(value: CloneCounter) -> Self

Converts to this type from the input type.

impl From<CloneCounterObserver> for CloneCounter

fn from(value: CloneCounterObserver) -> Self

Converts to this type from the input type.

impl Future for &CloneCounter

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl IntoFuture for CloneCounter

type Output = ()

The output that the future will produce on completion.

type IntoFuture = CloneCounterFuture

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl PartialEq<usize> for CloneCounter

fn eq(&self, other: &usize) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.