Skip to main content

Door

Enum Door 

Source
pub enum Door {
    Keys,
    Whole,
    Own,
    Similar,
    Set,
    SimilarSet,
    Fused,
    FusedSimilar,
    FusedLegs,
    FusedLegsSimilar,
}
Expand description

WHICH of a derived index’s RETRIEVE doors a name belongs to — the vocabulary the emitted read surface is spelled from.

Member one family over: a column’s accessors are derived from a column’s name, and these are derived from an ELECTION’s, so the same rule applies to both — the suffix has one home, and a caller names a door rather than spelling retrieve_keys_by_. Every one of them lands on the declaration’s own type, so every one of them can be reached by a field a declaration chose.

Variants§

§

Keys

TIER A — retrieve_keys_by_<field>, or retrieve_keys for the unelected full-text subject.

§

Whole

TIER B — retrieve_by_<field>, or retrieve for that same subject.

§

Own

BY KEY — get_<field>, this entity’s own stored embedding, checked.

§

Similar

BY EXAMPLE — retrieve_similar_by_<field>.

§

Set

SET-SIMILARITY — retrieve_keys_by_<field>_with, the door a list(embedding) election gets.

§

SimilarSet

SET-SIMILARITY BY EXAMPLE — retrieve_similar_by_<field>_with, the by-example door asked with the example’s WHOLE SET.

§

Fused

FUSED — vector_fuse, every route of one modality asked at once. UNELECTED, because the door is the TIER’s rather than any one route’s.

§

FusedSimilar

FUSED BY EXAMPLE — vector_fuse_similar, at the tier’s own key.

§

FusedLegs

FUSED, ONE FANNED SLOT — vector_fuse_by_<field>, every LEG of one election asked at once.

ELECTED where Fused is not, and that is the fractal read one level down: this door is one FIELD’s, its routes being the stores that field is written to rather than the fields a declaration elected.

§

FusedLegsSimilar

FUSED, ONE FANNED SLOT, BY EXAMPLE — vector_fuse_similar_by_<field>.

Implementations§

Source§

impl Door

Source

pub fn name(self, election: &Ident) -> Ident

What this door is called over the election named election.

Source

pub fn pair(election: Option<&Ident>) -> (Ident, Ident)

The TIER PAIR over one subject: an election’s, or the ONE subject a full-text index answers under — which is UNSUFFIXED, because a slot is (field × engine) and is therefore already the answer to which field.

The pair is the only part of this vocabulary with an unelected spelling, and it is written as a PAIR rather than as a per-variant answer for exactly that reason: the four doors below it are minted per election — a by-key read names the column it reads — so a shape that admitted None there would be a partial function with no total caller.

Trait Implementations§

Source§

impl Clone for Door

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 Copy for Door

Source§

impl Debug for Door

Source§

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

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

impl Eq for Door

Source§

impl PartialEq for Door

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 Door

Auto Trait Implementations§

§

impl Freeze for Door

§

impl RefUnwindSafe for Door

§

impl Send for Door

§

impl Sync for Door

§

impl Unpin for Door

§

impl UnsafeUnpin for Door

§

impl UnwindSafe for Door

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.