Struct MigrationsWorker

Source

pub struct MigrationsWorker<DB>where
    DB: Database,
    <DB as Database>::Connection: Migrate,
{ /* private fields */ }

Expand description

An asynchronous worker that applies database migrations in the background and signals completion to whoever cares to listen via the returned Gate.

Implementations§

Source §

impl<DB> MigrationsWorker<DB>
where DB: Database, <DB as Database>::Connection: Migrate,

Source

pub async fn start( name: impl AsRef<str>, migrator: &'static Migrator, pool: Pool<DB>, ) -> Gate

Starts applying migrations using the given static reference to a migrator and the given pool of database connections. The given name is attached to this MigrationsWorker for logging/alerting purposes.

The returned Gate can be used to await for the migrations to be successfully applied.

Auto Trait Implementations§

§

impl<DB> !UnwindSafe for MigrationsWorker<DB>

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

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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 §