Enum MigrationStep

#[non_exhaustive]
pub enum MigrationStep {
    Unspecified,
    Prepare,
    Start,
    ApplyWritesSynchronously,
    CopyAndVerify,
    RedirectEventuallyConsistentReads,
    RedirectStronglyConsistentReads,
    RedirectWrites,
    UnknownValue(UnknownValue),
}

Steps in a migration.

Working with unknown values

This enum is defined as #[non_exhaustive] because Google Cloud may add additional enum variants at any time. Adding new variants is not considered a breaking change. Applications should write their code in anticipation of:

• New values appearing in future releases of the client library, and
• New values received dynamically, without application changes.

Please consult the Working with enums section in the user guide for some guidelines.

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.

Unspecified

Unspecified.

Prepare

Pre-migration: the database is prepared for migration.

Start

Start of migration.

ApplyWritesSynchronously

Writes are applied synchronously to at least one replica.

CopyAndVerify

Data is copied to Cloud Firestore and then verified to match the data in Cloud Datastore.

RedirectEventuallyConsistentReads

Eventually-consistent reads are redirected to Cloud Firestore.

RedirectStronglyConsistentReads

Strongly-consistent reads are redirected to Cloud Firestore.

RedirectWrites

Writes are redirected to Cloud Firestore.

UnknownValue(UnknownValue)

If set, the enum was initialized with an unknown value.

Applications can examine the value using MigrationStep::value or MigrationStep::name.

Implementations

impl MigrationStep

pub fn value(&self) -> Option<i32>

Gets the enum value.

Returns None if the enum contains an unknown value deserialized from the string representation of enums.

pub fn name(&self) -> Option<&str>

Gets the enum value as a string.

Returns None if the enum contains an unknown value deserialized from the integer representation of enums.

Trait Implementations

impl Clone for MigrationStep

fn clone(&self) -> MigrationStep

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MigrationStep

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

Formats the value using the given formatter.

impl Default for MigrationStep

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MigrationStep

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MigrationStep

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

Formats the value using the given formatter.

impl From<&str> for MigrationStep

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<i32> for MigrationStep

fn from(value: i32) -> Self

Converts to this type from the input type.

impl PartialEq for MigrationStep

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

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 MigrationStep