Struct vector_stream::Driver

pub struct Driver<St, Svc> { /* private fields */ }

Drives the interaction between a stream of items and a service which processes them asynchronously.

Driver, as a high-level, facilitates taking items from an arbitrary Stream and pushing them through a Service, spawning each call to the service so that work can be run concurrently, managing waiting for the service to be ready before processing more items, and so on.

Additionally, Driver handles event finalization, which triggers acknowledgements to the source or disk buffer.

This capability is parameterized so any implementation which can define how to interpret the response for each request, as well as define how many events a request is compromised of, can be used with Driver.

Implementations

impl<St, Svc> Driver<St, Svc>

pub fn new(input: St, service: Svc) -> Self

pub fn protocol(self, protocol: impl Into<SharedString>) -> Self

Set the protocol name for this driver.

If this is set, the driver will fetch and use the bytes_sent value from responses in a BytesSent event.

impl<St, Svc> Driver<St, Svc>

where St: Stream, St::Item: Finalizable + MetaDescriptive, Svc: Service<St::Item>, Svc::Error: Debug + 'static, Svc::Future: Send + 'static, Svc::Response: DriverResponse,

pub async fn run(self) -> Result<(), ()>

Runs the driver until the input stream is exhausted.

All in-flight calls to the provided service will also be completed before run returns.

Errors

The return type is mostly to simplify caller code. An error is currently only returned if a service returns an error from poll_ready