Skip to main content

IndexedDocument

Struct IndexedDocument 

Source
#[non_exhaustive]
pub struct IndexedDocument<'a> { pub doc: &'a Document, pub index: &'a DocIndex, }
Expand description

A document and the index over it, bundled so they cannot be mismatched.

The pairing is the guarantee. DocIndex::view is the only constructor: it brings the index up to date against the very document it then bundles, so consulting an index built from a different document — the one hazard a derived index has, and the same mistake class as reading the wrong document directly — is unrepresentable rather than merely discouraged. Coherence beyond that is structural: documents are immutable values, so a matched index cannot drift.

The refresh is gated on the document’s stamp, so re-viewing a document nothing has folded into costs one comparison; a rebuild happens only where a new document value does.

A pair of shared references, so the view copies freely — the pairing constructor is still the only way to make one.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§doc: &'a Document§index: &'a DocIndex

Trait Implementations§

Source§

impl<'a> Clone for IndexedDocument<'a>

Source§

fn clone(&self) -> IndexedDocument<'a>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for IndexedDocument<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for IndexedDocument<'a>

§

impl<'a> RefUnwindSafe for IndexedDocument<'a>

§

impl<'a> Send for IndexedDocument<'a>

§

impl<'a> Sync for IndexedDocument<'a>

§

impl<'a> Unpin for IndexedDocument<'a>

§

impl<'a> UnsafeUnpin for IndexedDocument<'a>

§

impl<'a> UnwindSafe for IndexedDocument<'a>

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 = 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.