Struct Writer 

pub struct Writer<D: Distance> { /* private fields */ }

A writer to store new items, remove existing ones, and build the search index to query the nearest neighbors to items or vectors.

Implementations

impl<D: Distance> Writer<D>

pub fn new(database: Database<D>, index: u16, dimensions: usize) -> Writer<D>

Creates a new writer from a database, index and dimensions.

pub fn prepare_changing_distance<ND: Distance>( self, wtxn: &mut RwTxn<'_>, ) -> Result<Writer<ND>>

Returns a writer after having deleted the tree nodes and rewrote all the items for the new Distance format to be able to modify items safely.

pub fn set_tmpdir(&mut self, path: impl Into<PathBuf>)

Sets the path to the temporary directory where files are written.

pub fn is_empty(&self, rtxn: &RoTxn<'_>) -> Result<bool>

Returns true if the index is empty.

pub fn need_build(&self, rtxn: &RoTxn<'_>) -> Result<bool>

Returns true if the index needs to be built before being able to read in it.

pub fn item_vector( &self, rtxn: &RoTxn<'_>, item: ItemId, ) -> Result<Option<Vec<f32>>>

Returns an Optional vector previous stored in this database.

pub fn contains_item(&self, rtxn: &RoTxn<'_>, item: ItemId) -> Result<bool>

Returns true if the database contains the given item.

pub fn iter<'t>(&self, rtxn: &'t RoTxn<'_>) -> Result<ItemIter<'t, D>>

Returns an iterator over the items vector.

pub fn add_item( &self, wtxn: &mut RwTxn<'_>, item: ItemId, vector: &[f32], ) -> Result<()>

Add an item associated to a vector in the database.

pub fn del_item(&self, wtxn: &mut RwTxn<'_>, item: ItemId) -> Result<bool>

Deletes an item stored in this database and returns true if it existed.

pub fn clear(&self, wtxn: &mut RwTxn<'_>) -> Result<()>

Removes everything in the database, user items and internal graph links.

pub fn builder<'a, R>( &'a self, rng: &'a mut R, ) -> HannoyBuilder<'a, D, R, NoProgress>

where R: Rng + SeedableRng,

Returns an HannoyBuilder to configure the available options to build the database.

Trait Implementations

impl<D: Debug + Distance> Debug for Writer<D>

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

Formats the value using the given formatter.