Struct VectorDataValue 

pub struct VectorDataValue { /* private fields */ }

VectorData value storing the external ID, embedding vector, and metadata.

The key for this record is VectorDataKey { vector_id }, where vector_id is the internal u64 ID (not the user-provided external ID).

Value Layout (little-endian)

┌────────────────────────────────────────────────────────────────┐
│  external_id: Utf8  (max 64 bytes, user-provided identifier)   │
│  fields:      Array<Field>                                     │
│                                                                │
│  Field                                                         │
│  ┌──────────────────────────────────────────────────────────┐  │
│  │  field_name:  Utf8                                       │  │
│  │  value:       FieldValue (tagged union)                  │  │
│  └──────────────────────────────────────────────────────────┘  │
│                                                                │
│  The vector is stored as a special field with name "vector"    │
│  and type FieldValue::Vector.                                  │
└────────────────────────────────────────────────────────────────┘

Field Ordering

Fields are automatically sorted by field_name during construction to ensure consistent encoding.

Common Dimensionalities

Model	Dimensions	Vector Size
MiniLM-L6	384	1.5 KB
BERT base	768	3 KB
OpenAI ada-002	1536	6 KB
OpenAI text-3-large	3072	12 KB

Implementations

impl VectorDataValue

pub fn new(external_id: impl Into<String>, fields: Vec<Field>) -> Self

Create a new VectorDataValue with external ID and fields.

The caller should include a field with name VECTOR_FIELD_NAME (“vector”) containing a FieldValue::Vector. Fields are sorted by name for consistent encoding.

pub fn encode_to_bytes(&self) -> Bytes

Encode to bytes.

pub fn decode_from_bytes( buf: &[u8], dimensions: usize, ) -> Result<Self, EncodingError>

Decode vector data from bytes.

Requires dimensions to properly decode the vector field.

pub fn external_id(&self) -> &str

Returns the external ID.

pub fn fields(&self) -> impl Iterator<Item = &Field>

Returns an iterator over metadata fields (excludes the vector field).

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

Get a metadata field by name.

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

Get a string field value.

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

Get an i64 field value.

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

Get an f64 field value.

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

Get a bool field value.

pub fn vector_field(&self) -> &[f32]

Get vector field value

Trait Implementations

impl Clone for VectorDataValue

fn clone(&self) -> VectorDataValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorDataValue

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

Formats the value using the given formatter.

impl PartialEq for VectorDataValue

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for VectorDataValue