Struct FullTextSearchQuery

pub struct FullTextSearchQuery {
    pub query: FtsQuery,
    pub limit: Option<i64>,
    pub wand_factor: Option<f32>,
}

A full text search query

Fields

query: FtsQuery

limit: Option<i64>

The maximum number of results to return

wand_factor: Option<f32>

The wand factor to use for ranking if None, use the default value of 1.0 Increasing this value will reduce the recall and improve the performance 1.0 is the value that would give the best performance without recall loss

Implementations

impl FullTextSearchQuery

pub fn new(query: String) -> Self

Create a new terms query

pub fn new_fuzzy(term: String, max_distance: Option<u32>) -> Self

Create a new fuzzy query

pub fn new_query(query: FtsQuery) -> Self

Create a new compound query

pub fn with_column(self, column: String) -> Result<Self>

Set the column to search over This is available for only MatchQuery and PhraseQuery

pub fn with_columns(self, columns: &[String]) -> Result<Self>

Set the column to search over This is available for only MatchQuery

pub fn limit(self, limit: Option<i64>) -> Self

limit the number of results to return if None, return all results

pub fn wand_factor(self, wand_factor: Option<f32>) -> Self

pub fn columns(&self) -> HashSet<String>

pub fn params(&self) -> FtsSearchParams

Trait Implementations

impl Clone for FullTextSearchQuery

fn clone(&self) -> FullTextSearchQuery

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FullTextSearchQuery

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

Formats the value using the given formatter.

impl PartialEq for FullTextSearchQuery

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for FullTextSearchQuery