Struct TextQuery 

pub struct TextQuery { /* private fields */ }

Full-text query.

Implementations

impl TextQuery

pub fn new(text: impl Into<String>) -> Self

Creates a full-text query.

pub fn for_field(self, text_field_name: impl Into<String>) -> Self

Restricts the query to a specific text field.

pub fn with_filter(self, filter_expression: FilterExpression) -> Self

Attaches a filter expression to combine with the text search.

pub fn set_filter(&mut self, filter_expression: FilterExpression)

Replaces the filter expression in place.

pub fn with_return_score(self, return_score: bool) -> Self

Sets whether to return scores (default: true).

pub fn with_return_fields<I, S>(self, return_fields: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Replaces the return field list.

pub fn paging(self, offset: usize, num: usize) -> Self

Updates the query limit.

pub fn sort_by(self, field: impl Into<String>, direction: SortDirection) -> Self

Sets the sort field and direction.

pub fn in_order(self, in_order: bool) -> Self

Enables or disables INORDER.

pub fn with_dialect(self, dialect: u32) -> Self

Sets the query dialect.

pub fn with_scorer(self, scorer: impl Into<String>) -> Self

Sets the scorer name.

pub fn with_stopwords(self, stopwords: HashSet<String>) -> Self

Sets stopwords to filter from the query text.

Words in the set are removed (case-insensitive) from the query before it is sent to Redis. This mirrors the Python stopwords parameter.

pub fn with_text_weights(self, weights: HashMap<String, f32>) -> Self

Sets word weights for the text search.

Weighted words appear in the Redis query as word=>{weight} syntax, mirroring the Python text_weights parameter.

pub fn set_text_weights(&mut self, weights: HashMap<String, f32>)

Updates text weights after construction (mirrors Python set_text_weights).

pub fn text_weights(&self) -> Option<&HashMap<String, f32>>

Returns the current text weights, if any.

Trait Implementations

impl Clone for TextQuery

fn clone(&self) -> TextQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextQuery

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

Formats the value using the given formatter.

impl PageableQuery for TextQuery

fn paged(&self, offset: usize, num: usize) -> Self

Returns a cloned query with an updated LIMIT clause.

impl QueryString for TextQuery

fn to_redis_query(&self) -> String

Builds a Redis Search query string.

fn return_fields(&self) -> Vec<String>

Return fields requested by the query.

fn sort_by(&self) -> Option<SortBy>

Sort order requested by the query.

fn limit(&self) -> Option<QueryLimit>

Limit clause requested by the query.

fn dialect(&self) -> u32

Query dialect.

fn in_order(&self) -> bool

Whether the query should use INORDER.

fn scorer(&self) -> Option<String>

Optional scorer.

fn render(&self) -> QueryRender

Builds the full query render, including search options and params.

fn params(&self) -> Vec<QueryParam>

Query parameters used with Redis PARAMS.

fn no_content(&self) -> bool

Whether the query should use NOCONTENT.

fn kind(&self) -> QueryKind

The processed result shape for this query.

fn should_unpack_json(&self) -> bool

Whether JSON search results should be unpacked into top-level fields when no explicit projection is requested.

fn geofilter(&self) -> Option<GeoFilter>

Optional geo-spatial filter for FT.SEARCH GEOFILTER clause.