Skip to main content

Leased

Struct Leased 

Source
pub struct Leased<T> { /* private fields */ }
Expand description

A signal-like value whose producer can wait until all outstanding readers finish.

Leased counts live claims; drain blocks until the count reaches zero, which is used to hold a producer’s stop until consumers are done.

Implementations§

Source§

impl<T> Leased<T>

Source

pub const fn new(inner: T) -> Self

Wrap inner as a leased value.

Source

pub fn leases(&self) -> u32

Return the number of live leases.

Source

pub fn is_drained(&self) -> bool

Return true if the value has been drained.

Source

pub async fn drain(&self)

Close the value to new leases and wait until all current leases drop.

Source

pub fn reopen(&self)

Reopen the value to new leases after a previous drain.

Source

pub fn lease(&'static self) -> Option<Lease<T>>

Acquire a live lease, or None if the value is drained.

Trait Implementations§

Source§

impl<T> Deref for Leased<T>

The wrapper is transparent to everything that is not a lease.

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &T

Dereferences the value.
Source§

impl<T: Observable> Observable for Leased<T>

Available on crate feature coupling-observe only.

Polling a wrapped signal is polling what it wraps, so an observed entry keeps working when a signal gains a lease count.

Source§

fn change_token(&self) -> u32

Return a token that changes when the signal is written.

Auto Trait Implementations§

§

impl<T> !Freeze for Leased<T>

§

impl<T> !RefUnwindSafe for Leased<T>

§

impl<T> Send for Leased<T>
where T: Send,

§

impl<T> Sync for Leased<T>
where T: Sync,

§

impl<T> Unpin for Leased<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Leased<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Leased<T>
where T: UnwindSafe,

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> CouplingPoint for T
where T: Sync + ?Sized,

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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.