Struct kitsune_p2p_types::tx2::tx2_utils::Active

pub struct Active(_);

Active tracking helper for related items. This facilitates e.g. an endpoint with sub connections. The endpoint can close, closing all connections. Or, individual connections can close, without closing the endpoint.

Implementations

impl Active

pub fn new() -> Self

Create a new active tracker set to “active”.

pub fn mix(&self, oth: &Self) -> Self

Mix two active trackers to gether. The result will be inactive if either parent is inactive.

pub fn register_kill_cb<F>(&self, cb: F) where
    F: Fn() + 'static + Send + Sync, 

Register a callback to be invoked on kill. Beware the cb may be invoked multiple times if this Active is mixed.

pub fn kill(&self)

Kill this active tracker (all trackers if mixed).

pub fn is_active(&self) -> bool

If any of the mixed trackers in this instance are not active, this fn will return false.

pub fn fut<'a, 'b, R, F>(
    &'a self,
    f: F
) -> impl Future<Output = KitsuneResult<R>> + 'b + Send where
    R: 'static + Send,
    F: Future<Output = KitsuneResult<R>> + 'b + Send, 

Wrap a future such that if any of the sub-trackers within this active tracker instance become inactive before the future resolve, resolve with a Err::Closed result.

Trait Implementations

impl Clone for Active

fn clone(&self) -> Active

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Active

fn default() -> Self

Returns the “default value” for a type.