Struct mysql_common::binlog::events::FormatDescriptionEvent

pub struct FormatDescriptionEvent<'a> { /* private fields */ }

Available on crate feature binlog only.

A format description event is the first event of a binlog for binlog-version 4.

It describes how the other events are layed out.

Implementations

impl<'a> FormatDescriptionEvent<'a>

pub const SERVER_VER_LEN: usize = 50usize

Length of a server version string.

pub const SERVER_VER_OFFSET: usize = 2usize

Offset of a server version string.

pub const QUERY_HEADER_MINIMAL_LEN: usize = 11usize

Length of a query event post-header, where 3.23, 4.x and 5.0 agree.

pub const QUERY_HEADER_LEN: usize = 13usize

Length of a query event post-header, where 5.0 differs: 2 for length of N-bytes vars.

pub const STOP_HEADER_LEN: usize = 0usize

Length of a stop event post-header.

pub const START_V3_HEADER_LEN: usize = 56usize

Length of a start event post-header.

pub const ROTATE_HEADER_LEN: usize = 8usize

Length of a rotate event post-header.

pub const INTVAR_HEADER_LEN: usize = 0usize

Length of an intvar event post-header.

pub const APPEND_BLOCK_HEADER_LEN: usize = 4usize

Length of an append block event post-header.

pub const DELETE_FILE_HEADER_LEN: usize = 4usize

Length of a delete file event post-header.

pub const RAND_HEADER_LEN: usize = 0usize

Length of a rand event post-header.

pub const USER_VAR_HEADER_LEN: usize = 0usize

Length of a user var event post-header.

pub const FORMAT_DESCRIPTION_HEADER_LEN: usize = 97usize

Length of a fde event post-header.

pub const XID_HEADER_LEN: usize = 0usize

Length of a xid event post-header.

pub const BEGIN_LOAD_QUERY_HEADER_LEN: usize = 4usize

Length of a begin load query event post-header.

pub const ROWS_HEADER_LEN_V1: usize = 8usize

Length of a v1 rows query event post-header.

pub const TABLE_MAP_HEADER_LEN: usize = 8usize

Length of a table map event post-header.

pub const EXECUTE_LOAD_QUERY_EXTRA_HEADER_LEN: usize = 13usize

Length of an execute load query event extra header.

pub const EXECUTE_LOAD_QUERY_HEADER_LEN: usize = 26usize

Length of an execute load query event post-header.

pub const INCIDENT_HEADER_LEN: usize = 2usize

Length of an incident event post-header.

pub const HEARTBEAT_HEADER_LEN: usize = 0usize

Length of a heartbeat event post-header.

pub const IGNORABLE_HEADER_LEN: usize = 0usize

Length of an ignorable event post-header.

pub const ROWS_HEADER_LEN_V2: usize = 10usize

Length of a rows events post-header.

pub const GTID_HEADER_LEN: usize = 42usize

Length of a gtid events post-header.

pub const TRANSACTION_CONTEXT_HEADER_LEN: usize = 18usize

Length of an incident event post-header.

pub const VIEW_CHANGE_HEADER_LEN: usize = 52usize

Length of a view change event post-header.

pub const XA_PREPARE_HEADER_LEN: usize = 0usize

Length of a xa prepare event post-header.

pub const TRANSACTION_PAYLOAD_HEADER_LEN: usize = 0usize

Length of a transaction payload event post-header.

pub fn new(binlog_version: BinlogVersion) -> Self

Creates new instance.

pub fn with_binlog_version(self, binlog_version: BinlogVersion) -> Self

Defines the server_version field.

pub fn with_server_version( self, server_version: impl Into<Cow<'a, [u8]>> ) -> Self

Defines the server_version field.

pub fn with_create_timestamp(self, create_timestamp: u32) -> Self

Defines the server_version field.

pub fn with_event_type_header_lengths( self, event_type_header_lengths: impl Into<Cow<'a, [u8]>> ) -> Self

Defines the server_version field.

pub fn with_footer(self, footer: BinlogEventFooter) -> Self

Defines the server_version field.

pub fn binlog_version(&self) -> BinlogVersion

Returns the binlog_version field value.

pub fn server_version_raw(&'a self) -> &'a [u8]

Returns the server_version field value.

server_version is the version of the MySQL Server that created the binlog.

pub fn server_version(&'a self) -> Cow<'a, str>

Returns the server_version field value as string (lossy converted).

pub fn create_timestamp(&self) -> u32

Returns the create_timestamp field value.

created_timestamp is the creation timestamp, if non-zero, is the time in seconds when this event was created.

pub fn event_header_length(&self) -> u8

Returns the event_header_length field value.

event_header_length is the length of the event header. This value includes the extra_headers field, so this header length is 19.

pub fn event_type_header_lengths(&'a self) -> &'a [u8]

Returns the event_type_header_lengths field value.

event_type_header_lengths is the lengths for the fixed data part of each event. An array indexed by Binlog Event Type - 1.

pub fn footer(&self) -> BinlogEventFooter

Returns the footer field value.

pub fn split_version(&self) -> (u8, u8, u8)

Returns a parsed MySql version.

pub fn get_event_type_header_length(&self, event_type: EventType) -> u8

Returns header length for the given event type, if defined.

pub fn into_owned(self) -> FormatDescriptionEvent<'static>

Returns a 'static version of self.

Trait Implementations

impl<'a> BinlogEvent<'a> for FormatDescriptionEvent<'a>

const EVENT_TYPE: EventType = EventType::FORMAT_DESCRIPTION_EVENT

An event type, associated with this struct (if any).

impl<'a> BinlogStruct<'a> for FormatDescriptionEvent<'a>

fn len(&self, _version: BinlogVersion) -> usize

Returns serialized length of this struct in bytes.

impl<'a> Clone for FormatDescriptionEvent<'a>

fn clone(&self) -> FormatDescriptionEvent<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for FormatDescriptionEvent<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for FormatDescriptionEvent<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'de> MyDeserialize<'de> for FormatDescriptionEvent<'de>

const SIZE: Option<usize> = None

Size hint of a serialized value (in bytes), if it’s constant.

type Ctx = BinlogCtx<'de>

Some structs defines deserialization in the context of another value.

fn deserialize(_ctx: Self::Ctx, buf: &mut ParseBuf<'de>) -> Result<Self>

Deserializes self from the given buf.

impl MySerialize for FormatDescriptionEvent<'_>

fn serialize(&self, buf: &mut Vec<u8>)

Serializes self into the buf.

impl<'a> PartialEq for FormatDescriptionEvent<'a>

fn eq(&self, other: &FormatDescriptionEvent<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for FormatDescriptionEvent<'a>

impl<'a> StructuralPartialEq for FormatDescriptionEvent<'a>