Struct VelesConfig 

pub struct VelesConfig {
    pub search: SearchConfig,
    pub hnsw: HnswConfig,
    pub storage: StorageConfig,
    pub limits: LimitsConfig,
    pub server: ServerConfig,
    pub logging: LoggingConfig,
    pub quantization: QuantizationConfig,
    pub wal_batch: WalBatchConfig,
}

Main VelesDB configuration structure.

Fields

search: SearchConfig

Search configuration.

hnsw: HnswConfig

HNSW index configuration.

storage: StorageConfig

Storage configuration.

limits: LimitsConfig

Limits configuration.

server: ServerConfig

Server configuration.

logging: LoggingConfig

Logging configuration.

quantization: QuantizationConfig

Quantization configuration.

wal_batch: WalBatchConfig

WAL group commit batching configuration.

Implementations

impl VelesConfig

pub fn load() -> Result<Self, ConfigError>

Loads configuration from default sources.

Priority: defaults < file < environment variables.

Errors

Returns ConfigError if the configuration file is malformed or environment variables contain invalid values.

pub fn load_from_path<P: AsRef<Path>>(path: P) -> Result<Self, ConfigError>

Loads configuration from a specific file path.

Arguments

• path - Path to the configuration file.

Errors

Returns an error if configuration parsing fails.

pub fn from_toml(toml_str: &str) -> Result<Self, ConfigError>

Creates a configuration from a TOML string.

Arguments

• toml_str - TOML configuration string.

Errors

Returns an error if parsing fails.

pub fn load_from_path_engine_only<P: AsRef<Path>>( path: P, ) -> Result<Self, ConfigError>

Loads configuration from a specific file path, considering only the engine sections ([search]/[hnsw]/[storage]/[limits]/ [quantization]/[wal_batch]) and silently dropping any other top-level table before parsing — notably [server] and [logging].

Use this instead of Self::load_from_path when the TOML file is shared with a hosting shell that owns its own [server]/ [auth]/[tls]/[cors]/… sections under possibly-colliding keys — e.g. velesdb-server --config reads the same file for its own HTTP transport settings ([server].port = the bind port) and for this engine config. Without filtering, [server] port = 443 (a perfectly legitimate low bind port, e.g. behind setcap/a privileged process) would also land in this struct’s server.port and be rejected by Self::validate’s port >= 1024 rule — a spurious failure with nothing to do with the actual value being configured.

As with Self::load_from_path, VELESDB_* environment variables are layered on top of the (filtered) file and can still override an engine value — e.g. VELESDB_LIMITS_MAX_COLLECTIONS=5 overrides a [limits] max_collections from the file. Env vars for non-engine sections (VELESDB_SERVER_*, VELESDB_LOGGING_*, …) are harmless here: they don’t match any field once those sections are filtered out of the base document, so they’re ignored the same way an unrecognised key always is.

Errors

Returns an error if the file cannot be read, is not valid TOML, or fails validation.

pub fn from_toml_engine_only(toml_str: &str) -> Result<Self, ConfigError>

Same as Self::load_from_path_engine_only but from an in-memory TOML string, with no environment-variable layer — mirrors how Self::from_toml relates to Self::load_from_path.

Errors

Returns an error if toml_str is not valid TOML or fails validation.

pub fn effective_ef_search(&self) -> usize

Returns the effective ef_search value.

pub fn to_toml(&self) -> Result<String, ConfigError>

Serializes the configuration to TOML.

Errors

Returns an error if serialization fails.

impl VelesConfig

pub fn validate(&self) -> Result<(), ConfigError>

Validates the configuration.

Errors

Returns an error if any configuration value is invalid.

Trait Implementations

impl Clone for VelesConfig

fn clone(&self) -> VelesConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VelesConfig

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

Formats the value using the given formatter.

impl Default for VelesConfig

fn default() -> VelesConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VelesConfig

where VelesConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for VelesConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.