Skip to main content

MigrationState

Enum MigrationState 

Source
#[non_exhaustive]
pub enum MigrationState { Ready, ReadyWithOmissions, Incomplete, }
Expand description

How far a migration into an app root got. Recorded in the versioned state file (MIGRATION_STATE); read it with AppRoot::migration_state or MigrationReport::state.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Ready

Everything in the recorded scope was migrated & verified. Whole-tree scope also writes the historical marker MIGRATION_MARKER.

§

ReadyWithOmissions

Every required entry is in place. Only entries the caller declared disposable are missing, and each is recorded (optional links that could not be created, reparse points skipped on request). The destination is usable. The historical marker is not written, so a reader of an earlier version does not take it for a complete move; a rerun retries the omitted links.

§

Incomplete

The copy was started and not finished (interrupted, or stopped by a failure such as a required link the destination cannot create). The destination is not usable: the old root stays the authority. A rerun verifies and finishes the copy. No historical marker exists.

Implementations§

Source§

impl MigrationState

Source

pub fn as_str(self) -> &'static str

The name written in the state file: ready, ready_with_omissions or incomplete.

Source

pub fn is_usable(self) -> bool

True when the destination may be used as the app’s data root (Ready or ReadyWithOmissions).

Trait Implementations§

Source§

impl Clone for MigrationState

Source§

fn clone(&self) -> Self

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 Copy for MigrationState

Source§

impl Debug for MigrationState

Source§

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

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

impl Eq for MigrationState

Source§

impl PartialEq for MigrationState

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for MigrationState

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.

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> 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 = !

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.