Struct Document 

pub struct Document { /* private fields */ }

A document is a piece of text with a title.

Implementations

impl Document

pub async fn new<T: IntoDocument>(source: T) -> Result<Self, T::Error>

Create a new document from a source.

pub fn language(&self) -> Option<Lang>

Get the language of the document.

pub fn from_parts(title: impl Into<String>, body: impl Into<String>) -> Self

Create a new document from the raw parts.

pub fn set_summary(&mut self, summary: impl Into<String>)

Set the summary of the document.

pub fn set_created_at(&mut self, created_at: DateTime<Utc>)

Set the created at time of the document.

pub fn set_updated_at(&mut self, updated_at: DateTime<Utc>)

Set the updated at time of the document.

pub fn title(&self) -> &str

Get the title of the document.

pub fn body(&self) -> &str

Get the body of the document.

Trait Implementations

impl AsRef<Document> for Document

fn as_ref(&self) -> &Document

Converts this type into a shared reference of the (usually inferred) input type.

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 Display for Document

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

Formats the value using the given formatter.

impl From<&str> for Document

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for Document

fn from(value: String) -> Self

Converts to this type from the input type.

impl IntoDocument for Document

type Error = Infallible

The error type that can occur when converting the type into a Document.

async fn into_document(self) -> Result<Document, Self::Error>

Convert the type into a document.

impl PartialEq for Document

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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