Skip to main content

SearchFilter

Struct SearchFilter 

Source
pub struct SearchFilter {
    pub languages: Option<Vec<Language>>,
    pub chunk_types: Option<Vec<ChunkType>>,
    pub path_pattern: Option<String>,
    pub name_boost: f32,
    pub query_text: String,
    pub enable_rrf: bool,
    pub note_weight: f32,
    pub note_only: bool,
}
Expand description

Filter and scoring options for search. Filter and scoring options for search.

Fields are public for direct construction via struct literals. Builder methods (SearchFilter::new(), SearchFilter::with_query()) are provided as convenience helpers for common patterns — both styles are supported and equivalent.

All fields are optional. Unset filters match all chunks. Use SearchFilter::validate() to check constraints before searching.

Fields§

§languages: Option<Vec<Language>>

Filter by programming language(s)

§chunk_types: Option<Vec<ChunkType>>

Filter by chunk type(s) (function, method, class, struct, enum, trait, interface, constant)

§path_pattern: Option<String>

Filter by file path glob pattern (e.g., src/**/*.rs)

§name_boost: f32

Weight for name matching in hybrid search (0.0-1.0)

0.0 = pure embedding similarity (default) 1.0 = pure name matching 0.2 = recommended for balanced results

§query_text: String

Query text for name matching (required if name_boost > 0 or enable_rrf)

§enable_rrf: bool

Enable RRF (Reciprocal Rank Fusion) hybrid search

When enabled, combines semantic search results with FTS5 keyword search using the formula: score = Σ 1/(k + rank), where k=60. This typically improves recall for identifier-heavy queries.

§note_weight: f32

Weight multiplier for note scores in unified search (0.0-1.0)

1.0 = notes scored equally with code (default) 0.5 = notes scored at half weight 0.0 = notes excluded from results

§note_only: bool

When true, return only notes (skip code search entirely)

Implementations§

Source§

impl SearchFilter

Source

pub fn new() -> Self

Create a new SearchFilter with default values.

Use struct literal syntax to customize:

let filter = SearchFilter {
    languages: Some(vec![Language::Rust]),
    path_pattern: Some("src/**/*.rs".to_string()),
    query_text: "retry logic".to_string(),
    ..SearchFilter::new()
};
Source

pub fn with_query(self, query: impl Into<String>) -> Self

Set the query text (required for name_boost > 0 or enable_rrf).

Source

pub fn validate(&self) -> Result<(), &'static str>

Validate filter constraints

Returns Ok(()) if valid, or Err with description of what’s wrong.

Trait Implementations§

Source§

impl Default for SearchFilter

Source§

fn default() -> Self

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

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> 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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, 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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