Enum FilterResult 

pub enum FilterResult {
    WouldChange {
        summary: String,
        width_warning: Option<String>,
    },
    RefusedNotASpreadsheet {
        mime_type: String,
    },
    RefusedShortcut,
    RefusedNoVisibleParents,
    RefusedSheetNotFound {
        title: String,
        available: Vec<String>,
    },
    RefusedInvalidRange {
        detail: String,
    },
    RefusedFilterViewNotFound {
        filter_view_id: i64,
    },
    Blocked {
        operation: DriveOperation,
        decided_by: Option<DecidingRule>,
    },
    RefusedNoLease,
    RefusedLeaseExpired,
    RefusedLeaseWrongFile,
    RefusedLeaseStale,
    Unchanged {
        detail: String,
    },
    Changed {
        summary: String,
        filter_view_id: Option<i64>,
        width_warning: Option<String>,
    },
    AppliedReplyUnreadable {
        summary: String,
        filter_view_id: Option<i64>,
        width_warning: Option<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.

width_warning: Option<String>

For a row reorder (set-basic-filter --sort-by) whose range is narrower than its sheet, the record-integrity caveat sort-range leads with (ADR-0083 §6). Omitted otherwise.

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 verb’s own arguments were invalid — a bad --sort-by/ --hide-values format, a malformed --sheet/--range pair, or (for update-filter-view) nothing to change.

Fields

detail: String

What was wrong and why.

RefusedFilterViewNotFound

update-filter-view/delete-filter-view named a --filter-view-id that does not exist in this workbook.

Fields

filter_view_id: i64

The id that was not found.

Blocked

The folder write-permission gate refused it.

Fields

operation: DriveOperation

Which of FilterVerb::gate_operations denied first — only ever not sheets-structure for set-basic-filter --sort-by’s union gate, where which of the two denied is the actionable part of the message.

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

Unchanged

The workbook is already in the requested state (clear-basic-filter on a sheet with no basic filter), so no request is sent. Reported identically by a dry run and a real run.

Fields

detail: String

Why nothing needed to change.

Changed

The mutation succeeded.

Fields

summary: String

Same summary as Self::WouldChange.

filter_view_id: Option<i64>

The filter view’s stable id — server-assigned for add-filter-view, otherwise the one resolved against. None for set-basic-filter/clear-basic-filter.

width_warning: Option<String>

Same as Self::WouldChange’s.

AppliedReplyUnreadable

The API answered 2xx — the mutation was applied — but its reply could not be read (issue #2021). Distinct from Self::Failed: a retry here could duplicate a filter view. The server-assigned id of an added filter view was in that reply, so it is unknown.

Fields

summary: String

Same summary as Self::WouldChange.

filter_view_id: Option<i64>

The filter view id resolved before the call — Some for update-filter-view/delete-filter-view, None otherwise. Never the server-assigned id of an added view (that was in the reply).

width_warning: Option<String>

Same as Self::Changed’s.

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 FilterResult

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 FilterResult

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

Formats the value using the given formatter.

impl Eq for FilterResult

impl PartialEq for FilterResult

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FilterResult

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 FilterResult