Skip to main content

IngestDocument

Struct IngestDocument 

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

One owned vector mutation supplied to an ingest batch.

Implementations§

Source§

impl IngestDocument

Source

pub fn new(version: DocumentVersion, vector: Vec<f32>) -> Self

Constructs one document upsert.

Source

pub const fn with_timestamp(self, timestamp: i64) -> Self

Assigns the canonical ts clustering-key value.

Source

pub fn with_metadata(self, metadata: Vec<u8>) -> Self

Assigns opaque stored metadata that must remain physically purgeable.

Source

pub fn with_text(self, text: impl Into<String>) -> Self

Assigns the UTF-8 body indexed by the store’s frozen text analyzer.

Source

pub fn with_columns(self, columns: Vec<(ColumnId, PredicateValue)>) -> Self

Assigns typed user-column values keyed by the store schema.

Source

pub const fn with_expected_revision(self, expected: ExpectedRevision) -> Self

Makes the whole batch conditional on this document’s live revision. The condition is not persisted.

Source

pub const fn expected_revision(&self) -> Option<ExpectedRevision>

Returns the live-revision precondition, if any.

Source

pub const fn version(&self) -> DocumentVersion

Returns the document/revision idempotency key.

Source

pub fn vector(&self) -> &[f32]

Returns the full-precision vector retained for future sealing.

Source

pub const fn timestamp(&self) -> i64

Returns the canonical ts clustering-key value.

Source

pub fn metadata(&self) -> &[u8] ⓘ

Returns the opaque stored metadata bytes.

Source

pub fn text(&self) -> Option<&str>

Returns the optional UTF-8 body indexed by lexical search.

Source

pub fn columns(&self) -> &[(ColumnId, PredicateValue)]

Returns the typed schema-column values in caller order.

Trait Implementations§

Source§

impl Clone for IngestDocument

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for IngestDocument

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for IngestDocument

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for IngestDocument

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> 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.