pub struct VectorEngineConfig {
pub default_dimension: Option<usize>,
pub sparse_threshold: f32,
pub parallel_threshold: usize,
pub default_metric: DistanceMetric,
pub max_dimension: Option<usize>,
pub max_keys_per_scan: Option<usize>,
pub batch_parallel_threshold: usize,
pub search_timeout: Option<Duration>,
pub max_index_file_bytes: Option<usize>,
pub max_index_entries: Option<usize>,
}Expand description
Configuration for the Vector Engine.
Fields§
§default_dimension: Option<usize>Default dimension for embeddings (validated on first store if set).
sparse_threshold: f32Threshold for sparse vector detection (fraction of zeros).
parallel_threshold: usizeBatch size threshold for parallel processing.
default_metric: DistanceMetricDefault distance metric for search operations.
max_dimension: Option<usize>Maximum allowed embedding dimension for memory safety.
max_keys_per_scan: Option<usize>Maximum keys to return from unbounded scan operations.
batch_parallel_threshold: usizeThreshold for using parallel iteration in batch operations.
search_timeout: Option<Duration>Search operation timeout. None means no timeout (default).
max_index_file_bytes: Option<usize>Maximum index file size in bytes (default: 100MB).
max_index_entries: Option<usize>Maximum entries in a loaded index (default: 1M).
Implementations§
Source§impl VectorEngineConfig
impl VectorEngineConfig
Sourcepub const fn high_throughput() -> Self
pub const fn high_throughput() -> Self
Creates a configuration optimized for high throughput workloads.
Uses a lower parallel threshold (1000) for more aggressive parallelism.
Sourcepub const fn low_memory() -> Self
pub const fn low_memory() -> Self
Creates a configuration optimized for low memory environments.
Sets max_dimension to 4096 and max_keys_per_scan to 10,000.
Sourcepub fn validate(&self) -> Result<()>
pub fn validate(&self) -> Result<()>
Validates the configuration parameters.
§Errors
Returns an error if any parameter is out of valid range.
Sourcepub const fn with_default_dimension(self, dim: usize) -> Self
pub const fn with_default_dimension(self, dim: usize) -> Self
Set the default embedding dimension.
Sourcepub const fn with_sparse_threshold(self, threshold: f32) -> Self
pub const fn with_sparse_threshold(self, threshold: f32) -> Self
Set the sparse vector detection threshold (0.0-1.0).
Sourcepub const fn with_parallel_threshold(self, threshold: usize) -> Self
pub const fn with_parallel_threshold(self, threshold: usize) -> Self
Set the parallel processing threshold.
Sourcepub const fn with_default_metric(self, metric: DistanceMetric) -> Self
pub const fn with_default_metric(self, metric: DistanceMetric) -> Self
Set the default distance metric.
Sourcepub const fn with_max_dimension(self, max: usize) -> Self
pub const fn with_max_dimension(self, max: usize) -> Self
Set the maximum allowed embedding dimension.
Sourcepub const fn with_max_keys_per_scan(self, max: usize) -> Self
pub const fn with_max_keys_per_scan(self, max: usize) -> Self
Set the maximum keys per scan operation.
Sourcepub const fn with_batch_parallel_threshold(self, threshold: usize) -> Self
pub const fn with_batch_parallel_threshold(self, threshold: usize) -> Self
Set the batch parallel processing threshold.
Sourcepub const fn with_search_timeout(self, timeout: Duration) -> Self
pub const fn with_search_timeout(self, timeout: Duration) -> Self
Set the search operation timeout.
Sourcepub const fn with_max_index_file_bytes(self, max_bytes: usize) -> Self
pub const fn with_max_index_file_bytes(self, max_bytes: usize) -> Self
Set the maximum index file size in bytes.
Sourcepub const fn with_max_index_entries(self, max_entries: usize) -> Self
pub const fn with_max_index_entries(self, max_entries: usize) -> Self
Set the maximum number of entries in a loaded index.
Trait Implementations§
Source§impl Clone for VectorEngineConfig
impl Clone for VectorEngineConfig
Source§fn clone(&self) -> VectorEngineConfig
fn clone(&self) -> VectorEngineConfig
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for VectorEngineConfig
impl Debug for VectorEngineConfig
Auto Trait Implementations§
impl Freeze for VectorEngineConfig
impl RefUnwindSafe for VectorEngineConfig
impl Send for VectorEngineConfig
impl Sync for VectorEngineConfig
impl Unpin for VectorEngineConfig
impl UnsafeUnpin for VectorEngineConfig
impl UnwindSafe for VectorEngineConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.