Struct couch_rs::document::DocumentCollection

pub struct DocumentCollection {
    pub offset: Option<u32>,
    pub rows: Vec<DocumentCollectionItem>,
    pub total_rows: u32,
    pub bookmark: Option<String>,
}

Memory-optimized, iterable document collection, mostly returned in calls that involve multiple documents results Can target a specific index through implementation of Index and IndexMut

Fields

offset: Option<u32>

rows: Vec<DocumentCollectionItem>

total_rows: u32

bookmark: Option<String>

Implementations

impl DocumentCollection

pub fn new(doc: Value) -> DocumentCollection

pub fn new_from_documents(
    docs: Vec<Document>,
    bookmark: Option<String>
) -> DocumentCollection

pub fn get_data(&self) -> Vec<Value>

Returns raw JSON data from documents

Trait Implementations

impl Clone for DocumentCollection

fn clone(&self) -> DocumentCollection

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocumentCollection

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

Formats the value using the given formatter.

impl Default for DocumentCollection

fn default() -> DocumentCollection

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for DocumentCollection

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Index<usize> for DocumentCollection

type Output = DocumentCollectionItem

The returned type after indexing.

fn index(&self, index: usize) -> &DocumentCollectionItem

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for DocumentCollection

fn index_mut(&mut self, index: usize) -> &mut DocumentCollectionItem

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

impl PartialEq<DocumentCollection> for DocumentCollection

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

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

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

This method tests for !=.

impl Serialize for DocumentCollection

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 DocumentCollection