Struct Arms 

pub struct Arms { /* private fields */ }

The main ARMS engine

Orchestrates storage and indexing with a unified API.

Implementations

impl Arms

pub fn new(config: ArmsConfig) -> Self

Create a new ARMS instance with default adapters

Uses MemoryStorage and FlatIndex. For production, use Arms::with_adapters with appropriate backends.

pub fn with_adapters( config: ArmsConfig, storage: Box<dyn Place>, index: Box<dyn Near>, ) -> Self

Create with custom adapters

pub fn config(&self) -> &ArmsConfig

Get the configuration

pub fn dimensionality(&self) -> usize

Get the dimensionality of this space

pub fn place(&mut self, point: Point, blob: Blob) -> PlaceResult<Id>

Place a point in the space

The point will be normalized if configured to do so. Returns the assigned ID.

pub fn place_batch(&mut self, items: Vec<(Point, Blob)>) -> Vec<PlaceResult<Id>>

Place multiple points at once

pub fn remove(&mut self, id: Id) -> Option<PlacedPoint>

Remove a point from the space

pub fn get(&self, id: Id) -> Option<&PlacedPoint>

Get a point by ID

pub fn contains(&self, id: Id) -> bool

Check if a point exists

pub fn len(&self) -> usize

Get the number of stored points

pub fn is_empty(&self) -> bool

Check if the space is empty

pub fn clear(&mut self)

Clear all points

pub fn near(&self, query: &Point, k: usize) -> NearResult<Vec<SearchResult>>

Find k nearest points to query

pub fn within( &self, query: &Point, threshold: f32, ) -> NearResult<Vec<SearchResult>>

Find all points within threshold

pub fn near_with_data( &self, query: &Point, k: usize, ) -> NearResult<Vec<(&PlacedPoint, f32)>>

Find and retrieve k nearest points (with full data)

pub fn merge(&self, points: &[Point]) -> Point

Merge multiple points into one using the configured merge function

pub fn proximity(&self, a: &Point, b: &Point) -> f32

Compute proximity between two points

pub fn size_bytes(&self) -> usize

Get storage size in bytes

pub fn index_len(&self) -> usize

Get index stats

pub fn is_ready(&self) -> bool

Check if index is ready