Struct RunQueryResponse

pub struct RunQueryResponse {
    pub document: Option<Document>,
    pub done: Option<bool>,
    pub explain_metrics: Option<ExplainMetrics>,
    pub read_time: Option<DateTime<Utc>>,
    pub skipped_results: Option<i32>,
    pub transaction: Option<Vec<u8>>,
}

The response for Firestore.RunQuery.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• databases documents run query projects (response)

Fields

document: Option<Document>

A query result, not set when reporting partial progress.

done: Option<bool>

If present, Firestore has completely finished the request and no more documents will be returned.

explain_metrics: Option<ExplainMetrics>

Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.

read_time: Option<DateTime<Utc>>

The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their read_time and this one. If the query returns no results, a response with read_time and no document will be sent, and this represents the time at which the query was run.

skipped_results: Option<i32>

The number of results that have been skipped due to an offset between the last response and the current response.

transaction: Option<Vec<u8>>

The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response.

Trait Implementations

impl Clone for RunQueryResponse

fn clone(&self) -> RunQueryResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunQueryResponse

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

Formats the value using the given formatter.

impl Default for RunQueryResponse

fn default() -> RunQueryResponse

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RunQueryResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RunQueryResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ResponseResult for RunQueryResponse