Struct FacetResult 

#[non_exhaustive]
pub struct FacetResult {
    pub document_attribute_key: Option<String>,
    pub document_attribute_value_type: Option<DocumentAttributeValueType>,
    pub document_attribute_value_count_pairs: Option<Vec<DocumentAttributeValueCountPair>>,
}

The facet values for the documents in the response.

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.

document_attribute_key: Option<String>

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

document_attribute_value_type: Option<DocumentAttributeValueType>

The data type of the facet value. This is the same as the type defined for the index field when it was created.

document_attribute_value_count_pairs: Option<Vec<DocumentAttributeValueCountPair>>

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

Implementations

impl FacetResult

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

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

pub fn document_attribute_value_type( &self, ) -> Option<&DocumentAttributeValueType>

The data type of the facet value. This is the same as the type defined for the index field when it was created.

pub fn document_attribute_value_count_pairs( &self, ) -> &[DocumentAttributeValueCountPair]

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

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

impl FacetResult

pub fn builder() -> FacetResultBuilder

Creates a new builder-style object to manufacture FacetResult.

Trait Implementations

impl Clone for FacetResult

fn clone(&self) -> FacetResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FacetResult

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

Formats the value using the given formatter.

impl PartialEq for FacetResult

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