Struct FieldQuery

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

Handles field queries

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()

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

Add a database name

Usage

use crate::FieldQuery;

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

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

Add a document name

Usage

use crate::FieldQuery;

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

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

Add a field name

Usage

use crate::FieldQuery;

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

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();
foo
  .db("db_name")
  .document("document_name")
  .field("field_name")
  .payload("my_data_converted_into_bytes".as_bytes());

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();
foo
  .db("db_name")
  .document("document_name")
  .field("field_name")
  .payload("my_data_converted_into_bytes".as_bytes())
  .set()

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();
foo
  .db("db_name")
  .document("document_name")
  .field("field_name")
  .get();

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

List all the keys in a document

Usage

use crate::FieldQuery;

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

pub 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();
foo
  .db("db_name")
  .document("document_name")
  .field("field_name")
  .remove();

pub 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();
foo
  .db("db_name")
  .document("document_name")
  .field("field_name")
  .payload("my_data_converted_into_bytes".as_bytes())
  .modify()

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.