Struct RingDbConfig 

pub struct RingDbConfig {
    pub dims: usize,
    pub backend_preference: BackendPreference,
    pub persist_dir: Option<PathBuf>,
}

Configuration for a RingDb instance.

Fields

dims: usize

Number of dimensions per vector. Must be > 0.

backend_preference: BackendPreference

Backend selection strategy.

persist_dir: Option<PathBuf>

Optional directory for persisting the database.

When set, RingDb::build() writes the full database (vectors, norms, payloads, offsets, and metadata) to this directory. The sealed database can later be reloaded with RingDb::load().

Leave None (the default) for a purely in-memory database.

Implementations

impl RingDbConfig

pub fn new(dims: usize) -> Self

Create a config with default settings (CPU backend, no persistence).

pub fn with_persist_dir(self, dir: impl Into<PathBuf>) -> Self

Set the directory to which the database will be persisted on build().

The directory is created automatically if it does not exist.

Example

use ringdb::RingDbConfig;

let config = RingDbConfig::new(128).with_persist_dir("/var/data/mydb");

pub fn with_backend_preference(self, preference: BackendPreference) -> Self

Set the backend preference.

Defaults to BackendPreference::Cpu. Use this when loading a persisted database onto a specific backend via RingDb::load().

Example

use ringdb::RingDbConfig;
use ringdb::BackendPreference;

let config = RingDbConfig::new(128).with_backend_preference(BackendPreference::Cpu);

Trait Implementations

impl Clone for RingDbConfig

fn clone(&self) -> RingDbConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RingDbConfig

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

Formats the value using the given formatter.