IndexDocuments

Struct IndexDocuments 

Source
pub struct IndexDocuments<'t, 'i, 'a, FP, FA> { /* private fields */ }

Implementations§

Source§

impl<'t, 'i, 'a, FP, FA> IndexDocuments<'t, 'i, 'a, FP, FA>
where FP: Fn(UpdateIndexingStep) + Sync + Send, FA: Fn() -> bool + Sync + Send,

Source

pub fn new( wtxn: &'t mut RwTxn<'i>, index: &'i Index, indexer_config: &'a IndexerConfig, config: IndexDocumentsConfig, progress: FP, should_abort: FA, ) -> Result<IndexDocuments<'t, 'i, 'a, FP, FA>>

Source

pub fn add_documents<R: Read + Seek>( self, reader: DocumentsBatchReader<R>, ) -> Result<(Self, StdResult<u64, UserError>)>

Adds a batch of documents to the current builder.

Since the documents are progressively added to the writer, a failure will cause only return an error and not the IndexDocuments struct as it is invalid to use it afterward.

Returns the number of documents added to the builder.

Source

pub fn with_embedders(self, embedders: EmbeddingConfigs) -> Self

Source

pub fn execute(self) -> Result<DocumentAdditionResult>

Source

pub fn execute_raw(self, output: TransformOutput) -> Result<u64>
where FP: Fn(UpdateIndexingStep) + Sync, FA: Fn() -> bool + Sync,

Returns the total number of documents in the index after the update.

Source

pub fn execute_prefix_databases( self, word_docids: Option<Merger<CursorClonableMmap, MergeDeladdCboRoaringBitmaps>>, exact_word_docids: Option<Merger<CursorClonableMmap, MergeDeladdCboRoaringBitmaps>>, word_position_docids: Option<Merger<CursorClonableMmap, MergeDeladdCboRoaringBitmaps>>, word_fid_docids: Option<Merger<CursorClonableMmap, MergeDeladdCboRoaringBitmaps>>, ) -> Result<()>
where FP: Fn(UpdateIndexingStep) + Sync, FA: Fn() -> bool + Sync,

Auto Trait Implementations§

§

impl<'t, 'i, 'a, FP, FA> Freeze for IndexDocuments<'t, 'i, 'a, FP, FA>
where FP: Freeze, FA: Freeze,

§

impl<'t, 'i, 'a, FP, FA> !RefUnwindSafe for IndexDocuments<'t, 'i, 'a, FP, FA>

§

impl<'t, 'i, 'a, FP, FA> Send for IndexDocuments<'t, 'i, 'a, FP, FA>
where FP: Send, FA: Send,

§

impl<'t, 'i, 'a, FP, FA> !Sync for IndexDocuments<'t, 'i, 'a, FP, FA>

§

impl<'t, 'i, 'a, FP, FA> Unpin for IndexDocuments<'t, 'i, 'a, FP, FA>
where FP: Unpin, FA: Unpin,

§

impl<'t, 'i, 'a, FP, FA> !UnwindSafe for IndexDocuments<'t, 'i, 'a, FP, FA>

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Any for T
where T: Any,

Source§

impl<T> ErasedDestructor for T
where T: 'static,