Struct Doc 

pub struct Doc { /* private fields */ }

Owning document.

Implementations

impl Doc

pub fn new() -> Result<Self>

pub fn borrow(&self) -> DocRef<'_>

Borrow this document non-mutably, e.g. to read fields.

pub fn clear(&mut self)

pub fn set_pk(&mut self, pk: &str) -> Result<()>

pub fn set_doc_id(&mut self, id: u64)

pub fn set_score(&mut self, score: f32)

pub fn set_operator(&mut self, op: DocOperator)

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

pub fn add_field_raw( &mut self, field_name: &str, data_type: DataType, value: &[u8], ) -> Result<()>

Raw field setter — value is the wire layout expected by zvec for data_type. See Self::add_string, Self::add_vector_fp32 etc. for typed wrappers.

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

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

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

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

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

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

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

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

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

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

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

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

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

Add an INT16 vector field. Values are stored as-is in native byte order.

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

Add an FP16 vector field. Each u16 is the raw bit pattern of an IEEE-754 half-precision float, as zvec’s C API accepts them; pair with a crate like half to produce them from f32.

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

Available on crate feature half only.

Add an FP16 vector field directly from a slice of half::f16.

Available with the half cargo feature.

pub fn add_vector_int4_packed( &mut self, field_name: &str, packed: &[u8], ) -> Result<()>

Add an INT4 vector field. INT4 is nibble-packed — two values per byte — and zvec expects the caller to hand it pre-packed bytes.

pub fn add_vector_binary32( &mut self, field_name: &str, words: &[u32], ) -> Result<()>

Add a binary32 vector field (bit-packed, 32 bits per word).

pub fn add_vector_binary64( &mut self, field_name: &str, words: &[u64], ) -> Result<()>

Add a binary64 vector field (bit-packed, 64 bits per word).

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

Add an array<int32> field.

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

Add an array<int64> field.

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

Add an array<uint32> field.

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

Add an array<uint64> field.

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

Add an array<float> field.

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

Add an array<double> field.

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

pub fn merge(&mut self, other: &Doc)

pub fn validate(&self, schema: &CollectionSchema, is_update: bool) -> Result<()>

pub fn serialize(&self) -> Result<Vec<u8>>

pub fn deserialize(data: &[u8]) -> Result<Self>

pub fn to_detail_string(&self) -> Result<String>

pub fn pk(&self) -> Option<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_vector_fp32(&self, field_name: &str) -> Result<Vec<f32>>

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

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

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

impl Doc

pub fn from_json(value: &Value, schema: &CollectionSchema) -> Result<Self>

Available on crate feature serde-json only.

Build a Doc from a JSON object, resolving field types through schema. The special key "_pk" is recognised as the document’s primary key when it’s a string.

Available with the serde-json cargo feature.

Trait Implementations

impl Drop for Doc

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Doc