Struct firestore_structured_query::FieldPath

pub struct FieldPath { /* private fields */ }

A Firestore Field Path.

https://firebase.google.com/docs/firestore/quotas#collections_documents_and_fields

• Must separate field names with a single period (.)
• May be passed as a dot-delimited (.) string of segments where each segment is either a simple field name or a quoted field name (defined below).

A simple field name is one where all of the following are true:

• Contains only the characters a-z, A-Z, 0-9, and underscore (_)
• Does not start with 0-9

A quoted field name starts and ends with the backtick character (`). For example, foo.`x&y` refers to the x&y field nested under the foo field. To construct a field name with the backtick character, escape the backtick character with the backslash character (\). For convenience, you can avoid quoted field names by passing the field path as a FieldPath object (for example, see JavaScript FieldPath).

Examples

use firestore_structured_query::FieldPath;
use google_api_proto::google::firestore::v1::structured_query;

let field_path1 = FieldPath::raw("field1");
assert_eq!(
    structured_query::FieldReference::from(field_path1),
    structured_query::FieldReference {
        field_path: "field1".to_string(),
    }
);

Implementations

impl FieldPath

pub fn raw<S>(field_path: S) -> Self

where S: Into<String>,

Creates a new field path without escaping.

impl FieldPath

pub fn array_contains<T>(&self, value: T) -> Result<Filter>

where T: IntoValue,

pub fn array_contains_any<T>(&self, value: T) -> Result<Filter>

where T: IntoValue,

pub fn equal<T>(&self, value: T) -> Result<Filter>

where T: IntoValue,

pub fn greater_than<T>(&self, value: T) -> Result<Filter>

where T: IntoValue,

pub fn greater_than_or_equal<T>(&self, value: T) -> Result<Filter>

where T: IntoValue,

pub fn in<T>(&self, value: T) -> Result<Filter>

where T: IntoValue,

pub fn is_nan(&self) -> Result<Filter>

pub fn is_not_nan(&self) -> Result<Filter>

pub fn is_not_null(&self) -> Result<Filter>

pub fn is_null(&self) -> Result<Filter>

pub fn less_than<T>(&self, value: T) -> Result<Filter>

where T: IntoValue,

pub fn less_than_or_equal<T>(&self, value: T) -> Result<Filter>

where T: IntoValue,

pub fn not_equal<T>(&self, value: T) -> Result<Filter>

where T: IntoValue,

pub fn not_in<T>(&self, value: T) -> Result<Filter>

where T: IntoValue,

impl FieldPath

pub fn ascending(&self) -> Order

pub fn descending(&self) -> Order

Trait Implementations

impl Clone for FieldPath

fn clone(&self) -> FieldPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldPath

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

Formats the value using the given formatter.

impl From<FieldPath> for FieldReference

fn from(field_path: FieldPath) -> Self

Converts to this type from the input type.

impl Ord for FieldPath

fn cmp(&self, other: &FieldPath) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for FieldPath

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

fn partial_cmp(&self, other: &FieldPath) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for FieldPath

impl StructuralPartialEq for FieldPath