Struct vector::sinks::util::sink::PartitionBatchSink

pub struct PartitionBatchSink<S, B, K>
where
    B: Batch,
    S: Service<B::Output>,
{ /* private fields */ }

A partition based batcher, given some Service and Batch where the input is partitionable via the Partition trait, it will hold many in flight batches.

This type is similar to BatchSink with the added benefit that it has more fine-grained partitioning ability. It will hold many different batches of events and contain linger timeouts for each.

Note that, unlike BatchSink, the batch given to this sink is only used to create new batches (via Batch::fresh) for each new partition.

Acking

Service based acking will only ack events when all prior request batches have been acked. This means if sequential requests r1, r2, and r3 are dispatched and r2 and r3 complete, all events contained in all requests will not be acked until r1 has completed.

Ordering

Per partition ordering can be achieved by holding onto future of a request until it finishes. Until then all further requests in that partition are delayed.

Note: This has been deprecated, please do not use when creating new Sinks.

Implementations

impl<S, B, K> PartitionBatchSink<S, B, K>

where B: Batch, B::Input: Partition<K>, K: Hash + Eq + Clone + Send + 'static, S: Service<B::Output>, S::Future: Send + 'static, S::Error: Into<Error> + Send + 'static, S::Response: Response + Send + 'static,

pub fn new(service: S, batch: B, timeout: Duration) -> Self

pub fn ordered(&mut self)

Enforces per partition ordering of request.

Trait Implementations

impl<S, B, K> Debug for PartitionBatchSink<S, B, K>

where S: Service<B::Output> + Debug, B: Batch + Debug,

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

Formats the value using the given formatter.

impl<S, B, K> Sink<EncodedEvent<<B as Batch>::Input>> for PartitionBatchSink<S, B, K>

where B: Batch, B::Input: Partition<K>, K: Hash + Eq + Clone + Send + 'static, S: Service<B::Output>, S::Future: Send + 'static, S::Error: Into<Error> + Send + 'static, S::Response: Response + Send + 'static,

type Error = Box<dyn Error + Sync + Send>

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut Self>, item: EncodedEvent<B::Input>, ) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<'pin, S, B, K> Unpin for PartitionBatchSink<S, B, K>

where B: Batch, S: Service<B::Output>, __PartitionBatchSink<'pin, S, B, K>: Unpin,