Struct couch_rs::document::DocumentCollection

pub struct DocumentCollection<T: TypedCouchDocument> {
    pub offset: Option<u32>,
    pub rows: Vec<T>,
    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<T>

total_rows: u32

bookmark: Option<String>

Implementations

impl<T: TypedCouchDocument> DocumentCollection<T>

pub fn new(doc: AllDocsResponse<T>) -> DocumentCollection<T>

Create a new document collection from an AllDocsResponse

Panics

Panics if the total_rows field is greater than u32::MAX

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

Create a new document collection from a Vec of documents

Panics

Panics if the total_rows field is greater than u32::MAX

pub fn new_from_values( docs: Vec<Value>, bookmark: Option<String> ) -> DocumentCollection<T>

Create a new document collection from a Vec of Value documents

Panics

Panics if the total_rows field is greater than u32::MAX

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

Returns raw JSON data from documents

Trait Implementations

impl<T: Clone + TypedCouchDocument> Clone for DocumentCollection<T>

fn clone(&self) -> DocumentCollection<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + TypedCouchDocument> Debug for DocumentCollection<T>

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

Formats the value using the given formatter.

impl<T: TypedCouchDocument> Default for DocumentCollection<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: TypedCouchDocument> Index<usize> for DocumentCollection<T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T: TypedCouchDocument> IndexMut<usize> for DocumentCollection<T>

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

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

impl<T: PartialEq + TypedCouchDocument> PartialEq for DocumentCollection<T>

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

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

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

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

impl<T: Eq + TypedCouchDocument> Eq for DocumentCollection<T>

impl<T: TypedCouchDocument> StructuralPartialEq for DocumentCollection<T>