Enum MigrationState 

#[non_exhaustive]
pub enum MigrationState {
    Planned,
    InProgress {
        processed: usize,
        total: usize,
        skipped: usize,
    },
    Paused {
        processed: usize,
        total: usize,
        skipped: usize,
        reason: String,
    },
    Completed {
        processed: usize,
        skipped: usize,
        duration_secs: f64,
    },
    Failed {
        processed: usize,
        total: usize,
        skipped: usize,
        error: String,
    },
    Cancelled {
        processed: usize,
        total: usize,
        skipped: usize,
    },
}

Migration state machine states.

Variants (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.

Planned

Migration is planned but has not started.

InProgress

Migration is actively processing embeddings.

Fields

processed: usize

Number of embeddings processed so far.

total: usize

Total number of embeddings to process.

skipped: usize

Number of embeddings skipped.

Paused

Migration is paused (can be resumed).

Fields

processed: usize

Number of embeddings processed before pause.

total: usize

Total number of embeddings to process.

skipped: usize

Number of embeddings skipped.

reason: String

Reason the migration was paused.

Completed

Migration completed successfully.

Fields

processed: usize

Total number of embeddings processed.

skipped: usize

Number of embeddings skipped.

duration_secs: f64

Wall-clock duration in seconds.

Failed

Migration failed with an error.

Fields

processed: usize

Number of embeddings processed before failure.

total: usize

Total number of embeddings to process.

skipped: usize

Number of embeddings skipped.

error: String

Error message describing the failure.

Cancelled

Migration was cancelled by the operator.

Fields

processed: usize

Number of embeddings processed before cancellation.

total: usize

Total number of embeddings to process.

skipped: usize

Number of embeddings skipped.

Implementations

impl MigrationState

pub fn is_resumable(&self) -> bool

Returns true if the migration can be resumed (paused or failed).

pub fn is_terminal(&self) -> bool

Returns true if the migration has reached a terminal state (completed or cancelled).

pub fn is_active(&self) -> bool

Returns true if the migration is currently in progress.

pub fn progress(&self) -> Option<f64>

Returns the progress as a fraction in [0.0, 1.0], or None if not applicable.

pub fn processed(&self) -> usize

Returns the number of embeddings processed so far.

pub fn skipped(&self) -> usize

Returns the number of embeddings skipped.

pub fn total(&self) -> usize

Returns the total number of embeddings to process.

pub fn effective_total(&self) -> usize

Returns total minus skipped – the number of embeddings that actually need processing.

pub fn effective_coverage(&self) -> f64

Returns the fraction of effective_total that has been processed (0.0 to 1.0).

Trait Implementations

impl Clone for MigrationState

fn clone(&self) -> MigrationState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MigrationState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MigrationState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MigrationState

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MigrationState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MigrationState