Skip to main content

QueryFilter

Struct QueryFilter 

Source
pub struct QueryFilter {
    pub conditions: Vec<FilterCondition>,
    pub sorts: Vec<SortSpec>,
    pub search: Option<String>,
    pub search_fields: Vec<String>,
    pub limit: Option<u32>,
    pub offset: Option<u32>,
    pub page: Option<u32>,
    pub cursor_after: Option<String>,
    pub cursor_before: Option<String>,
    pub estimate_total: bool,
    /* private fields */
}
Expand description

Complete query filter specification

Fields§

§conditions: Vec<FilterCondition>§sorts: Vec<SortSpec>§search: Option<String>§search_fields: Vec<String>§limit: Option<u32>§offset: Option<u32>§page: Option<u32>§cursor_after: Option<String>

Keyset paging: the opaque cursor from a previous page’s next_cursor (forward walk). Takes precedence over page/offset.

§cursor_before: Option<String>

Keyset paging: the opaque cursor from a previous page’s prev_cursor (backward walk — the query inverts and the page is reversed so it still reads forward).

§estimate_total: bool

Replace the exact COUNT (a full scan of the filtered set) with the planner’s row estimate. Screens that need the exact figure use the separate count endpoint.

Implementations§

Source§

impl QueryFilter

Source

pub fn new() -> Self

Create a new empty query filter

Source

pub fn add_condition(&mut self, condition: FilterCondition)

Add a filter condition

Source

pub fn add_sort(&mut self, sort: SortSpec)

Add a sort specification

Set search term

Source

pub fn with_pagination(&mut self, page: u32, limit: u32)

Set pagination

Source

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

The base conditions this filter carries, in the order they were added.

Source

pub fn build_where_clause(&self) -> (String, Vec<String>)

Build the complete WHERE clause.

The clause is a conjunction of independent groups: each base condition, the search, and the caller’s own conditions. Every group is parenthesised whenever there is more than one, so an OR inside the caller’s conditions (or inside a base condition) can only widen its own group and never escape the soft-delete guard, the company fence or the search. Parameters are numbered in the order the groups are emitted.

Source

pub fn build_order_by_clause(&self) -> String

Build ORDER BY clause

Source

pub fn has_uncast_value_conditions(&self) -> bool

True when some condition compares a value that carries no cast — see FilterCondition::needs_value_cast. The repository answers it by reading the table’s column types from the catalog before it builds the query.

Source

pub fn needs_catalog_types(&self) -> bool

Whether the table’s catalog types must be read before this filter runs: a comparison has no cast yet, or a cast names a user-defined type without its schema.

Source

pub fn has_conditions(&self) -> bool

Check if has any conditions

Trait Implementations§

Source§

impl Clone for QueryFilter

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for QueryFilter

Source§

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

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

impl Default for QueryFilter

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more