Skip to main content

SearchInput

Struct SearchInput 

Source
pub struct SearchInput {
Show 19 fields pub query: Option<String>, pub queries: Vec<String>, pub intent: Option<String>, pub mode: SearchMode, pub fast: bool, pub limit: PositiveCount, pub candidate_limit: PositiveCount, pub path: Option<String>, pub tag: Vec<String>, pub frontmatter: Option<FrontmatterFilter>, pub related: bool, pub depth: u8, pub direction: Direction, pub scope: Vec<String>, pub scope_only: Vec<String>, pub scope_all: bool, pub where_: Vec<WhereClause>, pub since: Option<String>, pub anchors: Option<bool>,
}
Expand description

Search request.

Fields§

§query: Option<String>

Primary query.

§queries: Vec<String>

Batch queries.

§intent: Option<String>

Disambiguating context for expansion, rerank, and chunk selection.

§mode: SearchMode

Search mode.

§fast: bool

Lexical-only search when true.

§limit: PositiveCount

Result limit.

§candidate_limit: PositiveCount

Candidate pool size for RRF/rerank over-fetch.

§path: Option<String>

Optional path scope.

§tag: Vec<String>

Optional tag scope.

§frontmatter: Option<FrontmatterFilter>

Optional frontmatter filter.

§related: bool

Include related notes.

§depth: u8

Related traversal depth.

§direction: Direction

Related traversal direction.

§scope: Vec<String>

Scope names to include (additive).

§scope_only: Vec<String>

Scope names to search exclusively (mutually exclusive with scope).

§scope_all: bool

Include every configured scope, overriding default = false.

§where_: Vec<WhereClause>

Frontmatter --where filters (AND-composed).

§since: Option<String>

Filter results indexed since this timestamp.

§anchors: Option<bool>

Include per-result previewAnchors (BM25 + semantic). Opt-in; adds one extra DB lookup per result so is off by default.

Implementations§

Source§

impl SearchInput

Source

pub fn from_cli_query( query: String, intent: Option<String>, mode: SearchMode, fast: bool, limit: Option<u16>, candidate_limit: Option<u16>, config: Option<&SearchConfig>, ) -> TalonResult<Self>

Builds a CLI search request from validated command arguments.

§Errors

Returns [TalonError::InvalidInput] when limit or candidate_limit is zero.

Source

pub fn from_search_config(config: Option<&SearchConfig>) -> TalonResult<Self>

Builds a search request seeded from configured defaults.

§Errors

Returns [TalonError::InvalidInput] when configured limit or candidate_limit is zero.

Trait Implementations§

Source§

impl Clone for SearchInput

Source§

fn clone(&self) -> SearchInput

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 SearchInput

Source§

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

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

impl Default for SearchInput

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for SearchInput

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for SearchInput

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for SearchInput

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for SearchInput

Source§

impl StructuralPartialEq for SearchInput

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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> 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> Same for T

Source§

type Output = T

Should always be Self
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.
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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,