Skip to main content

MigrationRegistry

Struct MigrationRegistry 

Source
pub struct MigrationRegistry { /* private fields */ }
Expand description

Names → forward (and optional backwards) functions.

Implementations§

Source§

impl MigrationRegistry

Source

pub fn new() -> Self

Empty registry.

Source

pub fn register( &mut self, name: impl Into<String>, f: impl Fn(Db) -> RustFuture + Send + Sync + 'static, )

Register name. The same map is used for forwards and backwards; a reversible RunRust stores both names as separate entries.

Args: name: Operation identifier in the migration file. f: Callback whose future owns completion of its work.

Returns: None after registering with ordinary, conservative retry policy.

Unconfirmed non-transactional execution blocks automatic retry. Use register_replay_safe only with an established idempotence contract.

Source

pub fn register_replay_safe( &mut self, name: impl Into<String>, f: impl Fn(Db) -> RustFuture + Send + Sync + 'static, )

Register a callback whose committed effects can safely be repeated.

Args: name: Operation name used by the migration file. f: Callback safe to retry after interruption at any await point.

Returns: None after registering the callback and its explicit retry policy.

Use only after establishing idempotence for database and external effects. Registration permits retry; it does not verify idempotence. Ordinary register clears this declaration when replacing a name.

Source

pub async fn run(&self, name: &str, db: &Db) -> Result<(), MigrationError>

Run the function named name.

On SQLite the function runs on the schema-change connection with PRAGMA foreign_keys off (see the migrations guide), so data code must stay FK-clean by hand; orphans fail the migration at commit.

§Errors

MigrationError::UnregisteredRust or the function’s own error.

Trait Implementations§

Source§

impl Clone for MigrationRegistry

Source§

fn clone(&self) -> MigrationRegistry

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MigrationRegistry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MigrationRegistry

Source§

fn default() -> MigrationRegistry

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more