Struct trillium_server_common::CloneCounter

source ·
pub struct CloneCounter(/* private fields */);
Expand description

§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§

source§

impl CloneCounter

source

pub fn new() -> Self

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

source

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

source

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

source

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.

source

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§

source§

impl Clone for CloneCounter

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CloneCounter

source§

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

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

impl Default for CloneCounter

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Drop for CloneCounter

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl From<CloneCounter> for CloneCounterObserver

source§

fn from(value: CloneCounter) -> Self

Converts to this type from the input type.
source§

impl From<CloneCounterObserver> for CloneCounter

source§

fn from(value: CloneCounterObserver) -> Self

Converts to this type from the input type.
source§

impl Future for &CloneCounter

§

type Output = ()

The type of value produced on completion.
source§

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. Read more
source§

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?
source§

fn into_future(self) -> Self::IntoFuture

Creates a future from a value. Read more
source§

impl PartialEq<usize> for CloneCounter

source§

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

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

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.

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> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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.