Struct SearchQuery 

pub struct SearchQuery { /* private fields */ }

A builder for HAL search queries.

It maps directly onto the Solr query parameters used by the HAL API and covers every search mode listed in the HAL documentation:

• basic search — SearchQuery::basic;
• search within a field — SearchQuery::field / SearchQuery::in_field;
• several terms within a field — SearchQuery::field_terms (OR) / SearchQuery::field_all_terms (AND);
• proximity search — SearchQuery::proximity;
• field selection (fl) — SearchQuery::fields;
• pagination — SearchQuery::rows / SearchQuery::start / SearchQuery::page;
• facets — SearchQuery::facet.

The builder methods consume and return self, so they can be chained.

Implementations

impl SearchQuery

pub fn basic(query: impl Into<String>) -> Self

A basic search over all fields (the q parameter is used as-is).

This is the exact behaviour of the original chapter-16 library.

pub fn field(field: &str, value: &str) -> Self

Search for a value within a specific field, e.g. field("title_t", "europe") produces q=title_t:europe.

pub fn in_field(field: Field, value: &str) -> Self

Fine-grained search scoped to a typed Field.

A multi-word value is grouped so that every word is searched within the field, e.g. in_field(Field::Title, "open science") produces q=title_t:(open science). An empty value falls back to a basic search.

pub fn field_terms<I, S>(field: &str, terms: I) -> Self

where I: IntoIterator<Item = S>, S: AsRef<str>,

Search for several terms within a single field, matching any of them (Solr OR), e.g. field_terms("title_t", ["economic", "policy"]) produces q=title_t:(economic policy).

pub fn field_all_terms<I, S>(field: &str, terms: I) -> Self

where I: IntoIterator<Item = S>, S: AsRef<str>,

Search for several terms within a single field, matching all of them (Solr AND), e.g. field_all_terms("title_t", ["economic", "policy"]) produces q=title_t:(economic AND policy).

pub fn proximity(field: &str, phrase: &str, distance: u32) -> Self

Proximity search: find phrase within distance words inside field, e.g. proximity("title_t", "economic policy", 3) produces q=title_t:"economic policy"~3.

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

where I: IntoIterator<Item = S>, S: AsRef<str>,

Restrict the returned fields (the Solr fl parameter).

pub fn rows(self, rows: u32) -> Self

Set the number of rows (documents) to return.

pub fn start(self, start: u32) -> Self

Set the offset of the first returned document.

pub fn page(self, page: u32, per_page: u32) -> Self

Convenience pagination: page page (0-based) with per_page results each.

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

Set the sort clause (the Solr sort parameter), e.g. "producedDate_s desc".

pub fn facet(self, field: impl Into<String>) -> Self

Add a facet field. Calling this at least once enables faceting.

pub fn to_params(&self) -> Vec<(String, String)>

Serialise the query into HAL/Solr URL parameters.

The output type is compatible with reqwest’s .query(..).

Trait Implementations

impl Clone for SearchQuery

fn clone(&self) -> SearchQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchQuery

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

Formats the value using the given formatter.