Struct ReadOutcome 

pub struct ReadOutcome {
    pub document_id: String,
    pub title: Option<String>,
    pub revision_id: Option<String>,
    pub tabs: Vec<TabContent>,
}

The full result of one read.

Fields

document_id: String

The document read.

title: Option<String>

Its title, when the response carried one.

revision_id: Option<String>

The document’s revision at the moment of the read.

This is the writeControl.requiredRevisionId token a later documents.batchUpdate presents so a write against a document that moved underneath it is refused rather than silently misapplied. Absent when the caller lacks edit access, which Google signals by omitting it.

tabs: Vec<TabContent>

The tabs read, in document order.

Implementations

impl ReadOutcome

pub fn flat_elements(&self) -> Vec<FlatElement<'_>>

Every element across every tab, carrying the identity of the document, tab and (for a header/footer/footnote element) segment that hold it.

This is the -o jsonl projection; see FlatElement.

Trait Implementations

impl Clone for ReadOutcome

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 ReadOutcome

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

Formats the value using the given formatter.

impl Eq for ReadOutcome

impl JsonlSerialize for ReadOutcome

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

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

impl PartialEq for ReadOutcome

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ReadOutcome

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 ReadOutcome