Update

Struct Update 

Source
pub struct Update<'doc> { /* private fields */ }

Implementations§

Source§

impl<'doc> Update<'doc>

Source

pub fn create( docid: DocumentId, external_document_id: &'doc str, new: Versions<'doc>, from_scratch: bool, ) -> Self

Source

pub fn docid(&self) -> DocumentId

Source

pub fn external_document_id(&self) -> &'doc str

Source

pub fn current<'a, Mapper: FieldIdMapper>( &self, rtxn: &'a RoTxn<'_>, index: &'a Index, mapper: &'a Mapper, ) -> Result<DocumentFromDb<'a, Mapper>>

Source

pub fn current_vectors<'a, Mapper: FieldIdMapper>( &self, rtxn: &'a RoTxn<'_>, index: &'a Index, mapper: &'a Mapper, doc_alloc: &'a Bump, ) -> Result<VectorDocumentFromDb<'a>>

Source

pub fn only_changed_fields(&self) -> DocumentFromVersions<'_, 'doc>

Source

pub fn merged<'t, Mapper: FieldIdMapper>( &self, rtxn: &'t RoTxn<'_>, index: &'t Index, mapper: &'t Mapper, ) -> Result<MergedDocument<'_, 'doc, 't, Mapper>>

Source

pub fn has_changed_for_fields<'t, Mapper: FieldIdMapper>( &self, selector: &mut impl FnMut(&str) -> PatternMatch, rtxn: &'t RoTxn<'_>, index: &'t Index, mapper: &'t Mapper, ) -> Result<bool>

Returns whether the updated version of the document is different from the current version for the subset of fields selected by selector.

true if at least one top-level-field that is exactly a selected field or a parent of a selected field changed. Otherwise false.

  • Note: _geo and _vectors are not taken into account by this function.
Source

pub fn has_changed_for_geo_fields<'t, Mapper: FieldIdMapper>( &self, rtxn: &'t RoTxn<'_>, index: &'t Index, mapper: &'t Mapper, ) -> Result<bool>

Returns true if the geo fields have changed.

Source

pub fn only_changed_vectors( &self, doc_alloc: &'doc Bump, embedders: &'doc EmbeddingConfigs, ) -> Result<Option<VectorDocumentFromVersions<'doc>>>

Source

pub fn merged_vectors<Mapper: FieldIdMapper>( &self, rtxn: &'doc RoTxn<'_>, index: &'doc Index, mapper: &'doc Mapper, doc_alloc: &'doc Bump, embedders: &'doc EmbeddingConfigs, ) -> Result<Option<MergedVectorDocument<'doc>>>

Auto Trait Implementations§

§

impl<'doc> Freeze for Update<'doc>

§

impl<'doc> !RefUnwindSafe for Update<'doc>

§

impl<'doc> !Send for Update<'doc>

§

impl<'doc> !Sync for Update<'doc>

§

impl<'doc> Unpin for Update<'doc>

§

impl<'doc> !UnwindSafe for Update<'doc>

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,