Enum StorageMode 

#[non_exhaustive]
pub enum StorageMode {
    Full,
    SQ8,
    Binary,
    ProductQuantization,
    RaBitQ,
}

Storage mode for vectors.

Capacity mode vs search-path mode

Mode	Kind	Collection search path
Full	full-precision	f32 (baseline)
SQ8	Capacity Mode	full-precision f32 (memory only, no throughput gain)
Binary	Capacity Mode	full-precision f32 (memory only, no throughput gain)
ProductQuantization	search-path mode	ADC-rescored (wired)
RaBitQ	search-path mode	quantized traversal (wired end-to-end)

Capacity Modes (SQ8, Binary) reduce the in-memory footprint of the quantization primitives, but the collection search path stays full-precision f32 for those modes — selecting them does not gain search throughput. Search-path modes (RaBitQ, ProductQuantization) are the quantized paths wired into the query hot path. See docs/guides/QUANTIZATION.md.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Full

Full precision f32 storage (default).

SQ8

Capacity Mode. 8-bit scalar quantization for 4x memory reduction. Reduces the quantization primitive’s footprint only; the collection search path stays full-precision f32 and gains no search throughput.

Binary

Capacity Mode. 1-bit binary quantization for 32x memory reduction. Best for edge/IoT devices with limited RAM. Reduces footprint only; the collection search path stays full-precision f32 and gains no search throughput (use RaBitQ for a quantized search path).

ProductQuantization

Product Quantization (PQ) for aggressive lossy compression (8x-16x typical). Search-path mode: wired into the query hot path for ADC (Asymmetric Distance Computation) rescoring.

RaBitQ

RaBitQ binary quantization for 32x compression with scalar correction. Search-path mode: the performant quantized search path, wired end-to-end into the query hot path.

Implementations

impl StorageMode

pub const fn canonical_name(self) -> &'static str

Returns the canonical lowercase name for this storage mode.

This is the single source of truth for string representations, used by std::fmt::Display, std::str::FromStr, and downstream crates.

pub fn parse_alias(value: &str) -> Option<Self>

Parses a storage mode string with alias support.

Accepted aliases (case-insensitive):

• full, f32 -> Full
• sq8, int8 -> SQ8
• binary, bit -> Binary
• pq, product_quantization -> ProductQuantization
• rabitq -> RaBitQ

Examples

use velesdb_core::StorageMode;

assert_eq!(StorageMode::parse_alias("sq8"), Some(StorageMode::SQ8));
assert_eq!(StorageMode::parse_alias("INT8"), Some(StorageMode::SQ8));
assert_eq!(StorageMode::parse_alias("unknown"), None);

Trait Implementations

impl Clone for StorageMode

fn clone(&self) -> StorageMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StorageMode

impl Debug for StorageMode

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

Formats the value using the given formatter.

impl Default for StorageMode

fn default() -> StorageMode

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StorageMode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StorageMode

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

Formats the value using the given formatter.

impl Eq for StorageMode

impl FromStr for StorageMode

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for StorageMode

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StorageMode

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 StorageMode