Archiver

Struct Archiver 

Source
pub struct Archiver<W> { /* private fields */ }
Expand description

Writer of sqlite3 data - toplevel entrypoint

W should be buffered. After an error, it is not safe to continue to write to W (with these facilities, or any other): partial data may have been written, so the output should then be treated as corrupted and useless.

To use this:

Implementations§

Source§

impl<W: Write> Archiver<W>

Source

pub fn start<S: Into<String>>( dbt: &Transaction<'_>, w: W, table_names: impl IntoIterator<Item = S>, ) -> Result<Self, Error>

Start writing a dump.

Will enumerate the tables found in the database, and pass their names to table_names.

This can be used to enumerate over all tables; or they can be ignored if only certain tables need to be dumped.

(The schema for every existing table will be dumped, unconditionally; there is not currently a way to control this.)

Source

pub fn start_table(&mut self, name: &str) -> Result<TableArchiver<'_, W>, Error>

Start writing a dump of a particular table.

Source

pub fn finish(self) -> Result<(), Error>

Finish writing the dump.

The writer W will be flushed and then dropped.

Source

pub fn finish_with_writer(self) -> Result<W, Error>

Finish writing the dump, returning the writer.

The writer W will be flushed.

Source

pub fn writer_mut(&mut self) -> &mut W

Access the inner writer

Take care! Using this to write will probably make data corruption.

Auto Trait Implementations§

§

impl<W> Freeze for Archiver<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for Archiver<W>
where W: RefUnwindSafe,

§

impl<W> Send for Archiver<W>
where W: Send,

§

impl<W> Sync for Archiver<W>
where W: Sync,

§

impl<W> Unpin for Archiver<W>
where W: Unpin,

§

impl<W> UnwindSafe for Archiver<W>
where W: UnwindSafe,

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.