Enum google_api_proto::google::firestore::admin::v1::index::QueryScope

#[repr(i32)]
pub enum QueryScope {
    Unspecified = 0,
    Collection = 1,
    CollectionGroup = 2,
    CollectionRecursive = 3,
}

Query Scope defines the scope at which a query is run. This is specified on a StructuredQuery’s from field.

Variants

Unspecified = 0

The query scope is unspecified. Not a valid option.

Collection = 1

Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the collection ID specified by the index.

CollectionGroup = 2

Indexes with a collection group query scope specified allow queries against all collections that has the collection ID specified by the index.

CollectionRecursive = 3

Include all the collections’s ancestor in the index. Only available for Datastore Mode databases.

Implementations

impl QueryScope

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of QueryScope.

pub fn from_i32(value: i32) -> Option<QueryScope>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a QueryScope, or None if value is not a valid variant.

impl QueryScope

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for QueryScope

fn clone(&self) -> QueryScope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryScope

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

Formats the value using the given formatter.

impl Default for QueryScope

fn default() -> QueryScope

Returns the “default value” for a type.

impl From<QueryScope> for i32

fn from(value: QueryScope) -> i32

Converts to this type from the input type.

impl Hash for QueryScope

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for QueryScope

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

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

fn partial_cmp(&self, other: &QueryScope) -> 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 TryFrom<i32> for QueryScope

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<QueryScope, UnknownEnumValue>

Performs the conversion.

impl Copy for QueryScope

impl Eq for QueryScope

impl StructuralPartialEq for QueryScope