Struct FieldQuery

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

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§

Source§

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

Source

pub async fn new() -> Self

§Initialize a new empty field
§Usage
use crate::FieldQuery;

FieldQuery::new()
Source

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");
Source

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");
Source

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");
Source

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

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

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

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

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

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§

Source§

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

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.