Struct Filter 

pub struct Filter {
    pub must: Vec<Condition>,
    pub should: Vec<Condition>,
    pub must_not: Vec<Condition>,
}

A Boolean point filter.

Every must condition and no must_not condition must match. When should is non-empty, at least one should condition must also match.

Fields

must: Vec<Condition>

Conditions that must all match.

should: Vec<Condition>

Conditions of which at least one must match when the list is non-empty.

must_not: Vec<Condition>

Conditions that must not match.

Implementations

impl Filter

pub fn must(conditions: impl IntoIterator<Item = Condition>) -> Self

Creates a filter containing only required conditions.

Examples found in repository

examples/lancedb_git_vdb_runner.rs (lines 442-448)

fn selectivity_filter(selectivity: f64) -> Filter {
    Filter::must([Condition::range(
        "selectivity_bucket",
        Range {
            lt: Some((selectivity * 1000.0).round()),
            ..Range::default()
        },
    )])
}

examples/filtering.rs (line 13)

fn main() -> git_vdb::Result<()> {
    let temporary = tempfile::TempDir::new()?;
    let docs = open(temporary.path().join("vectors.git"))?.collection("docs");
    docs.upsert([
        Point::new("guide", [1.0, 0.0]).with_metadata(json!({"kind": "docs"}))?,
        Point::new("code", [0.9, 0.1]).with_metadata(json!({"kind": "source"}))?,
    ])?;
    let result = docs.advanced()?.query(
        Query::new([1.0, 0.0], 5)
            .with_filter(Filter::must([Condition::matches("kind", "docs")]))
            .with_payload(),
    )?;
    assert_eq!(result.points[0].id.to_string(), "guide");
    Ok(())
}

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

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

Formats the value using the given formatter.

impl Default for Filter

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Filter

where Filter: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Filter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.