Struct Doc 

pub struct Doc { /* private fields */ }

A typed document. BTreeMap gives deterministic snapshots and tie-breaks.

Implementations

impl Doc

pub fn add_vector_f32(&mut self, name: &str, vector: &[f32]) -> Result<()>

pub fn add_vector_f64(&mut self, name: &str, vector: &[f64]) -> Result<()>

pub fn add_vector_i8(&mut self, name: &str, vector: &[i8]) -> Result<()>

pub fn add_vector_i16(&mut self, name: &str, vector: &[i16]) -> Result<()>

pub fn add_vector_fp16(&mut self, name: &str, vector: &[u16]) -> Result<()>

pub fn add_vector_fp16_f32(&mut self, name: &str, vector: &[f32]) -> Result<()>

pub fn add_vector_i4(&mut self, name: &str, vector: &[i8]) -> Result<()>

pub fn add_vector_binary32(&mut self, name: &str, vector: &[u8]) -> Result<()>

pub fn add_vector_binary64(&mut self, name: &str, vector: &[u8]) -> Result<()>

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

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

pub fn add_sparse_vector_fp16( &mut self, name: &str, indices: &[u32], values: &[u16], ) -> Result<()>

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

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

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

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

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

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

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

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

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

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

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

impl Doc

pub fn new() -> Result<Self>

pub fn with_pk(pk: impl Into<String>) -> Result<Self>

pub fn set_pk(&mut self, pk: &str)

Sets the primary key. Empty keys are rejected at the collection write boundary so this method remains source-compatible with zvec’s () API.

pub fn get_pk(&self) -> Option<&str>

pub fn get_score(&self) -> f32

pub fn score(&self) -> f32

pub fn set_score(&mut self, score: f32) -> Result<()>

pub fn doc_id(&self) -> Option<u64>

Returns the generation-local ordinal exposed by a query that requested document IDs. Ordinary input documents and queries without that option return None.

pub fn field_count(&self) -> usize

pub fn is_empty(&self) -> bool

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

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

pub fn field(&self, name: &str) -> Option<&FieldValue>

pub fn vector(&self, name: &str) -> Option<&VectorValue>

pub fn fields(&self) -> &BTreeMap<String, FieldValue>

pub fn vectors(&self) -> &BTreeMap<String, VectorValue>

pub fn set_field_value(&mut self, name: &str, value: FieldValue) -> Result<()>

pub fn set_vector_value(&mut self, name: &str, value: VectorValue) -> Result<()>

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

pub fn add_bool(&mut self, name: &str, value: bool) -> Result<()>

pub fn add_i32(&mut self, name: &str, value: i32) -> Result<()>

pub fn add_i64(&mut self, name: &str, value: i64) -> Result<()>

pub fn add_u32(&mut self, name: &str, value: u32) -> Result<()>

pub fn add_u64(&mut self, name: &str, value: u64) -> Result<()>

pub fn add_f32(&mut self, name: &str, value: f32) -> Result<()>

pub fn add_f64(&mut self, name: &str, value: f64) -> Result<()>

pub fn add_binary(&mut self, name: &str, value: &[u8]) -> Result<()>

pub fn add_array_binary(&mut self, name: &str, values: &[Vec<u8>]) -> Result<()>

pub fn add_array_string(&mut self, name: &str, values: &[&str]) -> Result<()>

pub fn add_array_i32(&mut self, name: &str, values: &[i32]) -> Result<()>

pub fn add_array_i64(&mut self, name: &str, values: &[i64]) -> Result<()>

pub fn add_array_u32(&mut self, name: &str, values: &[u32]) -> Result<()>

pub fn add_array_u64(&mut self, name: &str, values: &[u64]) -> Result<()>

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

pub fn add_array_f64(&mut self, name: &str, values: &[f64]) -> Result<()>

pub fn add_array_bool(&mut self, name: &str, values: &[bool]) -> Result<()>

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

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

pub fn clear(&mut self)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn get_array_bool(&self, name: &str) -> Result<Option<Vec<bool>>>

pub fn project( &self, output_fields: Option<&[String]>, include_vector: bool, ) -> Self

Returns a projection suitable for query/fetch output.

Trait Implementations

impl Clone for Doc

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 Doc

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

Formats the value using the given formatter.

impl Default for Doc

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Doc

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Doc

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Doc

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Doc