Enum FormatResult 

pub enum FormatResult {
    WouldChange {
        summary: String,
        discarded_cells: Vec<String>,
    },
    RefusedNotASpreadsheet {
        mime_type: String,
    },
    RefusedShortcut,
    RefusedNoVisibleParents,
    RefusedSheetNotFound {
        title: String,
        available: Vec<String>,
    },
    RefusedInvalidRange {
        detail: String,
    },
    Blocked {
        decided_by: Option<DecidingRule>,
    },
    RefusedNoLease,
    RefusedLeaseExpired,
    RefusedLeaseWrongFile,
    RefusedLeaseStale,
    Changed {
        summary: String,
        discarded_cells: Vec<String>,
    },
    AppliedReplyUnreadable {
        summary: String,
        discarded_cells: Vec<String>,
        detail: String,
    },
    Failed {
        detail: String,
    },
}

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

Variants

WouldChange

--dry-run, and the gate would allow it.

Fields

summary: String

A human-readable summary of the effect — also the request log’s fields_changed.

discarded_cells: Vec<String>

merge-cells only: the non-top-left, non-blank cells that would be discarded, as "A1: value" strings.

RefusedNotASpreadsheet

The target is not a Google Sheet.

Fields

mime_type: String

The target’s actual MIME type.

RefusedShortcut

The target is a shortcut, which we do not follow.

RefusedNoVisibleParents

The target has no parents this account can see.

RefusedSheetNotFound

The named sheet does not exist in this workbook.

Fields

title: String

The title that was not found.

available: Vec<String>

The titles that do exist.

RefusedInvalidRange

The --sheet/--range pair was invalid (conflicting, empty, or a bare range naming no sheet at all).

Fields

detail: String

What was wrong and why.

Blocked

The folder write-permission gate refused it.

Fields

decided_by: Option<DecidingRule>

The rule that decided the refusal, if any.

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

Changed

The mutation succeeded.

Fields

summary: String

Same summary as Self::WouldChange, describing what was actually done.

discarded_cells: Vec<String>

merge-cells only: the cells whose values were discarded.

AppliedReplyUnreadable

The API answered 2xx — the mutation was applied — but its reply could not be read (issue #2021). Distinct from Self::Failed: the formatting change happened, so the sheet already carries it.

Fields

summary: String

Same summary as Self::WouldChange.

discarded_cells: Vec<String>

Same as Self::Changed — read before the mutating call, so not lost with the reply.

detail: String

Why the reply could not be read.

Failed

An API or validation error.

Fields

detail: String

A human-readable summary of what failed.

Trait Implementations

impl Clone for FormatResult

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 FormatResult

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

Formats the value using the given formatter.

impl Eq for FormatResult

impl PartialEq for FormatResult

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FormatResult

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 FormatResult