Skip to main content

BinlogFile

Struct BinlogFile 

Source
pub struct BinlogFile<R, M: BinlogMode = Unspecified> { /* private fields */ }

Implementations§

Source§

impl<R: Read> BinlogFile<R>

Source

pub fn new(reader: R) -> Result<Self>

Examples found in repository?
examples/decode_typed_rows.rs (line 37)
36fn run<M: ImageMode>(path: &str, output: &mut dyn Write) -> Result<()> {
37    let mut reader = BinlogFile::new(BufReader::new(File::open(path)?))?.with_mode::<M>();
38    let mut tables = BTreeMap::new();
39    while let Some(event) = reader.next_event()? {
40        match event.event {
41            EventData::FormatDescription(_) | EventData::Rotate(_) => tables.clear(),
42            EventData::TableMap(table) => {
43                tables.insert(table.table_id, RowsDecoder::new(&table)?);
44            }
45            EventData::Rows(event) => {
46                if event.table_id != 0x00ff_ffff || event.flags & STMT_END_F == 0 {
47                    let decoder = tables.get(&event.table_id).ok_or_else(|| {
48                        Error::Invalid(format!("missing TABLE_MAP for {}", event.table_id))
49                    })?;
50                    for row in event.rows(decoder)? {
51                        let row = row?;
52                        for (label, image) in [("before", row.before), ("after", row.after)] {
53                            if let Some(image) = image {
54                                print_image(output, label, image.as_ref())?;
55                            }
56                        }
57                    }
58                }
59                if event.flags & STMT_END_F != 0 {
60                    tables.clear();
61                }
62            }
63            _ => {}
64        }
65    }
66    Ok(())
67}
More examples
Hide additional examples
examples/decode_rows.rs (line 36)
30fn main() -> Result<()> {
31    let args: Vec<_> = std::env::args().collect();
32    if args.len() != 2 {
33        eprintln!("usage: cargo run -p mysql-replication --example decode_rows -- BINLOG_FILE");
34        return Ok(());
35    }
36    let mut reader = BinlogFile::new(BufReader::new(File::open(&args[1])?))?;
37    let mut tables = BTreeMap::new();
38    while let Some(event) = reader.next_event()? {
39        match event.event {
40            EventData::FormatDescription(_) | EventData::Rotate(_) => tables.clear(),
41            EventData::TableMap(table) => {
42                // Replace the plan on every remap; never reuse a table ID across files.
43                tables.insert(table.table_id, RowsDecoder::new(&table)?);
44            }
45            EventData::Rows(rows) => {
46                // MySQL may send a statement-end marker without row data.
47                if rows.table_id != 0x00ff_ffff || rows.flags & STMT_END_F == 0 {
48                    let decoder = tables.get(&rows.table_id).ok_or_else(|| {
49                        Error::Invalid(format!("missing TABLE_MAP for {}", rows.table_id))
50                    })?;
51                    for row in rows.rows(decoder)? {
52                        let row = row?;
53                        print_image("before", row.before)?;
54                        print_image("after", row.after)?;
55                    }
56                }
57                if rows.flags & STMT_END_F != 0 {
58                    tables.clear();
59                }
60            }
61            _ => {}
62        }
63    }
64    Ok(())
65}
Source

pub fn with_config(reader: R, config: ParserConfig) -> Result<Self>

Examples found in repository?
examples/dump_file.rs (lines 9-12)
3fn main() -> Result<()> {
4    let args: Vec<_> = std::env::args().collect();
5    if args.len() != 2 {
6        eprintln!("usage: cargo run -p mysql-replication --example dump_file -- BINLOG_FILE");
7        return Ok(());
8    }
9    let mut reader = BinlogFile::with_config(
10        BufReader::new(File::open(&args[1])?),
11        ParserConfig::default(),
12    )?;
13    let mut output = std::io::stdout().lock();
14    while let Some(event) = reader.next_event()? {
15        event.header.dump(&mut output)?;
16        event.event.dump(&mut output)?;
17    }
18    Ok(())
19}
Source§

impl<R: Read, M: BinlogMode> BinlogFile<R, M>

Source

pub fn for_mode(reader: R, config: ParserConfig) -> Result<Self>

Source

pub fn with_mode<N: BinlogMode>(self) -> BinlogFile<R, N>

Examples found in repository?
examples/decode_typed_rows.rs (line 37)
36fn run<M: ImageMode>(path: &str, output: &mut dyn Write) -> Result<()> {
37    let mut reader = BinlogFile::new(BufReader::new(File::open(path)?))?.with_mode::<M>();
38    let mut tables = BTreeMap::new();
39    while let Some(event) = reader.next_event()? {
40        match event.event {
41            EventData::FormatDescription(_) | EventData::Rotate(_) => tables.clear(),
42            EventData::TableMap(table) => {
43                tables.insert(table.table_id, RowsDecoder::new(&table)?);
44            }
45            EventData::Rows(event) => {
46                if event.table_id != 0x00ff_ffff || event.flags & STMT_END_F == 0 {
47                    let decoder = tables.get(&event.table_id).ok_or_else(|| {
48                        Error::Invalid(format!("missing TABLE_MAP for {}", event.table_id))
49                    })?;
50                    for row in event.rows(decoder)? {
51                        let row = row?;
52                        for (label, image) in [("before", row.before), ("after", row.after)] {
53                            if let Some(image) = image {
54                                print_image(output, label, image.as_ref())?;
55                            }
56                        }
57                    }
58                }
59                if event.flags & STMT_END_F != 0 {
60                    tables.clear();
61                }
62            }
63            _ => {}
64        }
65    }
66    Ok(())
67}
Source

pub fn next_frame(&mut self) -> Result<Option<BinlogFrame<'_>>>

Reads only a frame, so custom adapters can select their own body layout.

Source

pub fn next_event(&mut self) -> Result<Option<BinlogEvent<'_, M>>>

Examples found in repository?
examples/dump_file.rs (line 14)
3fn main() -> Result<()> {
4    let args: Vec<_> = std::env::args().collect();
5    if args.len() != 2 {
6        eprintln!("usage: cargo run -p mysql-replication --example dump_file -- BINLOG_FILE");
7        return Ok(());
8    }
9    let mut reader = BinlogFile::with_config(
10        BufReader::new(File::open(&args[1])?),
11        ParserConfig::default(),
12    )?;
13    let mut output = std::io::stdout().lock();
14    while let Some(event) = reader.next_event()? {
15        event.header.dump(&mut output)?;
16        event.event.dump(&mut output)?;
17    }
18    Ok(())
19}
More examples
Hide additional examples
examples/decode_typed_rows.rs (line 39)
36fn run<M: ImageMode>(path: &str, output: &mut dyn Write) -> Result<()> {
37    let mut reader = BinlogFile::new(BufReader::new(File::open(path)?))?.with_mode::<M>();
38    let mut tables = BTreeMap::new();
39    while let Some(event) = reader.next_event()? {
40        match event.event {
41            EventData::FormatDescription(_) | EventData::Rotate(_) => tables.clear(),
42            EventData::TableMap(table) => {
43                tables.insert(table.table_id, RowsDecoder::new(&table)?);
44            }
45            EventData::Rows(event) => {
46                if event.table_id != 0x00ff_ffff || event.flags & STMT_END_F == 0 {
47                    let decoder = tables.get(&event.table_id).ok_or_else(|| {
48                        Error::Invalid(format!("missing TABLE_MAP for {}", event.table_id))
49                    })?;
50                    for row in event.rows(decoder)? {
51                        let row = row?;
52                        for (label, image) in [("before", row.before), ("after", row.after)] {
53                            if let Some(image) = image {
54                                print_image(output, label, image.as_ref())?;
55                            }
56                        }
57                    }
58                }
59                if event.flags & STMT_END_F != 0 {
60                    tables.clear();
61                }
62            }
63            _ => {}
64        }
65    }
66    Ok(())
67}
examples/decode_rows.rs (line 38)
30fn main() -> Result<()> {
31    let args: Vec<_> = std::env::args().collect();
32    if args.len() != 2 {
33        eprintln!("usage: cargo run -p mysql-replication --example decode_rows -- BINLOG_FILE");
34        return Ok(());
35    }
36    let mut reader = BinlogFile::new(BufReader::new(File::open(&args[1])?))?;
37    let mut tables = BTreeMap::new();
38    while let Some(event) = reader.next_event()? {
39        match event.event {
40            EventData::FormatDescription(_) | EventData::Rotate(_) => tables.clear(),
41            EventData::TableMap(table) => {
42                // Replace the plan on every remap; never reuse a table ID across files.
43                tables.insert(table.table_id, RowsDecoder::new(&table)?);
44            }
45            EventData::Rows(rows) => {
46                // MySQL may send a statement-end marker without row data.
47                if rows.table_id != 0x00ff_ffff || rows.flags & STMT_END_F == 0 {
48                    let decoder = tables.get(&rows.table_id).ok_or_else(|| {
49                        Error::Invalid(format!("missing TABLE_MAP for {}", rows.table_id))
50                    })?;
51                    for row in rows.rows(decoder)? {
52                        let row = row?;
53                        print_image("before", row.before)?;
54                        print_image("after", row.after)?;
55                    }
56                }
57                if rows.flags & STMT_END_F != 0 {
58                    tables.clear();
59                }
60            }
61            _ => {}
62        }
63    }
64    Ok(())
65}

Auto Trait Implementations§

§

impl<R, M> Freeze for BinlogFile<R, M>
where R: Freeze, BinlogParser<M>: Freeze,

§

impl<R, M> RefUnwindSafe for BinlogFile<R, M>

§

impl<R, M> Send for BinlogFile<R, M>
where R: Send, BinlogParser<M>: Send,

§

impl<R, M> Sync for BinlogFile<R, M>
where R: Sync, BinlogParser<M>: Sync,

§

impl<R, M> Unpin for BinlogFile<R, M>
where R: Unpin, BinlogParser<M>: Unpin,

§

impl<R, M> UnsafeUnpin for BinlogFile<R, M>

§

impl<R, M> UnwindSafe for BinlogFile<R, M>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.