Struct WithinFilter 

pub struct WithinFilter { /* private fields */ }

Filter that finds geometries contained within a given geometry.

A stored geometry matches if it is completely contained within the search geometry.

Implementations

impl WithinFilter

pub fn new(field: impl Into<String>, geometry: Geometry) -> Self

Creates a new within filter.

Trait Implementations

impl Clone for WithinFilter

fn clone(&self) -> WithinFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Display for WithinFilter

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

Formats the value using the given formatter.

impl FilterProvider for WithinFilter

fn apply(&self, entry: &Document) -> NitriteResult<bool>

Applies the filter to a document and returns whether it matches.

fn has_field(&self) -> bool

Checks if this filter operates on a specific field.

fn get_field_name(&self) -> NitriteResult<String>

Gets the field name this filter operates on.

fn set_field_name(&self, field_name: String) -> NitriteResult<()>

Sets the field name for this filter.

fn is_index_only_filter(&self) -> bool

Checks if this filter can be satisfied by index lookup alone.

fn supported_index_type(&self) -> NitriteResult<String>

Gets the index type that this filter supports.

fn can_be_grouped(&self, other: Filter) -> NitriteResult<bool>

fn as_any(&self) -> &dyn Any

fn apply_on_index( &self, _index_map: &IndexMap, ) -> Result<Vec<Value>, NitriteError>

Applies the filter using an index map for optimized scanning.

fn get_collection_name(&self) -> Result<String, NitriteError>

Gets the associated collection name for this filter.

fn set_collection_name( &self, _collection_name: String, ) -> Result<(), NitriteError>

Sets the collection name for this filter.

fn get_field_value(&self) -> Result<Option<Value>, NitriteError>

Gets the field value this filter operates on.

fn set_field_value(&self, _field_value: Value) -> Result<(), NitriteError>

Sets the field value for this filter.

fn get_reverse_scan(&self) -> Result<bool, NitriteError>

Gets whether reverse scanning is enabled.

fn set_reverse_scan(&self, _reverse_scan: bool) -> Result<(), NitriteError>

Sets whether to use reverse scanning.

fn is_reverse_scan_supported(&self) -> bool

Checks if this filter supports reverse scanning through indexes.

fn process_index_value( &self, value: Option<Value>, sub_map: &mut Vec<Value>, nitrite_ids: &mut Vec<Value>, )

fn validate_array_search_term( &self, field: String, value: &Value, ) -> Result<(), NitriteError>

fn logical_filters(&self) -> Result<Vec<Filter>, NitriteError>

impl SpatialFilterOps for WithinFilter

fn geometry(&self) -> &Geometry

Gets the search geometry.

fn matches_geometry(&self, stored: &Geometry) -> bool

Performs the precise geometry match (Phase 2). Returns true if the stored geometry matches the filter criteria.