Struct google_api_proto::google::datastore::v1beta3::QueryResultBatch

pub struct QueryResultBatch {
    pub skipped_results: i32,
    pub skipped_cursor: Bytes,
    pub entity_result_type: i32,
    pub entity_results: Vec<EntityResult>,
    pub end_cursor: Bytes,
    pub more_results: i32,
    pub snapshot_version: i64,
}

A batch of results produced by a query.

Fields

skipped_results: i32

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

skipped_cursor: Bytes

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

entity_result_type: i32

The result type for every entity in entity_results.

entity_results: Vec<EntityResult>

The results for this batch.

end_cursor: Bytes

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

more_results: i32

The state of the query after the current batch.

snapshot_version: 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.

Implementations

impl QueryResultBatch

pub fn entity_result_type(&self) -> ResultType

Returns the enum value of entity_result_type, or the default if the field is set to an invalid enum value.

pub fn set_entity_result_type(&mut self, value: ResultType)

Sets entity_result_type to the provided enum value.

pub fn more_results(&self) -> MoreResultsType

Returns the enum value of more_results, or the default if the field is set to an invalid enum value.

pub fn set_more_results(&mut self, value: MoreResultsType)

Sets more_results to the provided enum value.

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() -> Self

Returns the “default value” for a type.

impl Message for QueryResultBatch

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 QueryResultBatch

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