Struct EdgeShard 

pub struct EdgeShard { /* private fields */ }

Implementations

impl EdgeShard

pub fn optimize(&self) -> OperationResult<bool>

Run shard optimizers in-process and blocking until no more optimization plans are produced.

This is synchronous and does not spawn background optimization workers.

impl EdgeShard

Inherent read API of EdgeShard, kept for backwards compatibility (edge is a public crate): callers can use these without importing EdgeShardRead. Each just forwards to the trait’s shared implementation.

pub fn search( &self, request: SearchRequest, ) -> OperationResult<Vec<ScoredPoint>>

This method is DEPRECATED and should be replaced with query.

pub fn query(&self, request: QueryRequest) -> OperationResult<Vec<ScoredPoint>>

pub fn scroll( &self, request: ScrollRequest, ) -> OperationResult<(Vec<RecordInternal>, Option<ExtendedPointId>)>

pub fn retrieve( &self, request: RetrieveRequest, ) -> OperationResult<Vec<RecordInternal>>

pub fn count(&self, request: CountRequest) -> OperationResult<usize>

pub fn facet(&self, request: FacetRequest) -> OperationResult<FacetResponse>

pub fn info(&self) -> OperationResult<ShardInfo>

impl EdgeShard

pub fn unpack_snapshot( snapshot_path: &Path, target_path: &Path, ) -> OperationResult<()>

pub fn snapshot_manifest(&self) -> OperationResult<SnapshotManifest>

pub fn recover_partial_snapshot( shard_path: &Path, current_manifest: &SnapshotManifest, snapshot_path: &Path, snapshot_manifest: &SnapshotManifest, ) -> OperationResult<Self>

impl EdgeShard

pub fn update( &self, operation: CollectionUpdateOperations, ) -> OperationResult<()>

impl EdgeShard

pub fn new(path: &Path, config: EdgeConfig) -> OperationResult<Self>

Create a new edge shard at path with the given configuration.

Fails if the shard already exists (i.e. the segments directory contains any segment). Configuration is required and is persisted to edge_config.json. WAL behavior follows config.wal_options (defaults to 32 MiB segments when unset).

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

Load an edge shard from existing files at path.

Every tunable parameter resolves through the fallback chain provided → persisted (edge_config.json) → derived from segments → default, so a parameter left unspecified (None) keeps whatever the shard already has, while an explicitly provided value overwrites it and existing segments converge to it through the optimizers. The resolved config is persisted to edge_config.json.

vectors and sparse_vectors define the stored data and cannot be changed here: if provided (non-empty), they are validated for compatibility against the loaded segments; if not, they are taken from the persisted config or the segments themselves.

Fails if no segments exist and no config can be loaded or inferred.

To override WAL options (e.g. for embedded/mobile deployments where the default 32 MiB segment capacity is too large), set EdgeConfig::wal_options on the supplied config.

pub fn config(&self) -> RwLockReadGuard<'_, EdgeConfig>

pub fn path(&self) -> &Path

pub fn set_hnsw_config(&self, hnsw_config: HnswConfig) -> OperationResult<()>

Update global HNSW config and persist. Does not change per-vector HNSW.

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

Update HNSW config for a named vector and persist. Fails if the vector does not exist. Immutable fields (e.g. size, distance) cannot be changed.

pub fn set_optimizers_config( &self, optimizers: EdgeOptimizersConfig, ) -> OperationResult<()>

Update optimizer config and persist.

pub fn flush(&self) -> OperationResult<()>

Persist the WAL and all segments to disk.

Blocks until the WAL and segment locks are free, so a flush issued concurrently with an in-flight update/optimize waits for it and then persists, rather than spuriously failing with a “lock busy” error — the same blocking-lock semantics those operations already use. Still fallible: a genuine WAL/segment flush I/O error is surfaced instead of panicking.

Must not be called while already holding the wal mutex or a segments guard on the same thread — parking_lot locks are non-reentrant and would self-deadlock. No current caller does (the FFI boundary, Drop, the Python bindings, and tests all invoke it without holding those locks).

Trait Implementations

impl Debug for EdgeShard

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

Formats the value using the given formatter.

impl Drop for EdgeShard

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.