Struct Document 

pub struct Document {
    pub document_id: Option<String>,
    pub title: Option<String>,
    pub revision_id: Option<String>,
    pub body: Option<Body>,
    pub tabs: Vec<Tab>,
    pub named_ranges: HashMap<String, NamedRanges>,
    pub headers: HashMap<String, Header>,
    pub footers: HashMap<String, Footer>,
    pub footnotes: HashMap<String, Footnote>,
}

A document’s full structural model, from documents.get.

Deliberately not fields-masked when fetched — unlike spreadsheets.get, whose mask exists to keep every cell out of the response. A Docs mask has to spell nesting depth out literally, and a table may contain a table to arbitrary depth, so any fixed-depth mask silently drops document text below its deepest named level. See crate::drive::docs::api.

Fields

document_id: Option<String>

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

title: Option<String>

The document’s display title.

revision_id: Option<String>

The revision this response reflects.

Google populates this only for callers with edit access, so a read-only caller sees None. It is the writeControl requiredRevisionId token a later documents.batchUpdate presents to refuse a write against a document that moved underneath it.

body: Option<Body>

Legacy single-tab content, populated only when the request did not ask for tab content. Mutually exclusive with Self::tabs.

tabs: Vec<Tab>

The tab tree, populated only when includeTabsContent=true.

named_ranges: HashMap<String, NamedRanges>

Named ranges, keyed by name.

The stable way to address a region: an index shifts on every insertion, a named range’s name does not.

headers: HashMap<String, Header>

Page headers, keyed by segmentId. Legacy shape only — see Self::resolved_tabs.

footers: HashMap<String, Footer>

Page footers, keyed by segmentId. Legacy shape only.

footnotes: HashMap<String, Footnote>

Footnotes, keyed by segmentId. Legacy shape only.

Implementations

impl Document

pub fn title(&self) -> &str

The document title, or "" when absent.

pub fn resolved_tabs(&self) -> Vec<ResolvedTab<'_>>

Every tab’s content, depth-first through childTabs, falling back to the legacy top-level Self::body (and its sibling headers/footers/footnotes maps) as a single anonymous tab.

The fallback is what makes the tabs-xor-body split invisible to callers. A document fetched without includeTabsContent yields exactly one ResolvedTab whose tab_id and title are None — unless the document has neither body content nor any segment, in which case there is nothing to synthesise a tab for.

Trait Implementations

impl Clone for Document

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 Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Document

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Document

impl PartialEq for Document

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Document

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 Document