Struct TorEventReceiver

pub struct TorEventReceiver { /* private fields */ }

A receiver for TorEvents emitted by other users of this crate.

To use this type, first subscribe to some kinds of event by calling TorEventReceiver::subscribe. Then, consume events using the implementation of futures::stream::Stream.

Warning

Once interest in events has been signalled with subscribe, events must be continuously read from the receiver in order to avoid excessive memory consumption.

Implementations

impl TorEventReceiver

pub fn subscribe(&mut self, kind: TorEventKind)

Subscribe to a given kind of TorEvent.

After calling this function, TorEventReceiver::recv will emit events of that kind. This function is idempotent (subscribing twice has the same effect as doing so once).

pub fn unsubscribe(&mut self, kind: TorEventKind)

Unsubscribe from a given kind of TorEvent.

After calling this function, TorEventReceiver::recv will no longer emit events of that kind. This function is idempotent (unsubscribing twice has the same effect as doing so once).

Trait Implementations

impl Clone for TorEventReceiver

fn clone(&self) -> TorEventReceiver

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TorEventReceiver

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

Formats the value using the given formatter.

impl Drop for TorEventReceiver

fn drop(&mut self)

Executes the destructor for this type.

impl Stream for TorEventReceiver

type Item = TorEvent

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.