Skip to main content

FilterExpr

Enum FilterExpr

pub enum FilterExpr {
Show 32 variants    True,
    False,
    And(Vec<FilterExpr>),
    Or(Vec<FilterExpr>),
    Not(Box<FilterExpr>),
    Eq {
        field: String,
        value: Value,
    },
    EqCi {
        field: String,
        value: Value,
    },
    Ne {
        field: String,
        value: Value,
    },
    Lt {
        field: String,
        value: Value,
    },
    Lte {
        field: String,
        value: Value,
    },
    Gt {
        field: String,
        value: Value,
    },
    Gte {
        field: String,
        value: Value,
    },
    EqField {
        left_field: String,
        right_field: String,
    },
    NeField {
        left_field: String,
        right_field: String,
    },
    LtField {
        left_field: String,
        right_field: String,
    },
    LteField {
        left_field: String,
        right_field: String,
    },
    GtField {
        left_field: String,
        right_field: String,
    },
    GteField {
        left_field: String,
        right_field: String,
    },
    In {
        field: String,
        values: Vec<Value>,
    },
    NotIn {
        field: String,
        values: Vec<Value>,
    },
    Contains {
        field: String,
        value: Value,
    },
    TextContains {
        field: String,
        value: Value,
    },
    TextContainsCi {
        field: String,
        value: Value,
    },
    StartsWith {
        field: String,
        value: Value,
    },
    StartsWithCi {
        field: String,
        value: Value,
    },
    EndsWith {
        field: String,
        value: Value,
    },
    EndsWithCi {
        field: String,
        value: Value,
    },
    IsNull {
        field: String,
    },
    IsNotNull {
        field: String,
    },
    IsMissing {
        field: String,
    },
    IsEmpty {
        field: String,
    },
    IsNotEmpty {
        field: String,
    },
}

Expand description

FilterExpr

Serialized, planner-agnostic filter language. This is the shared typed filter input model for fluent callers and lowers directly onto planner-owned boolean expressions at the intent boundary.

Variants§

True

False

And(Vec<FilterExpr>)

Or(Vec<FilterExpr>)

Not(Box<FilterExpr>)

Eq

Fields

§field: String

§value: Value

EqCi

Fields

§field: String

§value: Value

Ne

Fields

§field: String

§value: Value

Lt

Fields

§field: String

§value: Value

Lte

Fields

§field: String

§value: Value

Gt

Fields

§field: String

§value: Value

Gte

Fields

§field: String

§value: Value

EqField

Fields

§left_field: String

§right_field: String

NeField

Fields

§left_field: String

§right_field: String

LtField

Fields

§left_field: String

§right_field: String

LteField

Fields

§left_field: String

§right_field: String

GtField

Fields

§left_field: String

§right_field: String

GteField

Fields

§left_field: String

§right_field: String

In

Fields

§field: String

§values: Vec<Value>

NotIn

Fields

§field: String

§values: Vec<Value>

Contains

Fields

§field: String

§value: Value

TextContains

Fields

§field: String

§value: Value

TextContainsCi

Fields

§field: String

§value: Value

StartsWith

Fields

§field: String

§value: Value

StartsWithCi

Fields

§field: String

§value: Value

EndsWith

Fields

§field: String

§value: Value

EndsWithCi

Fields

§field: String

§value: Value

IsNull

Fields

§field: String

IsNotNull

Fields

§field: String

IsMissing

Fields

§field: String

IsEmpty

Fields

§field: String

IsNotEmpty

Fields

§field: String

Implementations§

impl FilterExpr

pub const fn and(exprs: Vec<FilterExpr>) -> FilterExpr

Build an And expression from a list of child expressions.

pub const fn or(exprs: Vec<FilterExpr>) -> FilterExpr

Build an Or expression from a list of child expressions.

pub fn not(expr: FilterExpr) -> FilterExpr

Negate one child expression.

pub fn eq(field: impl Into<String>, value: impl FieldValue) -> FilterExpr

Compare field == value.

pub fn ne(field: impl Into<String>, value: impl FieldValue) -> FilterExpr

Compare field != value.

pub fn lt(field: impl Into<String>, value: impl FieldValue) -> FilterExpr

Compare field < value.

pub fn lte(field: impl Into<String>, value: impl FieldValue) -> FilterExpr

Compare field <= value.

pub fn gt(field: impl Into<String>, value: impl FieldValue) -> FilterExpr

Compare field > value.

pub fn gte(field: impl Into<String>, value: impl FieldValue) -> FilterExpr

Compare field >= value.

pub fn eq_ci(field: impl Into<String>, value: impl FieldValue) -> FilterExpr

Compare field == value with casefolded text equality.

pub fn eq_field( left_field: impl Into<String>, right_field: impl Into<String>, ) -> FilterExpr

Compare left_field == right_field.

pub fn ne_field( left_field: impl Into<String>, right_field: impl Into<String>, ) -> FilterExpr

Compare left_field != right_field.

pub fn lt_field( left_field: impl Into<String>, right_field: impl Into<String>, ) -> FilterExpr

Compare left_field < right_field.

pub fn lte_field( left_field: impl Into<String>, right_field: impl Into<String>, ) -> FilterExpr

Compare left_field <= right_field.

pub fn gt_field( left_field: impl Into<String>, right_field: impl Into<String>, ) -> FilterExpr

Compare left_field > right_field.

pub fn gte_field( left_field: impl Into<String>, right_field: impl Into<String>, ) -> FilterExpr

Compare left_field >= right_field.

pub fn in_list( field: impl Into<String>, values: impl IntoIterator<Item = impl FieldValue>, ) -> FilterExpr

Compare field IN values.

pub fn not_in( field: impl Into<String>, values: impl IntoIterator<Item = impl FieldValue>, ) -> FilterExpr

Compare field NOT IN values.

pub fn contains(field: impl Into<String>, value: impl FieldValue) -> FilterExpr

Compare collection field CONTAINS value.

pub fn text_contains( field: impl Into<String>, value: impl FieldValue, ) -> FilterExpr

Compare case-sensitive substring containment.

pub fn text_contains_ci( field: impl Into<String>, value: impl FieldValue, ) -> FilterExpr

Compare case-insensitive substring containment.

pub fn starts_with( field: impl Into<String>, value: impl FieldValue, ) -> FilterExpr

Compare case-sensitive prefix match.

pub fn starts_with_ci( field: impl Into<String>, value: impl FieldValue, ) -> FilterExpr

Compare case-insensitive prefix match.

pub fn ends_with(field: impl Into<String>, value: impl FieldValue) -> FilterExpr

Compare case-sensitive suffix match.

pub fn ends_with_ci( field: impl Into<String>, value: impl FieldValue, ) -> FilterExpr

Compare case-insensitive suffix match.

pub fn is_null(field: impl Into<String>) -> FilterExpr

Match rows where field is present and null.

pub fn is_not_null(field: impl Into<String>) -> FilterExpr

Match rows where field is present and non-null.

pub fn is_missing(field: impl Into<String>) -> FilterExpr

Match rows where field is absent.

pub fn is_empty(field: impl Into<String>) -> FilterExpr

Match rows where field is present and empty.

pub fn is_not_empty(field: impl Into<String>) -> FilterExpr

Match rows where field is present and non-empty.

Trait Implementations§

impl CandidType for FilterExpr

fn _ty() -> Type

fn _ty_doc() -> TypeDoc

fn id() -> TypeId

fn idl_serialize<S>( &self, serializer: S, ) -> Result<(), <S as Serializer>::Error>
where __S: Serializer,

fn ty() -> Type

impl Clone for FilterExpr

fn clone(&self) -> FilterExpr

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for FilterExpr

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for FilterExpr

fn deserialize<D>( deserializer: D, ) -> Result<FilterExpr, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for FilterExpr

fn eq(&self, other: &FilterExpr) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FilterExpr

impl StructuralPartialEq for FilterExpr

Auto Trait Implementations§

impl Freeze for FilterExpr

impl RefUnwindSafe for FilterExpr

impl Send for FilterExpr

impl Sync for FilterExpr

impl Unpin for FilterExpr

impl UnsafeUnpin for FilterExpr

impl UnwindSafe for FilterExpr

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,