Struct WritableDatabase 

pub struct WritableDatabase(/* private fields */);

A Xapian database that can be read or written to

Implementations

impl WritableDatabase

pub fn open( path: impl AsRef<Path>, action: impl Into<Option<DbAction>>, backend: impl Into<Option<DbBackend>>, flags: impl Into<Option<DbFlags>>, block_size: impl Into<Option<i32>>, ) -> Self

Open a database for updates

Automatically selects the appropriate backend to use

pub fn inmemory() -> Self

Create a new, in-memory WritableDatabase

pub fn add_database(&mut self, db: impl AsRef<WritableDatabase>)

Add shards from another WritableDatabase

pub fn add_document(&mut self, doc: impl AsRef<Document>) -> DocId

Add a new document to the database

pub fn add_spelling( &self, word: impl AsRef<str>, increment: impl Into<Option<u32>>, )

Add a word to the spelling dictionary

pub fn add_synonym(&self, term: impl AsRef<str>, synonym: impl AsRef<str>)

Add a synonym for a term

pub fn begin_transaction(&mut self, flushed: impl Into<Option<bool>>)

Begin a transaction

pub fn cancel_transaction(&mut self)

Abort the transaction currently in progress

pub fn commit_transaction(&mut self)

Complete the transaction currently in progress

pub fn close(&mut self)

Close the database

pub fn commit(&mut self)

Commit any pending modifications made to the database

pub fn delete_document(&mut self, id: impl Into<DocId>)

Delete the document (if any) matching the specified DocId from the database

pub fn delete_document_by_term(&mut self, term: impl AsRef<str>)

Delete any documents indexed by the specified term from the database

pub fn doc_count(&self) -> u32

Get the number of documents in the database

pub fn metadata(&self, key: impl AsRef<str>) -> Bytes

Get the user-specified metadata associated with a given key

pub fn read_only(&self) -> Database

Retrieve a read-only Database instance backed by this WritableDatabase

pub fn remove_spelling( &self, word: impl AsRef<str>, decrement: impl Into<Option<u32>>, )

Remove a word from the spelling dictionary

pub fn remove_synonym(&self, term: impl AsRef<str>, synonym: impl AsRef<str>)

Remove the given synonym for the specified term

pub fn replace_document( &mut self, id: impl Into<DocId>, doc: impl AsRef<Document>, )

Replace the document (if any) matching the specified DocId from the database with the specified doc

pub fn replace_document_by_term( &mut self, term: impl AsRef<str>, doc: impl AsRef<Document>, ) -> u32

Replace any documents matching the given term

pub fn transaction( &mut self, flushed: impl Into<Option<bool>>, f: impl FnMut(&mut WritableDatabase), )

Wrap the function specified in f in a transaction

Trait Implementations

impl Default for WritableDatabase

fn default() -> Self

Open a new, in-memory WritableDatabase

impl From<&WritableDatabase> for Database

fn from(value: &WritableDatabase) -> Self

Converts to this type from the input type.

impl From<WritableDatabase> for Database

fn from(value: WritableDatabase) -> Self

Converts to this type from the input type.