Struct fluvio_dataplane_protocol::batch::Batch

pub struct Batch<R = MemoryRecords> {
    pub base_offset: Offset,
    pub batch_len: i32,
    pub header: BatchHeader,
    /* private fields */
}

Fields

base_offset: Offset

batch_len: i32

header: BatchHeader

Implementations

impl<R> Batch<R>

pub fn get_mut_header(&mut self) -> &mut BatchHeader

pub fn get_header(&self) -> &BatchHeader

pub fn own_records(self) -> R

pub fn records(&self) -> &R

pub fn mut_records(&mut self) -> &mut R

pub fn get_base_offset(&self) -> Offset

pub fn set_base_offset(&mut self, offset: Offset)

pub fn base_offset(self, offset: Offset) -> Self

pub fn add_to_offset_delta(&mut self, delta: i32)

pub fn set_offset_delta(&mut self, delta: i32)

pub fn get_last_offset(&self) -> Offset

pub fn records_len(&self) -> usize

pub fn get_last_offset_delta(&self) -> Size

👎 Deprecated since 0.9.2:

use last_offset_delta instead

get last offset delta

pub fn last_offset_delta(&self) -> i32

pub fn get_compression(&self) -> Result<Compression, CompressionError>

pub fn decode_from_file_buf<T>(
    &mut self,
    src: &mut T,
    version: Version
) -> Result<(), Error> where
    T: Buf, 

decode from buf stored in the file read all excluding records

pub fn batch_len(&self) -> i32

Return the size of the batch header + records

impl<R> Batch<R> where
    R: Encoder, 

pub fn validate_decoding(&self) -> bool

check if batch is valid after decoded

impl<R: BatchRecords> Batch<R>

pub fn new() -> Self

Create a new empty batch

pub fn computed_last_offset(&self) -> Offset

computed last offset which is base offset + number of records

impl Batch

pub fn add_record(&mut self, record: Record)

add new record, this will update the offset to correct

pub fn add_records(&mut self, records: &mut Vec<Record>)

pub fn update_offset_deltas(&mut self)

pub fn into_consumer_records_iter(
    self,
    partition: PartitionId
) -> impl Iterator<Item = ConsumerRecord>

impl Batch<RawRecords>

pub fn memory_records(&self) -> Result<MemoryRecords, CompressionError>

Trait Implementations

impl<R: Clone> Clone for Batch<R>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for Batch<R>

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

Formats the value using the given formatter.

impl<R> Decoder for Batch<R> where
    R: BatchRecords, 

fn decode<T>(&mut self, src: &mut T, version: Version) -> Result<(), Error> where
    T: Buf, 

fn decode_from<T>(src: &mut T, version: i16) -> Result<Self, Error> where
    T: Buf,
    Self: Default, 

decode Fluvio compliant protocol values from buf

impl<R: Default> Default for Batch<R>

fn default() -> Batch<R>

Returns the “default value” for a type.

impl<R> Encoder for Batch<R> where
    R: BatchRecords, 

fn write_size(&self, version: Version) -> usize

size of this object in bytes

fn encode<T>(&self, dest: &mut T, version: Version) -> Result<(), Error> where
    T: BufMut, 

encoding contents for buffer

fn as_bytes(&self, version: i16) -> Result<Bytes, Error>

impl<T: Into<MemoryRecords>> From<T> for Batch

fn from(records: T) -> Self

Converts to this type from the input type.

impl TryFrom<Batch<RawRecords>> for Batch

type Error = CompressionError

The type returned in the event of a conversion error.

fn try_from(batch: Batch<RawRecords>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Batch<Vec<Record<RecordData>, Global>>> for Batch<RawRecords>

type Error = CompressionError

The type returned in the event of a conversion error.

fn try_from(f: Batch) -> Result<Self, Self::Error>

Performs the conversion.