Struct turingdb_helpers::DocumentQuery

pub struct DocumentQuery { /* fields omitted */ }

Handles all queries releated to fields

#[derive(Debug, Serialize, Clone)]
pub struct DocumentQuery {
    db: String,
    document: Option<String>,
}

Implementations

impl DocumentQuery

pub fn new() -> Self

Initialize a new empty document

Usage

use crate::DocumentQuery;

Document::new()

pub fn db(&mut self, name: &str) -> &Self

Add a database name

Usage

use crate::DocumentQuery;

let mut foo = DocumentQuery::new();
foo.db("db_name");

pub fn document(&mut self, name: &str) -> &Self

Add a document name

Usage

use crate::DocumentQuery;

let mut foo = DocumentQuery::new();
foo
  .db("db_name")
  .document("document_name");

pub fn create(&self) -> Result<Vec<u8>>

Creates a new document in a database

Usage

use crate::DocumentQuery;

let mut foo = DocumentQuery::new();
foo
  .db("db_name")
  .document("document_name")
  .create()

pub fn list(&self) -> Result<Vec<u8>>

List all documents in a database

Usage

use crate::DocumentQuery;

let mut foo = DocumentQuery::new();
foo
  .db("db_name")
  .list()

pub fn drop(&self) -> Result<Vec<u8>>

Drops document in a database

Usage

use crate::DocumentQuery;

let mut foo = DocumentQuery::new();
foo
  .db("db_name")
  .document("document_name")
  .drop()

Trait Implementations

impl Clone for DocumentQuery

fn clone(&self) -> DocumentQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentQuery

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

Formats the value using the given formatter.

impl Default for DocumentQuery

fn default() -> DocumentQuery

Returns the "default value" for a type.

impl Serialize for DocumentQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.