Struct google_api_proto::google::firestore::v1::RunQueryResponse

pub struct RunQueryResponse {
    pub transaction: Bytes,
    pub document: Option<Document>,
    pub read_time: Option<Timestamp>,
    pub skipped_results: i32,
    pub explain_metrics: Option<ExplainMetrics>,
    pub continuation_selector: Option<ContinuationSelector>,
}

The response for [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].

Fields

transaction: Bytes

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

document: Option<Document>

A query result, not set when reporting partial progress.

read_time: Option<Timestamp>

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: i32

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

explain_metrics: Option<ExplainMetrics>

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

continuation_selector: Option<ContinuationSelector>

The continuation mode for the query. If present, it indicates the current query response stream has finished. This can be set with or without a document present, but when set, no more results are returned.

Trait Implementations

impl Clone for RunQueryResponse

fn clone(&self) -> RunQueryResponse

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

Returns the “default value” for a type.

impl Message for RunQueryResponse

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for RunQueryResponse

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