Trait Filterable 

pub trait Filterable: Sized {
    // Required methods
    fn filters_mut(&mut self) -> &mut Vec<FilterCondition>;
    fn params_mut(&mut self) -> &mut ParamStore;

    // Provided methods
    fn eq(self, column: &str, value: impl IntoSqlParam) -> Self { ... }
    fn neq(self, column: &str, value: impl IntoSqlParam) -> Self { ... }
    fn gt(self, column: &str, value: impl IntoSqlParam) -> Self { ... }
    fn gte(self, column: &str, value: impl IntoSqlParam) -> Self { ... }
    fn lt(self, column: &str, value: impl IntoSqlParam) -> Self { ... }
    fn lte(self, column: &str, value: impl IntoSqlParam) -> Self { ... }
    fn like(self, column: &str, pattern: impl IntoSqlParam) -> Self { ... }
    fn ilike(self, column: &str, pattern: impl IntoSqlParam) -> Self { ... }
    fn is(self, column: &str, value: IsValue) -> Self { ... }
    fn in_<V: IntoSqlParam>(self, column: &str, values: Vec<V>) -> Self { ... }
    fn contains(self, column: &str, value: impl IntoSqlParam) -> Self { ... }
    fn contained_by(self, column: &str, value: impl IntoSqlParam) -> Self { ... }
    fn overlaps(self, column: &str, value: impl IntoSqlParam) -> Self { ... }
    fn range_gt(self, column: &str, value: impl IntoSqlParam) -> Self { ... }
    fn range_gte(self, column: &str, value: impl IntoSqlParam) -> Self { ... }
    fn range_lt(self, column: &str, value: impl IntoSqlParam) -> Self { ... }
    fn range_lte(self, column: &str, value: impl IntoSqlParam) -> Self { ... }
    fn range_adjacent(self, column: &str, value: impl IntoSqlParam) -> Self { ... }
    fn text_search(
        self,
        column: &str,
        query: impl IntoSqlParam,
        search_type: TextSearchType,
        config: Option<&str>,
    ) -> Self { ... }
    fn not(
        self,
        f: impl FnOnce(FilterCollector<'_>) -> FilterCollector<'_>,
    ) -> Self { ... }
    fn or_filter(
        self,
        f: impl FnOnce(FilterCollector<'_>) -> FilterCollector<'_>,
    ) -> Self { ... }
    fn match_filter(self, pairs: Vec<(&str, impl IntoSqlParam + Clone)>) -> Self { ... }
    fn filter(self, raw_sql: &str) -> Self { ... }
}

Trait providing all filter methods for query builders.

Implementors must provide access to the internal filter list and param store.

Required Methods

fn filters_mut(&mut self) -> &mut Vec<FilterCondition>

Get a mutable reference to the filter list.

fn params_mut(&mut self) -> &mut ParamStore

Get a mutable reference to the parameter store.

Provided Methods

fn eq(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column = value

fn neq(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column != value

fn gt(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column > value

fn gte(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column >= value

fn lt(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column < value

fn lte(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column <= value

fn like(self, column: &str, pattern: impl IntoSqlParam) -> Self

Filter: column LIKE pattern

fn ilike(self, column: &str, pattern: impl IntoSqlParam) -> Self

Filter: column ILIKE pattern (case-insensitive)

fn is(self, column: &str, value: IsValue) -> Self

Filter: column IS NULL / IS NOT NULL / IS TRUE / IS FALSE

fn in_<V: IntoSqlParam>(self, column: &str, values: Vec<V>) -> Self

Filter: column IN (val1, val2, …)

fn contains(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column @> value (contains)

fn contained_by(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column <@ value (contained by)

fn overlaps(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column && value (overlaps)

fn range_gt(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column >> value (range strictly greater than)

fn range_gte(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column &> value (range greater than or equal)

fn range_lt(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column << value (range strictly less than)

fn range_lte(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column &< value (range less than or equal)

fn range_adjacent(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column -|- value (range adjacent)

fn text_search( self, column: &str, query: impl IntoSqlParam, search_type: TextSearchType, config: Option<&str>, ) -> Self

Full-text search filter.

fn not(self, f: impl FnOnce(FilterCollector<'_>) -> FilterCollector<'_>) -> Self

Negate a filter condition using a closure.

fn or_filter( self, f: impl FnOnce(FilterCollector<'_>) -> FilterCollector<'_>, ) -> Self

OR filter: combine multiple conditions with OR.

fn match_filter(self, pairs: Vec<(&str, impl IntoSqlParam + Clone)>) -> Self

Match multiple column=value pairs (all must match).

fn filter(self, raw_sql: &str) -> Self

Raw filter escape hatch. The string should be a valid SQL boolean expression.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl Filterable for CsvSelectBuilder

impl Filterable for GeoJsonSelectBuilder

impl<T> Filterable for DeleteBuilder<T>

impl<T> Filterable for SelectBuilder<T>

impl<T> Filterable for UpdateBuilder<T>