Struct SearchExpression

#[non_exhaustive]
pub struct SearchExpression {
    pub filters: Option<Vec<Filter>>,
    pub nested_filters: Option<Vec<NestedFilters>>,
    pub sub_expressions: Option<Vec<SearchExpression>>,
    pub operator: Option<BooleanOperator>,
}

A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.

A SearchExpression contains the following components:

• A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.

• A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.

• A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.

• A Boolean operator: And or Or.

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.

filters: Option<Vec<Filter>>

A list of filter objects.

nested_filters: Option<Vec<NestedFilters>>

A list of nested filter objects.

sub_expressions: Option<Vec<SearchExpression>>

A list of search expression objects.

operator: Option<BooleanOperator>

A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.

Implementations

impl SearchExpression

pub fn filters(&self) -> &[Filter]

A list of filter objects.

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

pub fn nested_filters(&self) -> &[NestedFilters]

A list of nested filter objects.

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

pub fn sub_expressions(&self) -> &[SearchExpression]

A list of search expression objects.

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

pub fn operator(&self) -> Option<&BooleanOperator>

A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.

impl SearchExpression

pub fn builder() -> SearchExpressionBuilder

Creates a new builder-style object to manufacture SearchExpression.

Trait Implementations

impl Clone for SearchExpression

fn clone(&self) -> SearchExpression

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchExpression

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

Formats the value using the given formatter.

impl PartialEq for SearchExpression

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