Skip to main content

MigrationChain

Struct MigrationChain 

Source
pub struct MigrationChain<S> { /* private fields */ }
Expand description

A chain of migrations that can upgrade state through multiple versions.

§Design

The migration chain executes migrations in sequence, starting from the stored version and ending at the current version. Each step increments the version by exactly one.

§Example

let mut chain = MigrationChain::<FinalState>::new();
chain.register(Box::new(V1ToV2Migration));
chain.register(Box::new(V2ToV3Migration));

// Migrate from v1 to v3 (current)
let result = chain.migrate_to_current(v1_state, 1, 3);

Implementations§

Source§

impl<S: 'static> MigrationChain<S>

Source

pub fn new() -> Self

Create an empty migration chain.

Source

pub fn register(&mut self, migration: Box<dyn ErasedMigration<S>>)

Register a migration step.

§Panics

Panics if a migration for the same from_version is already registered.

Source

pub fn has_path(&self, from_version: u32, to_version: u32) -> bool

Check if a migration path exists from from_version to to_version.

Source

pub fn migrate( &self, state: Box<dyn Any + Send>, from_version: u32, to_version: u32, ) -> Result<Box<dyn Any + Send>, MigrationError>

Attempt to migrate state from from_version to to_version.

Returns Ok(migrated_state) on success, or Err if migration fails.

Trait Implementations§

Source§

impl<S: 'static> Default for MigrationChain<S>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<S> Freeze for MigrationChain<S>

§

impl<S> !RefUnwindSafe for MigrationChain<S>

§

impl<S> Send for MigrationChain<S>

§

impl<S> Sync for MigrationChain<S>

§

impl<S> Unpin for MigrationChain<S>

§

impl<S> !UnwindSafe for MigrationChain<S>

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<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, 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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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