Trait vector::sinks::util::batch::Batch

pub trait Batch: Sized {
    type Input;
    type Output;

    // Required methods
    fn push(&mut self, item: Self::Input) -> PushResult<Self::Input>;
    fn is_empty(&self) -> bool;
    fn fresh(&self) -> Self;
    fn finish(self) -> Self::Output;
    fn num_items(&self) -> usize;

    // Provided method
    fn get_settings_defaults<D: SinkBatchSettings + Clone>(
        config: BatchConfig<D, Merged>,
    ) -> Result<BatchConfig<D, Merged>, BatchError> { ... }
}

Required Associated Types

type Input

type Output

Required Methods

fn push(&mut self, item: Self::Input) -> PushResult<Self::Input>

fn is_empty(&self) -> bool

fn fresh(&self) -> Self

fn finish(self) -> Self::Output

fn num_items(&self) -> usize

Provided Methods

fn get_settings_defaults<D: SinkBatchSettings + Clone>( config: BatchConfig<D, Merged>, ) -> Result<BatchConfig<D, Merged>, BatchError>

Turn the batch configuration into an actualized set of settings, and deal with the proper behavior of max_size and if max_bytes may be set. This is in the trait to ensure all batch buffers implement it.

Object Safety

This trait is not object safe.

Implementors

impl Batch for JsonArrayBuffer

type Input = Value

type Output = Vec<Box<RawValue>>

impl Batch for MetricsBuffer

type Input = Metric

type Output = Vec<Metric>

impl Batch for Buffer

type Input = BytesMut

type Output = BytesMut

impl<B: Batch> Batch for FinalizersBatch<B>

type Input = EncodedEvent<<B as Batch>::Input>

type Output = EncodedBatch<<B as Batch>::Output>

impl<B: Batch> Batch for StatefulBatch<B>

type Input = <B as Batch>::Input

type Output = <B as Batch>::Output

impl<T, K> Batch for PartitionBuffer<T, K>

where T: Batch, K: Clone,

type Input = PartitionInnerBuffer<<T as Batch>::Input, K>

type Output = PartitionInnerBuffer<<T as Batch>::Output, K>

impl<T: EncodedLength> Batch for VecBuffer<T>

type Input = T

type Output = Vec<T>