Struct Search

Source
pub struct Search<'a> { /* private fields */ }

Implementations§

Source§

impl Search<'_>

Source

pub fn execute_hybrid( &self, semantic_ratio: f32, ) -> Result<(SearchResult, Option<u32>)>

Source§

impl<'a> Search<'a>

Source

pub fn new(rtxn: &'a RoTxn<'a>, index: &'a Index) -> Search<'a>

Source

pub fn query(&mut self, query: impl Into<String>) -> &mut Search<'a>

Source

pub fn semantic( &mut self, embedder_name: String, embedder: Arc<Embedder>, quantized: bool, vector: Option<Vec<f32>>, ) -> &mut Search<'a>

Source

pub fn offset(&mut self, offset: usize) -> &mut Search<'a>

Source

pub fn limit(&mut self, limit: usize) -> &mut Search<'a>

Source

pub fn sort_criteria(&mut self, criteria: Vec<AscDesc>) -> &mut Search<'a>

Source

pub fn distinct(&mut self, distinct: String) -> &mut Search<'a>

Source

pub fn searchable_attributes( &mut self, searchable: &'a [String], ) -> &mut Search<'a>

Source

pub fn terms_matching_strategy( &mut self, value: TermsMatchingStrategy, ) -> &mut Search<'a>

Source

pub fn scoring_strategy(&mut self, value: ScoringStrategy) -> &mut Search<'a>

Source

pub fn words_limit(&mut self, value: usize) -> &mut Search<'a>

Source

pub fn filter(&mut self, condition: Filter<'a>) -> &mut Search<'a>

Source

pub fn exhaustive_number_hits( &mut self, exhaustive_number_hits: bool, ) -> &mut Search<'a>

Forces the search to exhaustively compute the number of candidates, this will increase the search time but allows finite pagination.

Source

pub fn time_budget(&mut self, time_budget: TimeBudget) -> &mut Search<'a>

Source

pub fn ranking_score_threshold( &mut self, ranking_score_threshold: f64, ) -> &mut Search<'a>

Source

pub fn locales(&mut self, locales: Vec<Language>) -> &mut Search<'a>

Source

pub fn execute_for_candidates( &self, has_vector_search: bool, ) -> Result<RoaringBitmap>

Source

pub fn execute(&self) -> Result<SearchResult>

Trait Implementations§

Source§

impl Debug for Search<'_>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Search<'a>

§

impl<'a> !RefUnwindSafe for Search<'a>

§

impl<'a> !Send for Search<'a>

§

impl<'a> !Sync for Search<'a>

§

impl<'a> Unpin for Search<'a>

§

impl<'a> !UnwindSafe for Search<'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> 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, 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
Source§

impl<T> Any for T
where T: Any,

Source§

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

Source§

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