Struct couch_rs::document::Document

pub struct Document {
    pub _id: DocumentId,
    pub _rev: String,
    // some fields omitted
}

Document abstracts the handling of JSON values and provides direct access and casting to the fields of your documents You can get access to the fields via the implementation of the Index and IndexMut traits

Fields

_id: DocumentId

Document ID, provided by CouchDB

_rev: String

Document Revision, provided by CouchDB, helps negotiating conflicts

Implementations

impl Document

pub fn new(doc: Value) -> Document

pub fn get_keys(&self) -> Vec<String>

Returns all document's keys

pub fn get_data(&self) -> Value

Returns raw JSON data from document

pub fn merge(&mut self, doc: Value) -> &Self

Merges this document with a raw JSON value, useful to update data with a payload

pub async fn populate<'_, '_, '_>(
    &'_ mut self,
    field: &'_ str,
    db: Database
) -> &'_ Self

Recursively populates field (must be an array of IDs from another database) with provided database documents

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy 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<I> Index<I> for Document where
    I: Index, 

type Output = Value

The returned type after indexing.

fn index(&self, index: I) -> &Value

Performs the indexing (container[index]) operation.

impl<I> IndexMut<I> for Document where
    I: Index, 

fn index_mut(&mut self, index: I) -> &mut Value

Performs the mutable indexing (container[index]) operation.

impl PartialEq<Document> for Document

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

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