Enum SchemaChange 

pub enum SchemaChange {
    Safe,
    NeedsMigration {
        reason: String,
        backfill_top_level_field: Option<String>,
        backfill_field_path: Option<FieldPath>,
    },
    Breaking {
        reason: String,
    },
}

Compatibility classification for a proposed schema update.

Variants

Safe

Update is safe to apply without rewriting existing data.

NeedsMigration

Update is supported, but existing data must be rewritten/backfilled first.

Fields

reason: String

backfill_top_level_field: Option<String>

Top-level field name to backfill when adding a new required single-segment field.

backfill_field_path: Option<FieldPath>

Full path to backfill when adding a new required field (any segment count).

Breaking

Update is not supported/safe and should be rejected by default.

Fields

reason: String

Trait Implementations

impl Clone for SchemaChange

fn clone(&self) -> SchemaChange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaChange

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

Formats the value using the given formatter.

impl PartialEq for SchemaChange

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

impl StructuralPartialEq for SchemaChange