Struct TopicFilter

#[non_exhaustive]
pub struct TopicFilter {
    pub filter_description: Option<String>,
    pub filter_class: Option<FilterClass>,
    pub filter_name: String,
    pub filter_synonyms: Option<Vec<String>>,
    pub operand_field_name: String,
    pub filter_type: Option<NamedFilterType>,
    pub category_filter: Option<TopicCategoryFilter>,
    pub numeric_equality_filter: Option<TopicNumericEqualityFilter>,
    pub numeric_range_filter: Option<TopicNumericRangeFilter>,
    pub date_range_filter: Option<TopicDateRangeFilter>,
    pub relative_date_filter: Option<TopicRelativeDateFilter>,
}

A structure that represents a filter used to select items for a topic.

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.

filter_description: Option<String>

A description of the filter used to select items for a topic.

filter_class: Option<FilterClass>

The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, and NAMED_VALUE_FILTER.

filter_name: String

The name of the filter.

filter_synonyms: Option<Vec<String>>

The other names or aliases for the filter.

operand_field_name: String

The name of the field that the filter operates on.

filter_type: Option<NamedFilterType>

The type of the filter. Valid values for this structure are CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, and RELATIVE_DATE_FILTER.

category_filter: Option<TopicCategoryFilter>

The category filter that is associated with this filter.

numeric_equality_filter: Option<TopicNumericEqualityFilter>

The numeric equality filter.

numeric_range_filter: Option<TopicNumericRangeFilter>

The numeric range filter.

date_range_filter: Option<TopicDateRangeFilter>

The date range filter.

relative_date_filter: Option<TopicRelativeDateFilter>

The relative date filter.

Implementations

impl TopicFilter

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

A description of the filter used to select items for a topic.

pub fn filter_class(&self) -> Option<&FilterClass>

The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, and NAMED_VALUE_FILTER.

pub fn filter_name(&self) -> &str

The name of the filter.

pub fn filter_synonyms(&self) -> &[String]

The other names or aliases for the filter.

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

pub fn operand_field_name(&self) -> &str

The name of the field that the filter operates on.

pub fn filter_type(&self) -> Option<&NamedFilterType>

The type of the filter. Valid values for this structure are CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, and RELATIVE_DATE_FILTER.

pub fn category_filter(&self) -> Option<&TopicCategoryFilter>

The category filter that is associated with this filter.

pub fn numeric_equality_filter(&self) -> Option<&TopicNumericEqualityFilter>

The numeric equality filter.

pub fn numeric_range_filter(&self) -> Option<&TopicNumericRangeFilter>

The numeric range filter.

pub fn date_range_filter(&self) -> Option<&TopicDateRangeFilter>

The date range filter.

pub fn relative_date_filter(&self) -> Option<&TopicRelativeDateFilter>

The relative date filter.

impl TopicFilter

pub fn builder() -> TopicFilterBuilder

Creates a new builder-style object to manufacture TopicFilter.

Trait Implementations

impl Clone for TopicFilter

fn clone(&self) -> TopicFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TopicFilter

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

Formats the value using the given formatter.

impl PartialEq for TopicFilter

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

Tests for self and other values to be equal, and is used by ==.

const 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 TopicFilter