Struct DocRef 

pub struct DocRef<'a> { /* private fields */ }

Non-owning document reference (e.g. rows returned from a query).

Implementations

impl<'a> DocRef<'a>

pub fn pk_ref(&self) -> Option<&'a str>

Borrow the PK without copying. The returned slice is invalidated when the underlying document is destroyed.

pub fn pk_copy(&self) -> Option<String>

Copy the PK into an owned String.

pub fn doc_id(&self) -> u64

pub fn score(&self) -> f32

pub fn operator(&self) -> DocOperator

pub fn field_count(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn has_field(&self, name: &str) -> bool

pub fn has_field_value(&self, name: &str) -> bool

pub fn is_field_null(&self, name: &str) -> bool

pub fn memory_usage(&self) -> usize

pub fn field_names(&self) -> Result<Vec<String>>

pub fn get_basic<T: Copy>(&self, name: &str, ty: DataType) -> Result<T>

Fetch a field value into a buffer using the “basic” variant — supports BOOL / INT32 / INT64 / UINT32 / UINT64 / FLOAT / DOUBLE.

pub fn get_int32(&self, name: &str) -> Result<i32>

pub fn get_int64(&self, name: &str) -> Result<i64>

pub fn get_uint32(&self, name: &str) -> Result<u32>

pub fn get_uint64(&self, name: &str) -> Result<u64>

pub fn get_float(&self, name: &str) -> Result<f32>

pub fn get_double(&self, name: &str) -> Result<f64>

pub fn get_bool(&self, name: &str) -> Result<bool>

pub fn get_copy(&self, name: &str, ty: DataType) -> Result<Vec<u8>>

Copy a field value (for variable-size types). Returns raw bytes which the caller can reinterpret.

pub fn get_string(&self, name: &str) -> Result<Option<String>>

pub fn get_vector_fp32(&self, name: &str) -> Result<Vec<f32>>

pub fn get_vector_fp64(&self, name: &str) -> Result<Vec<f64>>

pub fn get_vector_int8(&self, name: &str) -> Result<Vec<i8>>

Retrieve an INT8 vector field.

pub fn get_vector_int16(&self, name: &str) -> Result<Vec<i16>>

Retrieve an INT16 vector field.

pub fn get_vector_fp16_bits(&self, name: &str) -> Result<Vec<u16>>

Retrieve an FP16 vector field as its raw 16-bit bit patterns.

pub fn get_vector_fp16(&self, name: &str) -> Result<Vec<f16>>

Available on crate feature half only.

Retrieve an FP16 vector field as Vec<half::f16>.

Available with the half cargo feature.

pub fn get_vector_int4_packed(&self, name: &str) -> Result<Vec<u8>>

Retrieve a nibble-packed INT4 vector field as raw bytes (2 values per byte).

pub fn get_vector_binary32(&self, name: &str) -> Result<Vec<u32>>

pub fn get_vector_binary64(&self, name: &str) -> Result<Vec<u64>>

pub fn get_array_int32(&self, name: &str) -> Result<Vec<i32>>

pub fn get_array_int64(&self, name: &str) -> Result<Vec<i64>>

pub fn get_array_uint32(&self, name: &str) -> Result<Vec<u32>>

pub fn get_array_uint64(&self, name: &str) -> Result<Vec<u64>>

pub fn get_array_float(&self, name: &str) -> Result<Vec<f32>>

pub fn get_array_double(&self, name: &str) -> Result<Vec<f64>>

pub fn get_binary(&self, name: &str) -> Result<Vec<u8>>

Retrieve a binary field (opaque bytes). Suitable for DataType::Binary.

Trait Implementations

impl<'a> Clone for DocRef<'a>

fn clone(&self) -> DocRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for DocRef<'a>

impl Send for DocRef<'_>

impl Sync for DocRef<'_>