Struct QuerySuggestion 

#[non_exhaustive]
pub struct QuerySuggestion {
    pub suggestion: String,
    pub completable_field_paths: Vec<String>,
    /* private fields */
}

Available on crate feature completion-service only.

Suggestions as search queries.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

suggestion: String

The suggestion for the query.

completable_field_paths: Vec<String>

The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.

This field is only populated for the document-completable model.

Implementations

impl QuerySuggestion

pub fn new() -> Self

pub fn set_suggestion<T: Into<String>>(self, v: T) -> Self

Sets the value of suggestion.

Example

let x = QuerySuggestion::new().set_suggestion("example");

pub fn set_completable_field_paths<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of completable_field_paths.

Example

let x = QuerySuggestion::new().set_completable_field_paths(["a", "b", "c"]);

Trait Implementations

impl Clone for QuerySuggestion

fn clone(&self) -> QuerySuggestion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QuerySuggestion

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

Formats the value using the given formatter.

impl Default for QuerySuggestion

fn default() -> QuerySuggestion

Returns the “default value” for a type.

impl Message for QuerySuggestion

fn typename() -> &'static str

The typename of this message.

impl PartialEq for QuerySuggestion

fn eq(&self, other: &QuerySuggestion) -> 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 QuerySuggestion