Struct Query 

pub struct Query { /* private fields */ }

A query type for models.

Implementations

impl Query

pub fn new(filters: impl Into<JsonValue>) -> Self

Creates a new instance.

pub fn from_entry(key: impl Into<String>, value: impl Into<JsonValue>) -> Self

Creates a new instance with the entry.

pub fn read_map(&mut self, data: &Map) -> Validation

Updates the query using the json object and returns the validation result.

pub fn set_fields(&mut self, fields: Vec<String>)

Sets the fields.

pub fn allow_fields(&mut self, fields: &[&str])

Retains the projection fields in the allow list. If the projection fields are empty, it will be set to the list.

pub fn deny_fields(&mut self, fields: &[&str])

Removes the projection fields in the deny list.

pub fn add_field_alias( &mut self, expr: impl Into<String>, alias: impl Into<String>, )

Adds a projection field with the alias.

pub fn add_filter( &mut self, key: impl Into<String>, value: impl Into<JsonValue>, )

Adds a key-value pair to the query filters.

pub fn append_filters(&mut self, filters: &mut Map)

Moves all elements from the filters into self.

pub fn remove_filter(&mut self, key: &str) -> Option<JsonValue>

Removes a query filter with the key.

pub fn set_extra_flag( &mut self, key: impl Into<String>, value: impl Into<JsonValue>, )

Sets the extra flag.

pub fn append_extra_flags(&mut self, flags: &mut Map)

Appends the extra flags.

pub fn set_order(&mut self, sort_order: Vec<QueryOrder>)

Sets the sort order.

pub fn order_by(&mut self, field: impl Into<SharedString>, descending: bool)

Adds a query order.

pub fn order_by_with_nulls( &mut self, field: impl Into<SharedString>, descending: bool, nulls_first: bool, )

Adds a query order with an extra flag to indicate whether the nulls appear first or last.

pub fn order_asc(&mut self, field: impl Into<SharedString>)

Adds a query order with an ascending order.

pub fn order_desc(&mut self, field: impl Into<SharedString>)

Adds a query order with an descending order.

pub fn set_offset(&mut self, offset: usize)

Sets the query offset.

pub fn set_limit(&mut self, limit: usize)

Sets the query limit.

pub fn disable_limit(&mut self)

Disables the query limit.

pub fn fields(&self) -> &[String]

Returns a reference to the projection fields.

pub fn filters(&self) -> &Map

Returns a reference to the filters.

pub fn sort_order(&self) -> &[QueryOrder]

Returns a reference to the sort order.

pub fn offset(&self) -> usize

Returns the query offset.

pub fn limit(&self) -> usize

Returns the query limit.

pub fn extra(&self) -> &Map

Returns a reference to the extra flags.

pub fn enabled(&self, flag: &str) -> bool

Returns true if the flag has been enabled.

pub fn populate_enabled(&self) -> bool

Returns true if the populate flag has been enabled.

pub fn translate_enabled(&self) -> bool

Returns true if the translate flag has been enabled.

pub fn show_deleted(&self) -> bool

Returns true if the show_deleted flag has been enabled.

pub fn validate_only(&self) -> bool

Returns true if the validate_only flag has been enabled.

pub fn no_check(&self) -> bool

Returns true if the no_check flag has been enabled.

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Query

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

Formats the value using the given formatter.

impl Default for Query

fn default() -> Self

Returns the “default value” for a type.