Enum WriteResult 

pub enum WriteResult {
    WouldEditTable {
        edit: TablePreview,
    },
    EditedTable {
        edit: TablePreview,
    },
    RefusedTable {
        error: TableError,
    },
    WouldMutateNamedRange {
        preview: Preview,
    },
    MutatedNamedRange {
        preview: Preview,
    },
    RefusedNamedRange {
        error: Error,
    },
    WouldReplace {
        occurrences: usize,
    },
    WouldAppend {
        document_end_index: Option<i64>,
        chars: usize,
        bytes: usize,
    },
    WouldInsert {
        edit: EditPreview,
    },
    WouldDelete {
        edit: EditPreview,
    },
    Inserted {
        edit: EditPreview,
    },
    Deleted {
        edit: EditPreview,
    },
    WouldFormatList {
        edit: ListPreview,
        preset: Option<BulletPreset>,
    },
    ListFormatted {
        edit: ListPreview,
        preset: Option<BulletPreset>,
    },
    WouldFormat {
        edit: EditPreview,
        style: StylePatch,
        fields: String,
    },
    Formatted {
        edit: EditPreview,
        style: StylePatch,
        fields: String,
    },
    RefusedAnchor {
        error: AnchorError,
    },
    RefusedNotADocument {
        mime_type: String,
    },
    RefusedShortcut,
    RefusedNoVisibleParents,
    RefusedNoRevisionId,
    Blocked {
        decided_by: Option<DecidingRule>,
    },
    RefusedNoLease,
    RefusedLeaseExpired,
    RefusedLeaseWrongFile,
    RefusedLeaseStale,
    Replaced {
        occurrences_changed: i64,
    },
    Appended {
        chars: usize,
        bytes: usize,
    },
    StaleRevision {
        required_revision_id: String,
        detail: String,
    },
    Failed {
        detail: String,
    },
}

What happened (or, under --dry-run, would happen).

Variants

WouldEditTable

Snapshot-resolved table preview.

Fields

edit: TablePreview

The exact structural effect.

EditedTable

A table mutation applied.

Fields

edit: TablePreview

Same effect metadata as the preview.

RefusedTable

Table addressing failed closed.

Fields

error: TableError

Typed refusal, without user prose.

WouldMutateNamedRange

Preview of one named-range mutation. Counts contain no prose.

Fields

preview: Preview

Complete resolved effect.

MutatedNamedRange

One named-range request succeeded.

Fields

preview: Preview

Complete effect, including the server-assigned create ID when returned.

RefusedNamedRange

Scope or named-range content cannot safely identify the requested effect.

Fields

error: Error

Typed refusal without document text or range names.

WouldReplace

A dry run of a replace: how many occurrences the snapshot held.

Fields

occurrences: usize

Counted client-side. Display-only — see count_occurrences.

WouldAppend

A dry run of an append.

Fields

document_end_index: Option<i64>

The body’s last endIndex, purely informational — nothing computes from it (ADR-0076 §5).

chars: usize

Unicode scalar values being inserted.

bytes: usize

UTF-8 bytes being inserted.

WouldInsert

Dry-run metadata for insertion.

Fields

edit: EditPreview

Resolved effect, in UTF-16 units.

WouldDelete

Dry-run metadata for deletion.

Fields

edit: EditPreview

Resolved effect, in UTF-16 units.

Inserted

An insertion landed at the resolved position.

Fields

edit: EditPreview

The same metadata as the preview.

Deleted

A deletion landed over the resolved range.

Fields

edit: EditPreview

The same metadata as the preview.

WouldFormatList

Metadata-only preview of whole-paragraph list formatting.

Fields

edit: ListPreview

Range before any leading tabs are removed.

preset: Option<BulletPreset>

Some for creation, None for removal.

ListFormatted

List formatting applied; indices still describe the pre-write snapshot.

Fields

edit: ListPreview

The same metadata as the preview.

preset: Option<BulletPreset>

Some for creation, None for removal.

WouldFormat

Exact requested formatting effect before mutation.

Fields

edit: EditPreview

Affected range and character/paragraph counts (no text mutation).

style: StylePatch

Explicit style properties.

fields: String

Derived property mask.

Formatted

The same requested formatting effect after a successful mutation.

Fields

edit: EditPreview

Affected range and counts.

style: StylePatch

Explicit style properties.

fields: String

Derived property mask.

RefusedAnchor

An anchor could not safely identify a unique effect.

Fields

error: AnchorError

Typed reason containing no anchor text.

RefusedNotADocument

The target is not a Google Doc.

Fields

mime_type: String

Its actual mime type.

RefusedShortcut

The target is a shortcut, which is never followed.

RefusedNoVisibleParents

The target has no parent folder this account can see, so no folder rule can apply and no file_id rule named it either.

RefusedNoRevisionId

documents.get returned no revisionId, which Google populates only for callers with edit access — so no lease can be taken, and there is no unleased path (ADR-0076 §3).

Blocked

The write-permission gate refused it.

Fields

decided_by: Option<DecidingRule>

The rule that decided, when one did.

RefusedNoLease

No --lease was presented, and the deciding rule requires one (ADR-0080 §9).

RefusedLeaseExpired

The presented lease has expired, or was never a token this ledger knows about.

RefusedLeaseWrongFile

The presented lease is bound to a different file id.

RefusedLeaseStale

The file has moved since the lease’s recorded version — the staleness check (ADR-0080 §6). Distinct from Self::StaleRevision, which is ADR-0076’s own, unrelated Docs revision check.

Replaced

A replace landed.

Fields

occurrences_changed: i64

What the server reported changing.

Not Option: a replace always has an answer, and “nothing matched” is a count rather than an absence of one. Docs omits occurrencesChanged entirely when it is zero (proto3), so the zero is resolved at the boundary — see crate::drive::docs::write_types::BatchUpdateDocumentResponse::occurrences_changed_for_replace.

Appended

An append landed.

Fields

chars: usize

Unicode scalar values inserted.

bytes: usize

UTF-8 bytes inserted.

StaleRevision

The document changed between the read that computed this mutation and the batchUpdate that would have applied it. Nothing was written — a one-request batch is atomic.

Fields

required_revision_id: String

The lease presented, for the log and for support.

detail: String

The server’s own message, unaltered.

Failed

Anything else.

Fields

detail: String

The error, verbatim.

Trait Implementations

impl Clone for WriteResult

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WriteResult

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

Formats the value using the given formatter.

impl Eq for WriteResult

impl PartialEq for WriteResult

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for WriteResult

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 WriteResult