Skip to main content

LexaDb

Struct LexaDb 

Source
pub struct LexaDb { /* private fields */ }

Implementations§

Source§

impl LexaDb

Source

pub fn open( path: impl AsRef<Path>, embedding_config: EmbeddingConfig, ) -> Result<Self>

Source

pub fn path(&self) -> &Path

Source

pub fn embedder(&self) -> Result<&Mutex<Embedder>>

Source

pub fn reranker(&self) -> Result<&Mutex<Reranker>>

Source

pub fn index_path(&mut self, path: impl AsRef<Path>) -> Result<usize>

Source

pub fn index_path_with_preprocessor<P>( &mut self, path: impl AsRef<Path>, preprocessor: Option<&dyn Preprocessor<Payload = P>>, commit_sidecar: impl Fn(&Transaction<'_>, i64, &P) -> Result<()>, ) -> Result<usize>
where P: Default,

Index a path with a per-file preprocessor and sidecar commit hook.

preprocessor is invoked for every supported file before chunking; it receives the raw bytes and may return Some(PreprocessedDoc) to substitute the text used for chunking (e.g. strip Obsidian frontmatter so it doesn’t leak into the embedding) along with a caller-defined payload of metadata. Returning None skips the file. Returning the unmodified text + Default::default() payload matches the plain index_path behaviour.

commit_sidecar runs inside the same transaction as the chunk inserts, so the caller’s sidecar tables (e.g. note_metadata, note_links, note_tags) stay consistent with documents even on crash.

Source

pub fn purge_path(&mut self, path: impl AsRef<Path>) -> Result<usize>

Source

pub fn search(&self, options: &SearchOptions) -> Result<Vec<SearchHit>>

Source

pub fn conn(&self) -> &Connection

Borrow the underlying SQLite connection. Useful for crates that extend the schema (e.g. lexa-obsidian adds note_metadata, note_links, note_tags, note_blocks sidecar tables) and need to run their own SQL on the same connection rather than opening a second one (which would lock the WAL).

Source

pub fn list_documents(&self) -> Result<Vec<Document>>

Source

pub fn stats(&self) -> Result<IndexStats>

Auto Trait Implementations§

§

impl !Freeze for LexaDb

§

impl !RefUnwindSafe for LexaDb

§

impl Send for LexaDb

§

impl !Sync for LexaDb

§

impl Unpin for LexaDb

§

impl UnsafeUnpin for LexaDb

§

impl !UnwindSafe for LexaDb

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V