Struct LogBatch 

pub struct LogBatch { /* private fields */ }

A batch of log records yielded by the tailer stream.

Each record is a parsed JSON value. A batch may contain records from multiple segment files when a file boundary is crossed while filling the batch.

Call LogBatch::commit after processing the batch to advance the checkpoint. If commit is not called the checkpoint remains at its prior position, so the records in this batch will be re-read on the next run.

Implementations

impl LogBatch

pub fn new() -> Self

Create a new empty batch with a default consumer name.

pub fn with_consumer_name(name: String) -> Self

Create a new empty batch for the named consumer.

pub fn consumer_name(&self) -> &str

The name of the consumer this batch belongs to.

pub fn commit(&mut self) -> Result<()>

Advance the checkpoint to the end of this batch.

This confirms that the caller has successfully processed the batch. If checkpointing is not enabled, or if this batch has already been committed, this is a no-op.

pub fn len(&self) -> usize

The number of records in this batch.

pub fn is_empty(&self) -> bool

Whether the batch is empty.

pub fn records(&self) -> &[Value]

The parsed JSON records.

pub fn file_names(&self) -> &[Utf8PathBuf]

The list of unique segment file names that contributed records to this batch.

pub fn file_name_for_line(&self, index: usize) -> &Utf8PathBuf

Return the segment file name for the record at index.

pub fn byte_offset_for_line(&self, index: usize) -> u64

Return the byte offset in the decompressed stream for the record at index.

Trait Implementations

impl AsRef<[Value]> for LogBatch

fn as_ref(&self) -> &[Value]

Converts this type into a shared reference of the (usually inferred) input type.

impl Default for LogBatch

fn default() -> Self

Returns the “default value” for a type.