Struct Spreadsheet 

pub struct Spreadsheet {
    pub spreadsheet_id: Option<String>,
    pub properties: Option<SpreadsheetProperties>,
    pub sheets: Vec<Sheet>,
    pub named_ranges: Vec<NamedRange>,
}

A spreadsheet’s metadata, from spreadsheets.get.

Always request an explicit fields mask when fetching this: the unmasked response embeds every cell of every sheet, which on a large workbook is an out-of-memory failure rather than a slow request.

PartialEq-only, not Eq (issue #1793): a Sheet’s conditional_formats can embed a Color (f32-based), which has no meaningful Eq — see Color’s own doc comment.

Fields

spreadsheet_id: Option<String>

The spreadsheet’s id (echoes the one requested).

properties: Option<SpreadsheetProperties>

Workbook-level properties, notably its title.

sheets: Vec<Sheet>

The sheets (tabs) it contains, in workbook order.

named_ranges: Vec<NamedRange>

Named ranges defined anywhere in the workbook. A named range is workbook-scoped, not sheet-scoped (unlike ProtectedRange, which nests under the Sheet it protects), so this lives here rather than on Sheet. Empty unless the caller requested it with a wider fields mask — SPREADSHEET_FIELDS (the mask every other call uses) omits this; only SheetsApi::get_spreadsheet_with_named_ranges populates it.

Implementations

impl Spreadsheet

pub fn title(&self) -> &str

The workbook title, or "" when the fields mask omitted it.

pub fn sheet_titles(&self) -> Vec<String>

Every sheet title, in workbook order.

pub fn sheet_ids(&self) -> HashSet<i64>

Every sheet id, for sheets that carry one.

pub fn has_sheet_titled(&self, title: &str) -> bool

Whether any sheet in the workbook currently uses title as its display title — the collision check drive sheets rename-sheet/ duplicate-sheet (via structure.rs’s resolve_sheet) and drive lease restore’s best-effort rename-back (issue #1676) share, so a future change to what counts as “the same title” (e.g. case-insensitive) lands in one place rather than drifting between two hand-written copies.

A sheet with no properties never matches, not even "" — it has no title at all, so Sheet::title()’s "" fallback (meant for display) would otherwise falsely collide with an explicit empty-title request.

Trait Implementations

impl Clone for Spreadsheet

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 Spreadsheet

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

Formats the value using the given formatter.

impl Default for Spreadsheet

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Spreadsheet

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonlSerialize for Spreadsheet

fn write_jsonl(&self, out: &mut dyn Write) -> Result<()>

Writes the value as JSONL to out, newline-terminated.

impl PartialEq for Spreadsheet

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Spreadsheet

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 Spreadsheet