Struct couch_rs::types::query::QueryParams

pub struct QueryParams {
    pub conflicts: Option<bool>,
    pub descending: Option<bool>,
    pub end_key: Option<String>,
    pub end_key_doc_id: Option<String>,
    pub group: Option<bool>,
    pub group_level: Option<u32>,
    pub include_docs: Option<bool>,
    pub attachments: Option<bool>,
    pub att_encoding_info: Option<bool>,
    pub inclusive_end: Option<bool>,
    pub key: Option<String>,
    pub keys: Vec<String>,
    pub limit: Option<u64>,
    pub reduce: Option<bool>,
    pub skip: Option<u64>,
    pub sorted: Option<bool>,
    pub stable: Option<bool>,
    pub stale: Option<String>,
    pub start_key: Option<String>,
    pub start_key_doc_id: Option<String>,
    pub update: Option<String>,
    pub update_seq: Option<bool>,
}

Query parameters. You can use the builder paradigm to construct these parameters easily:

use couch_rs::types::query::QueryParams;
let _qp = QueryParams::default().group(true).conflicts(false).start_key("1");

Fields

conflicts: Option<bool>

descending: Option<bool>

end_key: Option<String>

end_key_doc_id: Option<String>

group: Option<bool>

group_level: Option<u32>

include_docs: Option<bool>

attachments: Option<bool>

att_encoding_info: Option<bool>

inclusive_end: Option<bool>

key: Option<String>

keys: Vec<String>

limit: Option<u64>

reduce: Option<bool>

skip: Option<u64>

sorted: Option<bool>

stable: Option<bool>

stale: Option<String>

start_key: Option<String>

start_key_doc_id: Option<String>

update: Option<String>

update_seq: Option<bool>

Implementations

impl QueryParams

pub fn from_keys(keys: Vec<String>) -> Self

pub fn conflicts(self, conflicts: bool) -> Self

pub fn descending(self, descending: bool) -> Self

pub fn end_key(self, end_key: &str) -> Self

pub fn group(self, group: bool) -> Self

pub fn group_level(self, group_level: u32) -> Self

pub fn include_docs(self, include_docs: bool) -> Self

pub fn attachments(self, attachments: bool) -> Self

pub fn att_encoding_info(self, att_encoding_info: bool) -> Self

pub fn inclusive_end(self, inclusive_end: bool) -> Self

pub fn key(self, key: &str) -> Self

pub fn keys(self, keys: Vec<String>) -> Self

pub fn limit(self, limit: u64) -> Self

pub fn reduce(self, reduce: bool) -> Self

pub fn skip(self, skip: u64) -> Self

pub fn sorted(self, sorted: bool) -> Self

pub fn stable(self, stable: bool) -> Self

pub fn start_key(self, start_key: &str) -> Self

pub fn start_key_doc_id(self, start_key_doc_id: &str) -> Self

pub fn update(self, update: &str) -> Self

pub fn update_seq(self, update_seq: bool) -> Self

Trait Implementations

impl Clone for QueryParams

fn clone(&self) -> QueryParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryParams

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

Formats the value using the given formatter.

impl Default for QueryParams

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for QueryParams

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<QueryParams> for QueryParams

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

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

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

This method tests for !=.

impl Serialize for QueryParams

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 QueryParams