Struct Pipe 

pub struct Pipe<S, Into, Args, Ctx> { /* private fields */ }

A generic pipe that wraps a Stream and passes it to a backend

Features

Feature	Status	Description
TaskSink	✅	Ability to push new tasks
InheritsFeatures	✅ ❗	Inherits features from the underlying backend

Key: ✅ : Supported | ⚠️ : Not implemented | ❌ : Not Supported | ❗ Limited support

Examples:

Implementations

impl<S, Into, Args, Ctx> Pipe<S, Into, Args, Ctx>

pub fn new(stream: S, backend: Into) -> Self

Create a new Pipe instance

Trait Implementations

impl<Args, Ctx, S, TSink, Err> Backend<Args> for Pipe<S, TSink, Args, Ctx>

where S: Stream<Item = Result<Args, Err>> + Send + 'static, TSink: Backend<Args, Context = Ctx> + Sink<Task<Args, Ctx, TSink::IdType>> + Clone + Unpin + Send + 'static, <TSink as Backend<Args>>::Error: Into<BoxDynError> + Send + Sync + 'static, TSink::Beat: Send + 'static, TSink::IdType: Send + Clone + 'static, TSink::Stream: Send + 'static, Args: Send + 'static, Ctx: Send + 'static + Default, Err: Into<BoxDynError> + Send + Sync + 'static, <TSink as Sink<Task<Args, Ctx, TSink::IdType>>>::Error: Into<BoxDynError> + Send + Sync + 'static,

type IdType = <TSink as Backend<Args>>::IdType

The type used to uniquely identify tasks.

type Context = Ctx

Context associated with each task.

type Stream = Pin<Box<dyn Stream<Item = Result<Option<Task<Args, Ctx, <Pipe<S, TSink, Args, Ctx> as Backend<Args>>::IdType>>, PipeError>> + Send>>

A stream of tasks provided by the backend.

type Layer = <TSink as Backend<Args>>::Layer

The type representing backend middleware layer.

type Beat = Pin<Box<dyn Stream<Item = Result<(), PipeError>> + Send>>

A stream representing heartbeat signals.

type Error = PipeError

The error type returned by backend operations

type Codec = <TSink as Backend<Args>>::Codec

The codec used for serialization/deserialization of tasks.

fn heartbeat(&self, worker: &WorkerContext) -> Self::Beat

Returns a heartbeat stream for the given worker.

fn middleware(&self) -> Self::Layer

Returns the backend’s middleware layer.

fn poll(self, worker: &WorkerContext) -> Self::Stream

Polls the backend for tasks for the given worker.

impl<S: Clone, Into: Clone, Args, Ctx> Clone for Pipe<S, Into, Args, Ctx>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug, Into: Debug, Args, Ctx> Debug for Pipe<S, Into, Args, Ctx>

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

Formats the value using the given formatter.

impl<S, Into, Args, Ctx> Deref for Pipe<S, Into, Args, Ctx>

type Target = Into

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<S, Into, Args, Ctx> DerefMut for Pipe<S, Into, Args, Ctx>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.