Skip to main content

JsonFilter

Enum JsonFilter 

Source
pub enum JsonFilter {
    Contains(Json),
    Extract(String, JsonCmp),
    HasKey(String),
}
Expand description

JSON-specific filter operations.

Provides three types of filtering on JSON columns:

  • Contains: Structural containment check (PostgreSQL @> style)
  • Extract: Extract value at path and apply comparison
  • HasKey: Check if a path exists in the JSON

Variants§

§

Contains(Json)

Structural containment: column’s JSON contains the pattern.

Implements PostgreSQL @> style containment:

  • Objects: all key-value pairs in pattern exist in target (recursive)
  • Arrays: all elements in pattern exist in target (order-independent)
  • Primitives: must be equal
§

Extract(String, JsonCmp)

Extract a value at the specified JSON path and apply a comparison operation.

Paths use dot notation with bracket array indices: user.items[0].name

§

HasKey(String)

Check whether a path/key exists in the JSON structure.

Paths use dot notation with bracket array indices: user.items[0].name

Implementations§

Source§

impl JsonFilter

Source

pub fn matches(&self, json: &Json) -> QueryResult<bool>

Matches the JSON value against this filter.

§Arguments
  • json - The JSON value to match against.
§Returns

Ok(true) if the JSON matches the filter, Ok(false) otherwise. Returns Err if the path is invalid.

§Errors

Returns [QueryError::InvalidQuery] if the path syntax is invalid.

Source

pub fn contains(pattern: Json) -> Self

Creates a Contains filter with the given JSON pattern.

Source

pub fn extract_eq(path: &str, value: Value) -> Self

Creates an Extract filter with an equality comparison.

Source

pub fn extract_ne(path: &str, value: Value) -> Self

Creates an Extract filter with a not-equal comparison.

Source

pub fn extract_gt(path: &str, value: Value) -> Self

Creates an Extract filter with a greater-than comparison.

Source

pub fn extract_lt(path: &str, value: Value) -> Self

Creates an Extract filter with a less-than comparison.

Source

pub fn extract_ge(path: &str, value: Value) -> Self

Creates an Extract filter with a greater-than-or-equal comparison.

Source

pub fn extract_le(path: &str, value: Value) -> Self

Creates an Extract filter with a less-than-or-equal comparison.

Source

pub fn extract_in(path: &str, values: Vec<Value>) -> Self

Creates an Extract filter with an In comparison.

Source

pub fn extract_is_null(path: &str) -> Self

Creates an Extract filter checking for null.

Source

pub fn extract_not_null(path: &str) -> Self

Creates an Extract filter checking for not null.

Source

pub fn has_key(path: &str) -> Self

Creates a HasKey filter.

Trait Implementations§

Source§

impl CandidType for JsonFilter

Source§

fn _ty() -> Type

Source§

fn id() -> TypeId

Source§

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

Source§

fn ty() -> Type

Source§

impl Clone for JsonFilter

Source§

fn clone(&self) -> JsonFilter

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

impl Debug for JsonFilter

Source§

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

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

impl<'de> Deserialize<'de> for JsonFilter

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for JsonFilter

Source§

fn eq(&self, other: &JsonFilter) -> 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.
Source§

impl Serialize for JsonFilter

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for JsonFilter

Source§

impl StructuralPartialEq for JsonFilter

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<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, 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> 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 = Infallible

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

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

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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,