Struct turingdb_helpers::FieldQuery

pub struct FieldQuery<T> { /* fields omitted */ }

Handles all queries releated to fields

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

Implementations

impl<T> FieldQuery<T> where
    T: Serialize, 

pub async fn new() -> Self

Initialize a new empty field

Usage

use crate::FieldQuery;

FieldQuery::new().await

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

Add a database name

Usage

use crate::FieldQuery;

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

pub async fn document<'_, '_, '_>(&'_ mut self, name: &'_ str) -> &'_ Self

Add a document name

Usage

use crate::FieldQuery;

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

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

Add a field name

Usage

use crate::FieldQuery;

let mut foo = FieldQuery::new().await;
foo
  .db("db_name").await
  .document("document_name").await
  .field("field_name").await;

pub async fn payload<'_, '_>(&'_ mut self, value: T) -> &'_ Self

Add a payload of bytes

This takes a generic value and convertes it into bytes using bincode

Usage

use crate::FieldQuery;

let mut foo = FieldQuery::new().await;
foo
  .db("db_name").await
  .document("document_name").await
  .field("field_name").await
  .payload("my_data_converted_into_bytes".as_bytes()).await;

pub async fn set<'_>(&'_ self) -> Result<Vec<u8>>

Inserts a key/value to a document in a database

Usage

use crate::FieldQuery;

let mut foo = FieldQuery::new().await;
foo
  .db("db_name").await
  .document("document_name").await
  .field("field_name").await
  .payload("my_data_converted_into_bytes".as_bytes()).await
  .set().await

pub async fn get<'_>(&'_ self) -> Result<Vec<u8>>

Gets a value to a document in a database by key

Usage

use crate::FieldQuery;

let mut foo = FieldQuery::new().await;
foo
  .db("db_name").await
  .document("document_name").await
  .field("field_name").await
  .get().await;

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

List all the keys in a document

Usage

use crate::FieldQuery;

let mut foo = FieldQuery::new().await;
foo
  .db("db_name").await
  .document("document_name").await
  .list().await;

pub async fn remove<'_>(&'_ self) -> Result<Vec<u8>>

Removes a value from a document in a database by key

Usage

use crate::FieldQuery;

let mut foo = FieldQuery::new().await;
foo
  .db("db_name").await
  .document("document_name").await
  .field("field_name").await
  .remove().await;

pub async fn modify<'_>(&'_ self) -> Result<Vec<u8>>

Modifies a value in a document in a database by its key

Usage

use crate::FieldQuery;

let mut foo = FieldQuery::new().await;
foo
  .db("db_name").await
  .document("document_name").await
  .field("field_name").await
  .payload("my_data_converted_into_bytes".as_bytes()).await
  .modify().await

Trait Implementations

impl<T: Clone> Clone for FieldQuery<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for FieldQuery<T>

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

Formats the value using the given formatter.

impl<T> Serialize for FieldQuery<T> where
    T: Serialize, 

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

Serialize this value into the given Serde serializer.