Struct MigrationProgressEvent 

#[non_exhaustive]
pub struct MigrationProgressEvent {
    pub step: MigrationStep,
    pub step_details: Option<StepDetails>,
    /* private fields */
}

An event signifying the start of a new step in a migration from Cloud Datastore to Cloud Firestore in Datastore mode.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

step: MigrationStep

The step that is starting.

An event with step set to START indicates that the migration has been reverted back to the initial pre-migration state.

step_details: Option<StepDetails>

Details about this step.

Implementations

impl MigrationProgressEvent

pub fn new() -> Self

pub fn set_step<T: Into<MigrationStep>>(self, v: T) -> Self

Sets the value of step.

pub fn set_step_details<T: Into<Option<StepDetails>>>(self, v: T) -> Self

Sets the value of step_details.

Note that all the setters affecting step_details are mutually exclusive.

pub fn prepare_step_details(&self) -> Option<&Box<PrepareStepDetails>>

The value of step_details if it holds a PrepareStepDetails, None if the field is not set or holds a different branch.

pub fn set_prepare_step_details<T: Into<Box<PrepareStepDetails>>>( self, v: T, ) -> Self

Sets the value of step_details to hold a PrepareStepDetails.

Note that all the setters affecting step_details are mutually exclusive.

pub fn redirect_writes_step_details( &self, ) -> Option<&Box<RedirectWritesStepDetails>>

The value of step_details if it holds a RedirectWritesStepDetails, None if the field is not set or holds a different branch.

pub fn set_redirect_writes_step_details<T: Into<Box<RedirectWritesStepDetails>>>( self, v: T, ) -> Self

Sets the value of step_details to hold a RedirectWritesStepDetails.

Note that all the setters affecting step_details are mutually exclusive.

Trait Implementations

impl Clone for MigrationProgressEvent

fn clone(&self) -> MigrationProgressEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MigrationProgressEvent

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

Formats the value using the given formatter.

impl Default for MigrationProgressEvent

fn default() -> MigrationProgressEvent

Returns the “default value” for a type.

impl Message for MigrationProgressEvent

fn typename() -> &'static str

The typename of this message.

impl PartialEq for MigrationProgressEvent

fn eq(&self, other: &MigrationProgressEvent) -> 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 StructuralPartialEq for MigrationProgressEvent