Struct Filter

pub struct Filter(/* private fields */);

A Firestore query filter.

https://firebase.google.com/docs/firestore/reference/rpc/google.firestore.v1#filter

Examples

use firestore_structured_query::{FieldPath, Filter};
use googleapis_tonic_google_firestore_v1::google::firestore::v1::{structured_query, value::ValueType, Value};
let filter1: Filter = FieldPath::raw("field1").less_than(Value {
    value_type: Some(ValueType::IntegerValue(1)),
})?;
let filter2: Filter = FieldPath::raw("field2").less_than_or_equal(Value {
    value_type: Some(ValueType::IntegerValue(2)),
})?;
let filter3 = Filter::and([filter1.clone(), filter2.clone()]);
let filter4 = Filter::or([filter1.clone(), filter2.clone()]);
assert_eq!(
    structured_query::Filter::from(filter3),
    structured_query::Filter {
        filter_type: Some(structured_query::filter::FilterType::CompositeFilter(
            structured_query::CompositeFilter {
                op: structured_query::composite_filter::Operator::And as i32,
                filters: vec![
                    structured_query::Filter::from(filter1.clone()),
                    structured_query::Filter::from(filter2.clone())
                ],
            },
        )),
    }
);
assert_eq!(
    structured_query::Filter::from(filter4),
    structured_query::Filter {
        filter_type: Some(structured_query::filter::FilterType::CompositeFilter(
            structured_query::CompositeFilter {
                op: structured_query::composite_filter::Operator::Or as i32,
                filters: vec![
                    structured_query::Filter::from(filter1),
                    structured_query::Filter::from(filter2)
                ],
            },
        )),
    }
);

Implementations

impl Filter

pub fn and<I>(filters: I) -> Self

where I: IntoIterator<Item = Self>,

Creates a new CompositeFilter with the And operator.

https://firebase.google.com/docs/firestore/reference/rpc/google.firestore.v1#compositefilter https://firebase.google.com/docs/firestore/reference/rpc/google.firestore.v1#google.firestore.v1.StructuredQuery.CompositeFilter.Operator.ENUM_VALUES.google.firestore.v1.StructuredQuery.CompositeFilter.Operator.AND

Examples

use firestore_structured_query::{FieldPath, Filter};
use googleapis_tonic_google_firestore_v1::google::firestore::v1::{structured_query, value::ValueType, Value};
let filter1 = FieldPath::raw("field1").less_than(Value {
    value_type: Some(ValueType::IntegerValue(1)),
})?;
let filter2 = FieldPath::raw("field2").less_than_or_equal(Value {
    value_type: Some(ValueType::IntegerValue(2)),
})?;
let filter3 = Filter::and([filter1.clone(), filter2.clone()]);
assert_eq!(
    structured_query::Filter::from(filter3),
    structured_query::Filter {
        filter_type: Some(structured_query::filter::FilterType::CompositeFilter(
            structured_query::CompositeFilter {
                op: structured_query::composite_filter::Operator::And as i32,
                filters: vec![
                    structured_query::Filter::from(filter1),
                    structured_query::Filter::from(filter2)
                ],
            },
        )),
    }
);

pub fn or<I>(filters: I) -> Self

where I: IntoIterator<Item = Self>,

Creates a new CompositeFilter with the Or operator.

https://firebase.google.com/docs/firestore/reference/rpc/google.firestore.v1#compositefilter https://firebase.google.com/docs/firestore/reference/rpc/google.firestore.v1#google.firestore.v1.StructuredQuery.CompositeFilter.Operator.ENUM_VALUES.google.firestore.v1.StructuredQuery.CompositeFilter.Operator.OR

Examples

use firestore_structured_query::{FieldPath, Filter};
use googleapis_tonic_google_firestore_v1::google::firestore::v1::{structured_query, value::ValueType, Value};
let filter1 = FieldPath::raw("field1").less_than(Value {
    value_type: Some(ValueType::IntegerValue(1)),
})?;
let filter2 = FieldPath::raw("field2").less_than_or_equal(Value {
    value_type: Some(ValueType::IntegerValue(2)),
})?;
let filter3 = Filter::or([filter1.clone(), filter2.clone()]);
assert_eq!(
    structured_query::Filter::from(filter3),
    structured_query::Filter {
        filter_type: Some(structured_query::filter::FilterType::CompositeFilter(
            structured_query::CompositeFilter {
                op: structured_query::composite_filter::Operator::Or as i32,
                filters: vec![
                    structured_query::Filter::from(filter1),
                    structured_query::Filter::from(filter2)
                ],
            },
        )),
    }
);

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

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

Formats the value using the given formatter.

impl From<Filter> for Filter

fn from(filter: Filter) -> Self

Converts to this type from the input type.

impl PartialEq for Filter

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