Struct SearchParam 

pub struct SearchParam {
    pub term: String,
    pub fields: Vec<String>,
}

Full-text search parameter using PostgreSQL to_tsvector.

When ?search=term is provided and the endpoint declares search: [field1, field2], a WHERE to_tsvector('english', field1 || ' ' || field2) @@ plainto_tsquery('english', $N) clause is appended.

Fields

term: String

The search term from the query string.

fields: Vec<String>

The fields to search across (from endpoint spec search list).

Implementations

impl SearchParam

pub fn new(term: &str, fields: &[String]) -> Option<Self>

Creates a new search parameter if both term and fields are non-empty.

pub fn apply_to_sql( &self, sql: &mut String, has_where: bool, param_offset: usize, ) -> usize

Appends a full-text search WHERE clause to the SQL string.

Uses to_tsvector('english', ...) and plainto_tsquery('english', $N). param_offset is the $N parameter index for the search term. Returns the new parameter offset after appending.

Trait Implementations

impl Clone for SearchParam

fn clone(&self) -> SearchParam

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchParam

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

Formats the value using the given formatter.