Struct Descriptor 

pub struct Descriptor {
    pub dim: u32,
    pub dtype: Dtype,
    pub metric: DistanceMetric,
    pub index: IndexSpec,
    pub filterable: Vec<FilterableField>,
    pub multivector: bool,
    pub vector_encryption: VectorEncryption,
}

The immutable schema of a collection, fixed at creation.

Fields

dim: u32

Vector dimensionality.

dtype: Dtype

Vector element type.

metric: DistanceMetric

Distance metric used for search.

index: IndexSpec

Index & quantization configuration. Defaults to HNSW/exact and is absent in descriptors written before Phase 2 (filled by the default on read).

filterable: Vec<FilterableField>

Payload fields indexed for filtering. Empty by default and absent in descriptors written before secondary indexes existed (defaulted on read).

multivector: bool

Whether this is a multi-vector (late-interaction / ColBERT) collection: each document is stored as a group of token-vector rows and searched by MaxSim (ADR-0028). false for an ordinary single-vector collection, and absent in descriptors written before late interaction existed (defaulted to false on read).

vector_encryption: VectorEncryption

How this collection’s vectors are encrypted (ADR-0031, ADR-0032). VectorEncryption::None by default; Dcpe requires the L2 metric. Absent in descriptors written before the flag existed (defaulted to None on read); a descriptor written while the flag was a bool encrypted_vectors decodes unchanged (false→None, true→Dcpe).

Implementations

impl Descriptor

pub fn new(dim: u32, dtype: Dtype, metric: DistanceMetric) -> Descriptor

A descriptor with the default index (in-memory HNSW, exact) and no filterable fields.

pub fn with_index(self, index: IndexSpec) -> Descriptor

Set the index specification (builder style).

pub fn with_filterable(self, filterable: Vec<FilterableField>) -> Descriptor

Set the filterable payload fields (builder style).

pub fn with_multivector(self, multivector: bool) -> Descriptor

Mark this collection as multi-vector (late-interaction / ColBERT), so each document is stored as a group of token-vector rows scored by MaxSim (builder style). The dimensionality is the per-token dimension.

pub fn with_vector_encryption( self, vector_encryption: VectorEncryption, ) -> Descriptor

Set how this collection’s vectors are encrypted (builder style). A Dcpe collection must use the L2 metric; a ClientSide collection is searched by the client, not the server (ADR-0031, ADR-0032).

pub fn decode(bytes: &[u8]) -> Result<Descriptor, Error>

Decode a descriptor from its postcard bytes, tolerating every earlier layout.

postcard is non-self-describing, so a missing trailing field cannot be defaulted by #[serde(default)] alone (the reader hits end-of-input and errors). We therefore try the layouts newest-to-oldest — current (with vector_encryption) → the six-field multivector layout → the five-field filterable layout → the four-field index-only layout → the original three-field layout — defaulting the missing trailing fields. The order matters: postcard ignores trailing bytes, so an older decoder would silently mis-read a newer buffer if tried first.

Errors

Returns the postcard error if the bytes match no known layout.

pub fn stride(&self) -> usize

Byte length of one stored vector (dim × element_size).

Trait Implementations

impl Clone for Descriptor

fn clone(&self) -> Descriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Descriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Descriptor

fn deserialize<__D>( __deserializer: __D, ) -> Result<Descriptor, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Descriptor

impl From<DescriptorV2> for Descriptor

fn from(v: DescriptorV2) -> Descriptor

Converts to this type from the input type.

impl From<DescriptorV3> for Descriptor

fn from(v: DescriptorV3) -> Descriptor

Converts to this type from the input type.

impl From<DescriptorV4> for Descriptor

fn from(v: DescriptorV4) -> Descriptor

Converts to this type from the input type.

impl From<LegacyDescriptor> for Descriptor

fn from(v: LegacyDescriptor) -> Descriptor

Converts to this type from the input type.

impl PartialEq for Descriptor

fn eq(&self, other: &Descriptor) -> 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 Serialize for Descriptor

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Descriptor