Struct FirestoreExplainOptions 

pub struct FirestoreExplainOptions {
    pub analyze: Option<bool>,
}

Re-exports all public items from the db module.

The db module contains the core FirestoreDb client and functionalities for interacting with the Firestore database, such as CRUD operations, queries, and transactions. Options for requesting query execution analysis from Firestore.

When analyze is true, Firestore will return detailed information about how the query was executed, including index usage and performance metrics.

Fields

analyze: Option<bool>

If true, Firestore will analyze the query and return execution details. Defaults to false if not specified.

Implementations

impl FirestoreExplainOptions

pub fn new() -> Self

pub fn analyze(&mut self, value: bool) -> &mut Self

pub fn reset_analyze(&mut self) -> &mut Self

pub fn mopt_analyze(&mut self, value: Option<bool>) -> &mut Self

pub fn with_analyze(self, value: bool) -> Self

pub fn without_analyze(self) -> Self

pub fn opt_analyze(self, value: Option<bool>) -> Self

Trait Implementations

impl Clone for FirestoreExplainOptions

fn clone(&self) -> FirestoreExplainOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FirestoreExplainOptions

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

Formats the value using the given formatter.

impl From<FirestoreExplainOptionsInit> for FirestoreExplainOptions

fn from(value: FirestoreExplainOptionsInit) -> Self

Converts to this type from the input type.

impl PartialEq for FirestoreExplainOptions

fn eq(&self, other: &FirestoreExplainOptions) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FirestoreExplainOptions

impl TryFrom<&FirestoreExplainOptions> for ExplainOptions

type Error = FirestoreError

The type returned in the event of a conversion error.

fn try_from( explain_options: &FirestoreExplainOptions, ) -> Result<Self, Self::Error>

Performs the conversion.