Struct SubQuery 

pub struct SubQuery { /* private fields */ }

A sub-query inside a MultiQuery.

Each sub-query targets a single vector or sparse-vector field.

Implementations

impl SubQuery

pub fn new() -> Result<Self>

Creates a new sub-query.

pub unsafe fn as_raw(&self) -> *mut zvec_sub_query_t

Returns the raw FFI handle.

Safety

The caller must not use the handle after the SubQuery is dropped.

pub fn set_num_candidates(&mut self, n: i32) -> Result<()>

Sets the number of candidates to retrieve before reranking.

pub fn num_candidates(&self) -> i32

Returns the number of candidates.

pub fn set_field_name(&mut self, name: &str) -> Result<()>

Sets the target field name.

pub fn set_query_vector(&mut self, data: &[f32]) -> Result<()>

Sets the dense query vector (f32).

pub fn set_sparse_vector( &mut self, indices: &[u32], values: &[f32], ) -> Result<()>

Sets the sparse vector (indices + values, equal length).

pub fn set_sparse_indices(&mut self, indices: &[u32]) -> Result<()>

Sets only the sparse-vector indices.

pub fn set_sparse_values(&mut self, values: &[f32]) -> Result<()>

Sets only the sparse-vector values.

pub fn set_hnsw_params(&mut self, params: HnswQueryParams) -> Result<()>

Sets HNSW query parameters (takes ownership on success).

pub fn set_ivf_params(&mut self, params: IvfQueryParams) -> Result<()>

Sets IVF query parameters (takes ownership on success).

pub fn set_ivf_rabitq_params( &mut self, params: IvfRabitqQueryParams, ) -> Result<()>

Sets IVF RaBitQ query parameters (takes ownership on success).

pub fn set_flat_params(&mut self, params: FlatQueryParams) -> Result<()>

Sets Flat query parameters (takes ownership on success).

pub fn set_diskann_params(&mut self, params: DiskannQueryParams) -> Result<()>

Sets DiskANN query parameters (takes ownership on success).

pub fn set_fts_params(&mut self, params: FtsQueryParams) -> Result<()>

Sets FTS query parameters (takes ownership on success).

pub fn set_fts(&mut self, fts: &Fts) -> Result<()>

Sets FTS payload (payload is copied, caller retains ownership).

Trait Implementations

impl Drop for SubQuery

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for SubQuery