Struct toql::query::Field

pub struct Field { /* fields omitted */ }

A Toql field can select, filter and order a database column or expression A field can be created from a field name and filtered, sorted with its methods. However the Toql derive creates fields structs for a derived struct, so instead of

  
 let f = Field::from("id");

its easier and recommended to write

 let f = User::fields().id();

Methods

impl Field

pub fn from<T>(name: T) -> Field where
    T: Into<String>, 

Create a field for the given name.

pub fn hide(self) -> Field

Hide field. Useful if a field should not be selected, but be used for filtering.

pub fn aggregate(self) -> Field

Aggregate a field to make the filter be in SQL HAVING clause instead of WHERE clause

pub fn asc(self, order: u8) -> Field

Use this field to order records in ascending way. Give ordering priority when records are ordered by multiple fields.

pub fn desc(self, order: u8) -> Field

Use this field to order records in descending way. Give ordering priority when records are ordered by multiple fields.

pub fn eq<T, impl FilterArg>(self, criteria: impl FilterArg) -> Field where
    impl FilterArg: FilterArg<T>, 

Filter records with equal predicate.

pub fn eqn(self) -> Field

Filter records with equal null predicate.

pub fn ne<T, impl FilterArg>(self, criteria: impl FilterArg) -> Field where
    impl FilterArg: FilterArg<T>, 

Filter records with not equal predicate.

pub fn nen(self) -> Field

Filter records with not equal null predicate.

pub fn gt<T, impl FilterArg>(self, criteria: impl FilterArg) -> Field where
    impl FilterArg: FilterArg<T>, 

Filter records with greater that_ predicate.

pub fn ge<T, impl FilterArg>(self, criteria: impl FilterArg) -> Field where
    impl FilterArg: FilterArg<T>, 

Filter records with greater or equal_ predicate.

pub fn lt<T, impl FilterArg>(self, criteria: impl FilterArg) -> Field where
    impl FilterArg: FilterArg<T>, 

Filter records with lesser than_ predicate.

pub fn le<T, impl FilterArg>(self, criteria: impl FilterArg) -> Field where
    impl FilterArg: FilterArg<T>, 

Filter records with lesser or equal_ predicate.

pub fn bw<T, impl FilterArg, impl FilterArg>(
    self,
    lower: impl FilterArg,
    upper: impl FilterArg
) -> Field where
    impl FilterArg: FilterArg<T> + FilterArg<T>, 

Filter records with between predicate. This is inclusive, so x bw 3 6 is the same as x ge 3, x le 6

pub fn lk<T, impl FilterArg>(self, criteria: impl FilterArg) -> Field where
    impl FilterArg: FilterArg<T>, 

Filter records with like predicate.

pub fn re<T, impl FilterArg>(self, criteria: impl FilterArg) -> Field where
    impl FilterArg: FilterArg<T>, 

Filter records with regex predicate.

pub fn ins<T, impl FilterArg>(
    self,
    criteria: Vec<impl FilterArg>
) -> Field where
    impl FilterArg: FilterArg<T>, 

Filter records with inside predicate.

pub fn out<T, impl FilterArg>(
    self,
    criteria: Vec<impl FilterArg>
) -> Field where
    impl FilterArg: FilterArg<T>, 

Filter records with outside predicate.

pub fn fnc<U, T, impl FilterArg>(
    self,
    name: U,
    args: Vec<impl FilterArg>
) -> Field where
    U: Into<String>,
    impl FilterArg: FilterArg<T>, 

Filter records with custom function. To provide a custom function you must implement (FieldHandler)[../sql_mapper/trait.FieldHandler.html] See custom handler test for an example.

Trait Implementations

impl Into<QueryToken> for Field

fn into(self) -> QueryToken

Performs the conversion.

impl Debug for Field

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

Formats the value using the given formatter.

impl Clone for Field

fn clone(&self) -> Field

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Field> for Query

fn from(field: Field) -> Query

Performs the conversion.

impl<'_> From<&'_ str> for Field

fn from(s: &str) -> Field

Performs the conversion.

impl ToString for Field

fn to_string(&self) -> String

Converts the given value to a String.