Struct aws_sdk_cloudsearch::types::TextOptions

#[non_exhaustive]
pub struct TextOptions {
    pub default_value: Option<String>,
    pub source_field: Option<String>,
    pub return_enabled: Option<bool>,
    pub sort_enabled: Option<bool>,
    pub highlight_enabled: Option<bool>,
    pub analysis_scheme: Option<String>,
}

Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

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.

default_value: Option<String>

A value to use for the field if the field isn’t specified for a document.

source_field: Option<String>

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

return_enabled: Option<bool>

Whether the contents of the field can be returned in the search results.

sort_enabled: Option<bool>

Whether the field can be used to sort the search results.

highlight_enabled: Option<bool>

Whether highlights can be returned for the field.

analysis_scheme: Option<String>

The name of an analysis scheme for a text field.

Implementations

impl TextOptions

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

A value to use for the field if the field isn’t specified for a document.

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

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

pub fn return_enabled(&self) -> Option<bool>

Whether the contents of the field can be returned in the search results.

pub fn sort_enabled(&self) -> Option<bool>

Whether the field can be used to sort the search results.

pub fn highlight_enabled(&self) -> Option<bool>

Whether highlights can be returned for the field.

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

The name of an analysis scheme for a text field.

impl TextOptions

pub fn builder() -> TextOptionsBuilder

Creates a new builder-style object to manufacture TextOptions.

Trait Implementations

impl Clone for TextOptions

fn clone(&self) -> TextOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextOptions

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

Formats the value using the given formatter.

impl PartialEq for TextOptions

fn eq(&self, other: &TextOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TextOptions