Neighbors Filters Module

Rust module: cuvs::neighbors::filters

Source: rust/cuvs/src/neighbors/filters.rs

Shared filter payloads for nearest-neighbor search APIs.

FilterError

#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum FilterError {
    /* variants omitted */
}

Error returned when constructing an invalid filter payload.

Source: rust/cuvs/src/neighbors/filters.rs:15

pub enum Bitset {
    /* variants omitted */
}

Marker for a row-level bitset filter.

Source: rust/cuvs/src/neighbors/filters.rs:34

pub enum Bitmap {
    /* variants omitted */
}

Marker for a per-query bitmap filter.

Source: rust/cuvs/src/neighbors/filters.rs:37

pub trait Sealed {
    /* required methods omitted */
}

Source: rust/cuvs/src/neighbors/filters.rs:40

pub trait FilterKind: sealed::Sealed {
    /* required methods omitted */
}

Kind of packed filter payload.

This trait is sealed; only [Bitset] and [Bitmap] implement it.

Source: rust/cuvs/src/neighbors/filters.rs:46

pub struct Filter<'a, K: FilterKind> {
    /* private fields */
}

Packed filter words used to include or exclude rows during search.

Methods

Name	Source
`new`	`rust/cuvs/src/neighbors/filters.rs:71`

pub fn new<T>(filter_words: &'a T) -> Result<Self, FilterError>
where
T: AsDlTensor + ?Sized,

Creates a packed filter borrowing filter_words.

Source: rust/cuvs/src/neighbors/filters.rs:71

Source: rust/cuvs/src/neighbors/filters.rs:64