Struct veilid_tools::DeferredStreamProcessor

source ·
pub struct DeferredStreamProcessor {
    pub opt_deferred_stream_channel: Option<Sender<SendPinBoxFuture<()>>>,
    pub opt_stopper: Option<StopSource>,
    pub opt_join_handle: Option<MustJoinHandle<()>>,
}
Expand description

Background processor for streams Handles streams to completion, passing each item from the stream to a callback

Fields§

§opt_deferred_stream_channel: Option<Sender<SendPinBoxFuture<()>>>§opt_stopper: Option<StopSource>§opt_join_handle: Option<MustJoinHandle<()>>

Implementations§

source§

impl DeferredStreamProcessor

source

pub fn new() -> Self

Create a new DeferredStreamProcessor

source

pub async fn init(&mut self)

Initialize the processor before use

source

pub async fn terminate(&mut self)

Terminate the processor and ensure all streams are closed

source

pub fn add<T: Send + 'static>( &mut self, receiver: Receiver<T>, handler: impl FnMut(T) -> SendPinBoxFuture<bool> + Send + 'static, ) -> bool

Queue a stream to process in the background

  • ‘receiver’ is the stream to process
  • ‘handler’ is the callback to handle each item from the stream Returns ‘true’ if the stream was added for processing, and ‘false’ if the stream could not be added, possibly due to not being initialized

Trait Implementations§

source§

impl Default for DeferredStreamProcessor

source§

fn default() -> Self

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

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> 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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V