Struct aws_sdk_cloudsearchdomain::types::SuggestModel

#[non_exhaustive]
pub struct SuggestModel {
    pub query: Option<String>,
    pub found: i64,
    pub suggestions: Option<Vec<SuggestionMatch>>,
}

Container for the suggestion information returned in a SuggestResponse.

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.

query: Option<String>

The query string specified in the suggest request.

found: i64

The number of documents that were found to match the query string.

suggestions: Option<Vec<SuggestionMatch>>

The documents that match the query string.

Implementations

impl SuggestModel

pub fn query(&self) -> Option<&str>

The query string specified in the suggest request.

pub fn found(&self) -> i64

The number of documents that were found to match the query string.

pub fn suggestions(&self) -> &[SuggestionMatch]

The documents that match the query string.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .suggestions.is_none().

impl SuggestModel

pub fn builder() -> SuggestModelBuilder

Creates a new builder-style object to manufacture SuggestModel.

Trait Implementations

impl Clone for SuggestModel

fn clone(&self) -> SuggestModel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SuggestModel

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

Formats the value using the given formatter.

impl PartialEq for SuggestModel

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