Enum WritePayload 

pub enum WritePayload {
    Table(TableEdit),
    Replace {
        search: String,
        replace: String,
        match_case: bool,
    },
    Append {
        text: String,
    },
    Insert {
        anchor: String,
        side: Side,
        text: String,
        match_case: bool,
        selection: SegmentSelection,
    },
    Format {
        from: String,
        to: Option<String>,
        match_case: bool,
        style: StylePatch,
    },
    NamedRange {
        scope: Scope,
        mutation: Mutation,
    },
    Delete {
        from: String,
        to: Option<String>,
        match_case: bool,
        selection: SegmentSelection,
    },
    List {
        from: String,
        to: Option<String>,
        preset: Option<BulletPreset>,
        match_case: bool,
    },
}

What to mutate.

An enum carrying its own data rather than a verb discriminant plus a bag of Options, so “a replace with no search text” is unrepresentable. This is the one place this module improves on sheets/write.rs’s template rather than copying it: that module’s WriteVerb::Clear sits beside a values field which must be empty, and describe has to special-case the pairing.

Variants

Table(TableEdit)

Typed table structural mutation.

Replace

Replace every occurrence of search with replace.

Fields

search: String

The literal substring to find. Never a regex.

replace: String

What to put in its place.

match_case: bool

Whether matching is case-sensitive.

Append

Append text to the end of the document body.

Fields

text: String

The text to insert.

Insert

Insert next to a unique anchor in tab bodies or an existing segment.

Fields

anchor: String

Literal text to locate in the snapshot.

side: Side

Which edge of the anchor to use.

text: String

Text to insert.

match_case: bool

Case-sensitive by default.

selection: SegmentSelection

Existing non-body segment selector; default addresses tab bodies.

Format

Apply a bounded style patch to a unique anchored range.

Fields

from: String

First anchor or complete match.

to: Option<String>

Inclusive final anchor.

match_case: bool

Literal matching case sensitivity.

style: StylePatch

Explicit style values.

NamedRange

A scoped named-range metadata or content mutation.

Fields

scope: Scope

Explicit tab and segment address.

mutation: Mutation

Typed operation and its data.

Delete

Delete a unique match or an inclusive pair of anchors.

Fields

from: String

First anchor (or the entire single match).

to: Option<String>

Last anchor, when deleting an inclusive range.

match_case: bool

Case-sensitive by default.

selection: SegmentSelection

Existing non-body segment selector; default addresses tab bodies.

List

Apply or remove list formatting on whole anchor-selected paragraphs.

Fields

from: String

First anchor or single-paragraph match.

to: Option<String>

Last anchor, inclusive of its containing paragraph.

preset: Option<BulletPreset>

Creation uses a concrete preset; None removes bullets.

match_case: bool

Case-sensitive by default.

Implementations

impl WritePayload

pub const fn verb(&self) -> WriteVerb

Which verb this payload is.

pub const fn gate_operation(&self) -> DriveOperation

Permission vocabulary is independent of the request’s wire operation. List creation/removal uses DocsWrite: removal preserves prose, while creation’s leading-tab removal is an explicit part of formatting consent.

Trait Implementations

impl Clone for WritePayload

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 WritePayload

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

Formats the value using the given formatter.

impl Eq for WritePayload

impl PartialEq for WritePayload

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WritePayload