Skip to main content

EngineBuilder

Struct EngineBuilder 

Source
pub struct EngineBuilder { /* private fields */ }
Expand description

Builder for constructing an Engine with custom configuration.

Use this when you need to specify a custom text analyzer or embedding model. For simple cases with default settings (StandardAnalyzer, no embedder), use Engine::new directly.

§Example

use std::sync::Arc;

let schema = Schema::builder()
    .add_field("content", FieldOption::Text(TextOption::default()))
    .add_field("content_vec", FieldOption::Flat(FlatOption { dimension: 384, ..Default::default() }))
    .build();

let engine = Engine::builder(storage, schema)
    .analyzer(Arc::new(StandardAnalyzer::default()))
    .embedder(Arc::new(MyEmbedder))
    .build()
    .await?;

Implementations§

Source§

impl EngineBuilder

Source

pub fn new(storage: Arc<dyn Storage>, schema: Schema) -> Self

Create a new builder with the given storage and schema.

Source

pub fn analyzer(self, analyzer: Arc<dyn Analyzer>) -> Self

Set the analyzer for text fields.

Both simple analyzers (e.g., StandardAnalyzer) and PerFieldAnalyzer are supported. When a PerFieldAnalyzer is passed, it is used directly (with _id automatically set to KeywordAnalyzer if not already configured).

If not set, StandardAnalyzer is used as the default.

Source

pub fn embedder(self, embedder: Arc<dyn Embedder>) -> Self

Set the embedder for vector fields.

Both simple embedders and PerFieldEmbedder are supported. When a PerFieldEmbedder is passed, each vector field will use the embedder registered for that field name, falling back to the default.

If not set, no embedder is configured.

Source

pub async fn build(self) -> Result<Engine>

Build the Engine.

Creates the lexical store, vector store, and document log (WAL), then runs WAL recovery to replay any uncommitted changes from a previous session.

§Errors

Returns an error if storage initialization, index creation, WAL opening, or recovery replay fails.

Auto Trait Implementations§

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
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> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
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.