Skip to main content

SearchCommand

Struct SearchCommand

pub struct SearchCommand {
    pub target: SearchTarget,
    pub term: Scalar,
    pub with_type: Option<Scalar>,
    pub with_predicate: Option<Scalar>,
    pub mode: Option<Scalar>,
    pub threshold: Option<Scalar>,
    pub as_of_seq: Option<Scalar>,
    pub limit: Option<Scalar>,
    pub cursor: Option<Scalar>,
}

Expand description

SEARCH ...

Grounding only: a SEARCH score is not confidence, and a miss is not absence. The golden path is SEARCH → exact id → BELIEF/FIND.

Fields§

§target: SearchTarget

What kind of element is searched.

§term: Scalar

The search term.

§with_type: Option<Scalar>

WITH TYPE ...

§with_predicate: Option<Scalar>

WITH PREDICATE ...

§mode: Option<Scalar>

MODE "keyword" | "semantic" | "hybrid"

§threshold: Option<Scalar>

THRESHOLD ...

§as_of_seq: Option<Scalar>

Historical index basis, AS OF SEQ.

§limit: Option<Scalar>

The page size.

§cursor: Option<Scalar>

The page cursor.

Trait Implementations§

impl Clone for SearchCommand

fn clone(&self) -> SearchCommand

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

impl Debug for SearchCommand

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for SearchCommand

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for SearchCommand

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl Serialize for SearchCommand

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for SearchCommand

Auto Trait Implementations§

impl Freeze for SearchCommand

impl RefUnwindSafe for SearchCommand

impl Send for SearchCommand

impl Sync for SearchCommand

impl Unpin for SearchCommand

impl UnsafeUnpin for SearchCommand

impl UnwindSafe for SearchCommand

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.