Struct EdgeConfig 

pub struct EdgeConfig {
    pub on_disk_payload: Option<bool>,
    pub vectors: HashMap<String, EdgeVectorParams>,
    pub sparse_vectors: HashMap<String, EdgeSparseVectorParams>,
    pub hnsw_config: Option<HnswConfig>,
    pub quantization_config: Option<QuantizationConfig>,
    pub optimizers: Option<EdgeOptimizersConfig>,
    pub wal_options: Option<WalOptions>,
    pub max_search_threads: Option<usize>,
    pub search_pool_core: Option<usize>,
}

Full configuration for an edge shard.

vectors and sparse_vectors define the stored data: when loading an existing shard they are validated for compatibility against the segments if provided (non-empty), or taken from the persisted config / the segments themselves if not.

Everything else is tunable and None means “not specified”: when loading an existing shard each parameter resolves through provided → persisted → derived from segments → default (see EdgeConfig::fill_unspecified_from), so leaving a parameter unspecified keeps the shard as it is, while a Some value explicitly overwrites it and existing segments converge to it through the optimizers.

Fields

on_disk_payload: Option<bool>

If true, payload is stored on disk (mmap); otherwise in RAM. Same as CollectionParams::on_disk_payload. None defaults to on-disk, see EdgeConfig::on_disk_payload.

vectors: HashMap<String, EdgeVectorParams>

Dense vector params per vector name.

sparse_vectors: HashMap<String, EdgeSparseVectorParams>

Sparse vector params per vector name.

hnsw_config: Option<HnswConfig>

Global HNSW config; per-vector override is in vectors[].hnsw_config. None defaults to HnswConfig::default, see EdgeConfig::hnsw_config.

quantization_config: Option<QuantizationConfig>

Global quantization config for all vectors Per-vector override in in vectors[].quantization_config

optimizers: Option<EdgeOptimizersConfig>

None defaults to EdgeOptimizersConfig::default, see EdgeConfig::optimizers.

wal_options: Option<WalOptions>

WAL options for the shard. None keeps the WAL crate’s defaults (32 MiB segment capacity). Override for embedded/mobile deployments where the default segment size is too large.

max_search_threads: Option<usize>

Number of threads in the shard’s search thread pool. The pool executes per-segment reads (search, scroll, count, facet, …) in parallel and loads segments in parallel. None (the default) derives the count from the number of CPUs, matching the core search runtime — see EdgeConfig::search_thread_count.

search_pool_core: Option<usize>

Pin every thread of this shard’s search pool to the given CPU core: bounds the shard’s search compute to one core while keeping the pool’s IO overlap. Best-effort. None (the default) leaves thread placement to the OS scheduler.

Implementations

impl EdgeConfig

pub fn builder() -> EdgeConfigBuilder

Start building an EdgeConfig with a fluent API.

pub fn on_disk_payload(&self) -> bool

Effective payload storage location: on-disk unless explicitly set to false.

pub fn hnsw_config(&self) -> HnswConfig

Effective global HNSW config: HnswConfig::default unless explicitly set.

pub fn optimizers(&self) -> EdgeOptimizersConfig

Effective optimizers config: EdgeOptimizersConfig::default unless explicitly set.

pub fn fill_unspecified_from(self, base: &EdgeConfig) -> Self

Fill parameters left unspecified from base, keeping explicitly provided values.

Chained over the fallback layers of EdgeShard::load: provided → persisted → derived from segments → default.

For tunables, unspecified means None. For vectors and sparse_vectors it means an empty map: a non-empty map is taken as-is (never merged element-wise) — those define the stored data, so the load path validates them against existing segments instead of converging via the optimizers like the tunables do.

pub fn from_segment_config(segment: &SegmentConfig) -> Self

Build from existing segment config. Fills all parameters that can be inferred.

pub fn search_thread_count(&self) -> usize

Resolve the configured max_search_threads into a concrete thread count. None derives the count from the number of CPUs, matching the core search runtime (common::defaults::search_thread_count).

pub fn check_compatible_with_segment_config( &self, other: &SegmentConfig, ) -> Result<(), String>

Check compatibility with a segment config (e.g. loaded segment).

pub fn plain_segment_config(&self) -> SegmentConfig

Segment config for creating appendable segments only. Does not contain any HNSW configuration (plain index only).

pub fn vector_names(&self) -> HashSet<String>

All vector names (dense and sparse) currently present in this config.

Must cover both kinds: a segment’s vector_data holds dense and sparse vectors together, so the optimizer merge consults this set for both.

pub fn segment_optimizer_config(&self) -> SegmentOptimizerConfig

Build segment optimizer config from this config (for blocking optimizers). Use this instead of converting to SegmentConfig first.

pub fn vector_data_config(&self, name: &String) -> Option<VectorDataConfig>

Return vector data config for a named vector (for read-only use, e.g. query). Uses plain index; for optimizer/segment creation use segment_optimizer_config or plain_segment_config.

pub fn get_distance(&self, vector_name: &str) -> OperationResult<Distance>

Distance of a named vector, mirroring CollectionParams::get_distance: sparse vectors always score with Dot.

pub fn optimizer_thresholds( &self, num_indexing_threads: usize, ) -> OptimizerThresholds

pub fn save(&self, path: &Path) -> OperationResult<()>

pub fn load(path: &Path) -> Option<OperationResult<Self>>

pub fn set_hnsw_config(&mut self, hnsw_config: HnswConfig)

pub fn set_vector_hnsw_config( &mut self, vector_name: &str, hnsw_config: HnswConfig, ) -> OperationResult<()>

pub fn set_optimizers_config(&mut self, optimizers: EdgeOptimizersConfig)

Trait Implementations

impl Clone for EdgeConfig

fn clone(&self) -> EdgeConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EdgeConfig

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

Formats the value using the given formatter.

impl Default for EdgeConfig

fn default() -> EdgeConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EdgeConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EdgeConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EdgeConfig

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 EdgeConfig