Enum ProtectionVerb 

pub enum ProtectionVerb {
    ProtectRange {
        sheet: Option<String>,
        range: Option<String>,
        whole_sheet: bool,
        description: Option<String>,
        warning_only: bool,
        editors: Vec<String>,
    },
    UpdateProtection {
        sheet: Option<String>,
        range: Option<String>,
        whole_sheet: bool,
        description: Option<String>,
        warning_only: Option<bool>,
        add_editors: Vec<String>,
        remove_editors: Vec<String>,
    },
    UnprotectRange {
        sheet: Option<String>,
        range: Option<String>,
        whole_sheet: bool,
    },
}

Which mutation to perform.

Variants

ProtectRange

Protect a range (or, with whole_sheet, an entire sheet).

Fields

sheet: Option<String>

A sheet title, supplying a prefix for a bare range. Also the target sheet directly when whole_sheet is set.

range: Option<String>

An explicit A1 range, which may carry its own Sheet! prefix. Mutually exclusive with whole_sheet.

whole_sheet: bool

Protect the entire sheet named by sheet, rather than a range within it.

description: Option<String>

A human-readable note about why the range is protected.

warning_only: bool

true only warns on an edit; false (the default) blocks it.

editors: Vec<String>

Editors exempted from the protection.

UpdateProtection

Change an existing protected range’s description, warning-only flag, or editor list.

Fields

sheet: Option<String>

A sheet title, supplying a prefix for a bare range. Also the target sheet directly when whole_sheet is set.

range: Option<String>

An explicit A1 range identifying the existing protection to change, by exact match. Mutually exclusive with whole_sheet.

whole_sheet: bool

Target the whole-sheet protection on sheet, rather than one covering a range within it — the only way to address a protection protect-range --whole-sheet created, since it has no range of its own to match against.

description: Option<String>

The new description, when changing it.

warning_only: Option<bool>

The new warning-only flag, when changing it.

add_editors: Vec<String>

Editors to add.

remove_editors: Vec<String>

Editors to remove.

UnprotectRange

Remove a protected range.

Fields

sheet: Option<String>

A sheet title, supplying a prefix for a bare range. Also the target sheet directly when whole_sheet is set.

range: Option<String>

An explicit A1 range identifying the protection to remove, by exact match. Mutually exclusive with whole_sheet.

whole_sheet: bool

Target the whole-sheet protection on sheet — see Self::UpdateProtection::whole_sheet.

Trait Implementations

impl Clone for ProtectionVerb

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 ProtectionVerb

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

Formats the value using the given formatter.

impl Eq for ProtectionVerb

impl PartialEq for ProtectionVerb

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ProtectionVerb