Struct QueryResultBatch

pub struct QueryResultBatch {
    pub end_cursor: Option<Vec<u8>>,
    pub entity_result_type: Option<String>,
    pub entity_results: Option<Vec<EntityResult>>,
    pub more_results: Option<String>,
    pub read_time: Option<DateTime<Utc>>,
    pub skipped_cursor: Option<Vec<u8>>,
    pub skipped_results: Option<i32>,
    pub snapshot_version: Option<i64>,
}

A batch of results produced by a query.

This type is not used in any activity, and only used as part of another schema.

Fields

end_cursor: Option<Vec<u8>>

A cursor that points to the position after the last result in the batch.

entity_result_type: Option<String>

The result type for every entity in entity_results.

entity_results: Option<Vec<EntityResult>>

The results for this batch.

more_results: Option<String>

The state of the query after the current batch.

read_time: Option<DateTime<Utc>>

Read timestamp this batch was returned from. This applies to the range of results from the query’s start_cursor (or the beginning of the query if no cursor was given) to this batch’s end_cursor (not the query’s end_cursor). In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch’s read timestamp is valid for all preceding batches. This value will not be set for eventually consistent queries in Cloud Datastore.

skipped_cursor: Option<Vec<u8>>

A cursor that points to the position after the last skipped result. Will be set when skipped_results != 0.

skipped_results: Option<i32>

The number of results skipped, typically because of an offset.

snapshot_version: Option<i64>

The version number of the snapshot this batch was returned from. This applies to the range of results from the query’s start_cursor (or the beginning of the query if no cursor was given) to this batch’s end_cursor (not the query’s end_cursor). In a single transaction, subsequent query result batches for the same query can have a greater snapshot version number. Each batch’s snapshot version is valid for all preceding batches. The value will be zero for eventually consistent queries.

Trait Implementations

impl Clone for QueryResultBatch

fn clone(&self) -> QueryResultBatch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryResultBatch

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

Formats the value using the given formatter.

impl Default for QueryResultBatch

fn default() -> QueryResultBatch

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for QueryResultBatch

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for QueryResultBatch

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for QueryResultBatch