Struct mysql_common::binlog::EventStreamReader

pub struct EventStreamReader { /* private fields */ }

Reader for binlog events.

Note

It’s a low-level stream reader and only maintains actual fde and table map, so one should properly handle encountered events (see docs on EventStreamReader::read).

Implementations

impl EventStreamReader

pub fn new(version: BinlogVersion) -> Self

Creates a new instance.

pub fn get_fde(&self) -> &FormatDescriptionEvent<'static>

Returns the format description event.

Returns the default placeholder if there was no FDE yet.

pub fn get_tme(&self, table_id: u64) -> Option<&TableMapEvent<'static>>

Returns the table map event for the given table id.

Should be availeble if rows event with this table id encountered in the stream.

pub fn read<T: BufRead>(&mut self, input: T) -> Result<Option<Event>>

Will read next event from the given stream (Returns None if stream is exhausted).

Note

Since MySql 8.0.20 it is possible for an event stream to contain an embedded stream of events in form of a TransactionPayloadEvent. This means that to properly handle table maps it is necessary to read the embedded stream as soon as it is encountered (see EventStreamReader::read_decompressed).

pub fn read_decompressed<T: BufRead>( &mut self, input: T, ) -> Result<Option<Event>>

This function reads decompressed payload of a Transaction_payload_event (see TransactionPayloadEvent::decompressed).

The difference is that checksum verification will be disabled according to the WL#3549.

Warning

This function can’t be used to skip checksum verification for regular events.

Errors

There is a list of events that should never be a part of a transaction payload and the list includes the TransactionPayloadEvent itself. This function will emit an io::ErrorKind::Other if TransactionPayloadEvent is encountered within the compressed payload.

Trait Implementations

impl Debug for EventStreamReader

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

Formats the value using the given formatter.