Struct Document 

pub struct Document {
    pub id: DocumentId,
    pub original_file_name: String,
    pub page_count: u32,
    /* private fields */
}

Represents a document

Fields

id: DocumentId

Unique identifier of the document.

original_file_name: String

Original file name of the document.

page_count: u32

Number of pages in the document.

Implementations

impl Document

pub fn add_tag(&mut self, tag_id: TagId)

Add a tag to the document.

pub fn tags(&self) -> &[TagId]

Get all tag-ids for the document.

pub fn set_title(&mut self, title: &str)

Set the title of the document.

pub fn title(&self) -> &str

Get the title of the document.

pub fn set_content(&mut self, content: &str)

Set the content of the document.

pub fn content(&self) -> Content<'_>

Get the content of the document.

pub fn custom_fields(&self) -> &[DocumentCustomField]

Get all custom fields for the document.

pub fn is_dirty(&self) -> bool

Returns true if the document has unsaved changes.

pub fn set_custom_field(&mut self, field: CustomFieldId, value: &str)

Set a custom field for the document.

pub async fn update(&mut self) -> Result<(), Error>

Update the document on the server.

pub async fn get_full_content(&mut self) -> Result<(), Error>

Get the full content of the document, replacing any truncated content.

pub async fn download_to_file(&self, path: &Path) -> Result<(), Error>

Download the document to a file.

pub async fn download_to_buffer(&self) -> Result<Vec<u8>, Error>

Download the document to a buffer.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

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<'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 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.