Enum WriteResult 

pub enum WriteResult {
    WouldWrite {
        rows: usize,
        columns: usize,
    },
    WouldClear,
    RefusedNotASpreadsheet {
        mime_type: String,
    },
    RefusedShortcut,
    RefusedNoVisibleParents,
    RefusedSheetNotFound {
        title: String,
        available: Vec<String>,
    },
    RefusedEmptyValues,
    Blocked {
        decided_by: Option<DecidingRule>,
    },
    RefusedNoLease,
    RefusedLeaseExpired,
    RefusedLeaseWrongFile,
    RefusedLeaseStale,
    Written {
        updated_range: Option<String>,
        updated_rows: Option<i64>,
        updated_columns: Option<i64>,
        updated_cells: Option<i64>,
    },
    Appended {
        updated_range: Option<String>,
        updated_rows: Option<i64>,
        updated_columns: Option<i64>,
        updated_cells: Option<i64>,
    },
    Cleared {
        updated_range: Option<String>,
    },
    Failed {
        detail: String,
    },
}

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

Variants

WouldWrite

--dry-run of a write/append, and the gate would allow it.

Fields

rows: usize

Rows of input parsed, so a transposed or ragged input is visible before it lands.

columns: usize

Widest row, likewise.

WouldClear

--dry-run of a clear, and the gate would allow it. Its own variant rather than a WouldWrite of 0 x 0: a clear takes no values, so those dimensions would always be zero (#1941).

RefusedNotASpreadsheet

The target is not a Google Sheet. Checked client-side before the gate: writing cells into a PDF isn’t disallowed, it’s meaningless.

Fields

mime_type: String

The target’s actual MIME type.

RefusedShortcut

The target is a shortcut. Given its own variant rather than falling into RefusedNotASpreadsheet, because “this is not a spreadsheet” is a confusing thing to say about a shortcut to a spreadsheet — the same distinction drive read --content already draws.

RefusedNoVisibleParents

The target has no parents this account can see, so the gate has no ancestor chain to evaluate — and no file_id rule named it either, so nothing granted it.

Distinct from Blocked { decided_by: None }, which means “a chain was resolved and no rule matched”. Conflating them would send an operator off to fix folder rules when no folder rule they could write would help. This is the common shape for a Sheet shared by link or email; since issue #1612 the fix is a file_id rule, and this variant is reached only once that lookup has come up empty.

RefusedSheetNotFound

The named sheet (from --sheet, or the range’s own Sheet! prefix) does not exist in this workbook. Checked client-side, like find-replace/sort-range/auto-fill/paste and friends, rather than letting the API’s opaque “Unable to parse range” stand in for it (#1941).

Fields

title: String

The title that was not found.

available: Vec<String>

The titles that do exist.

RefusedEmptyValues

write/append’s --values resolved to zero rows, so there is nothing to write. clear takes no values and is unaffected.

Blocked

The folder write-permission gate refused it.

Fields

decided_by: Option<DecidingRule>

The rule that decided the refusal, if any (None means the bare default policy — every write defaults deny).

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).

Written

A write succeeded.

Every count is optional because the API may omit it.

Fields

updated_range: Option<String>

The server-normalised range actually written.

updated_rows: Option<i64>

Rows the API reported changing.

updated_columns: Option<i64>

Columns the API reported changing.

updated_cells: Option<i64>

Cells the API reported changing.

Appended

An append succeeded. The same counts as Self::Written, under its own status so a script can tell an append from an overwrite (#1941).

Fields

updated_range: Option<String>

The server-normalised range the rows landed in.

updated_rows: Option<i64>

Rows the API reported appending.

updated_columns: Option<i64>

Columns the API reported appending.

updated_cells: Option<i64>

Cells the API reported appending.

Cleared

A clear succeeded. The API reports no counts for a clear, only the range.

Fields

updated_range: Option<String>

The server-normalised range actually cleared.

Failed

An API or validation error.

Fields

detail: String

A human-readable summary of what failed.

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