Struct Sheet 

pub struct Sheet {
    pub properties: Option<SheetProperties>,
    pub protected_ranges: Vec<ProtectedRange>,
    pub basic_filter: Option<BasicFilter>,
    pub filter_views: Vec<FilterView>,
    pub conditional_formats: Vec<ConditionalFormatRule>,
    pub charts: Vec<EmbeddedChart>,
    pub slicers: Vec<Slicer>,
    pub banded_ranges: Vec<BandedRange>,
    pub row_groups: Vec<DimensionGroup>,
    pub column_groups: Vec<DimensionGroup>,
    pub data: Vec<GridData>,
}

One sheet (tab) within a spreadsheet. PartialEq-only, not Eq (issue #1793) — see Spreadsheet’s doc comment.

Fields

properties: Option<SheetProperties>

This sheet’s properties.

protected_ranges: Vec<ProtectedRange>

Protected ranges on this sheet. Empty unless the caller requested them with a wider fields mask — SPREADSHEET_FIELDS (the mask every other call uses) omits this, so a plain sheets info/ structure read never pays for it; only SheetsApi::get_spreadsheet_with_protections populates it.

basic_filter: Option<BasicFilter>

This sheet’s basic filter, if it has one. Empty unless the caller requested it with a wider fields mask — only SheetsApi::get_spreadsheet_with_filter_views populates it (issue #1794).

filter_views: Vec<FilterView>

The named, id-addressed filter views on this sheet. Empty unless the caller requested them with a wider fields mask — only SheetsApi::get_spreadsheet_with_filter_views populates it (issue #1794).

conditional_formats: Vec<ConditionalFormatRule>

Conditional format rules on this sheet, in their API-defined evaluation order — the order add-conditional-format’s --index/ update-conditional-format’s and delete-conditional-format’s --index address. Empty unless the caller requested a wider fields mask; only SheetsApi::get_spreadsheet_with_conditional_formats populates it (issue #1793).

charts: Vec<EmbeddedChart>

Charts embedded on this sheet. Empty unless the caller requested them with a wider fields mask — only SheetsApi::get_spreadsheet_with_embedded_objects populates it (issue #1797). chartId-addressed by update-chart/delete-chart; list-charts is how that id is discovered.

slicers: Vec<Slicer>

Slicers embedded on this sheet. Empty unless the caller requested them with a wider fields mask — only SheetsApi::get_spreadsheet_with_embedded_objects populates it (issue #1797). slicerId-addressed by update-slicer/ delete-slicer; list-slicers is how that id is discovered.

banded_ranges: Vec<BandedRange>

Banded ranges (alternating row/column colors) on this sheet. Empty unless the caller requested them with a wider fields mask — only SheetsApi::get_spreadsheet_with_banding populates it (issue #1832). bandedRangeId-addressed by update-banding/ delete-banding; list-bandings is how that id is discovered.

row_groups: Vec<DimensionGroup>

Outline groups over row spans on this sheet — the collapsible +/- grouping bar. Empty unless the caller requested them with a wider fields mask — only SheetsApi::get_spreadsheet_with_dimension_groups populates it (issue #1833). Addressed by (range, depth); list-dimension-groups is how both are discovered.

column_groups: Vec<DimensionGroup>

Outline groups over column spans on this sheet. Same population and addressing as Self::row_groups, the column axis.

data: Vec<GridData>

Grid data — cell-by-cell, in row-major chunks — read back only when the caller asked for it via a fields mask naming individual cell properties. Empty unless the caller requested a wider mask; only SheetsApi::get_spreadsheet_with_pivot_tables/ SheetsApi::get_cell_pivot populate it (issue #1798). Chunked rather than one flat grid because the API itself returns it that way — see GridData’s doc comment.

Implementations

impl Sheet

pub fn title(&self) -> &str

This sheet’s title, or "" if absent.

pub fn sheet_id(&self) -> Option<i64>

This sheet’s stable numeric id, or None if the properties (or the id within them) are absent from the response.

pub fn hidden(&self) -> bool

Whether the sheet is hidden in the UI.

Hidden sheets are deliberately included in a full read: omitting them would silently drop data the caller asked for, and “fail visible” is the safer default for a data-extraction tool.

Trait Implementations

impl Clone for Sheet

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 Sheet

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

Formats the value using the given formatter.

impl Default for Sheet

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Sheet

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Sheet

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Sheet

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 Sheet