Enum QueryScope 

#[non_exhaustive]
pub enum QueryScope {
    Unspecified,
    Collection,
    CollectionGroup,
    CollectionRecursive,
    UnknownValue(UnknownValue),
}

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

Working with unknown values

This enum is defined as #[non_exhaustive] because Google Cloud may add additional enum variants at any time. Adding new variants is not considered a breaking change. Applications should write their code in anticipation of:

• New values appearing in future releases of the client library, and
• New values received dynamically, without application changes.

Please consult the Working with enums section in the user guide for some guidelines.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unspecified

The query scope is unspecified. Not a valid option.

Collection

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

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

CollectionRecursive

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

UnknownValue(UnknownValue)

If set, the enum was initialized with an unknown value.

Applications can examine the value using QueryScope::value or QueryScope::name.

Implementations

impl QueryScope

pub fn value(&self) -> Option<i32>

Gets the enum value.

Returns None if the enum contains an unknown value deserialized from the string representation of enums.

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

Gets the enum value as a string.

Returns None if the enum contains an unknown value deserialized from the integer representation of enums.

Trait Implementations

impl Clone for QueryScope

fn clone(&self) -> QueryScope

Returns a duplicate 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() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for QueryScope

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for QueryScope

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

Formats the value using the given formatter.

impl From<&str> for QueryScope

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<i32> for QueryScope

fn from(value: i32) -> Self

Converts to this type from the input type.

impl PartialEq for QueryScope

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for QueryScope