Struct DocumentRead 

pub struct DocumentRead {
    pub format: Format,
    pub sha256: String,
    pub size_bytes: u64,
    pub text: String,
    pub markdown: Option<String>,
    pub truncated: bool,
    pub content: Content,
    pub omitted: Vec<String>,
}

Fields

format: Format

sha256: String

SHA-256 of the exact bytes read. Pass it back as expect_sha256 to make an edit refuse a file that changed in between.

size_bytes: u64

text: String

Plain-text rendering, capped at max_chars.

markdown: Option<String>

truncated: bool

A cap (max_chars, max_cells) cut the result short.

content: Content

omitted: Vec<String>

What the file holds that this read does not represent (comments, tracked changes, footnotes, images, charts, external links not followed…). Never empty by omission: if something is not in content, it is named here.

Trait Implementations

impl Clone for DocumentRead

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 DocumentRead

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentRead

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocumentRead

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.