Struct firestore_grpc::google::firestore::v1beta1::firestore_client::FirestoreClient

pub struct FirestoreClient<T> { /* fields omitted */ }

The Cloud Firestore service.

This service exposes several types of comparable timestamps:

• create_time - The time at which a document was created. Changes only when a document is deleted, then re-created. Increases in a strict monotonic fashion.
• update_time - The time at which a document was last updated. Changes every time a document is modified. Does not change when a write results in no modifications. Increases in a strict monotonic fashion.
• read_time - The time at which a particular state was observed. Used to denote a consistent snapshot of the database or the time at which a Document was observed to not exist.
• commit_time - The time at which the writes in a transaction were committed. Any read with an equal or greater read_time is guaranteed to see the effects of the transaction.

Methods

impl FirestoreClient<Channel>

pub async fn connect<D>(dst: D) -> Result<Self, Error> where
    D: TryInto<Endpoint>,
    D::Error: Into<StdError>, 

Attempt to create a new client by connecting to a given endpoint.

impl<T> FirestoreClient<T> where
    T: GrpcService<BoxBody>,
    T::ResponseBody: Body + HttpBody + Send + 'static,
    T::Error: Into<StdError>,
    <T::ResponseBody as HttpBody>::Error: Into<StdError> + Send, 

pub fn new(inner: T) -> Self

pub fn with_interceptor(inner: T, interceptor: impl Into<Interceptor>) -> Self

pub async fn get_document<'_>(
    &'_ mut self,
    request: impl IntoRequest<GetDocumentRequest>
) -> Result<Response<Document>, Status>

Gets a single document.

pub async fn list_documents<'_>(
    &'_ mut self,
    request: impl IntoRequest<ListDocumentsRequest>
) -> Result<Response<ListDocumentsResponse>, Status>

Lists documents.

pub async fn create_document<'_>(
    &'_ mut self,
    request: impl IntoRequest<CreateDocumentRequest>
) -> Result<Response<Document>, Status>

Creates a new document.

pub async fn update_document<'_>(
    &'_ mut self,
    request: impl IntoRequest<UpdateDocumentRequest>
) -> Result<Response<Document>, Status>

Updates or inserts a document.

pub async fn delete_document<'_>(
    &'_ mut self,
    request: impl IntoRequest<DeleteDocumentRequest>
) -> Result<Response<()>, Status>

Deletes a document.

pub async fn batch_get_documents<'_>(
    &'_ mut self,
    request: impl IntoRequest<BatchGetDocumentsRequest>
) -> Result<Response<Streaming<BatchGetDocumentsResponse>>, Status>

Gets multiple documents.

Documents returned by this method are not guaranteed to be returned in the same order that they were requested.

pub async fn begin_transaction<'_>(
    &'_ mut self,
    request: impl IntoRequest<BeginTransactionRequest>
) -> Result<Response<BeginTransactionResponse>, Status>

Starts a new transaction.

pub async fn commit<'_>(
    &'_ mut self,
    request: impl IntoRequest<CommitRequest>
) -> Result<Response<CommitResponse>, Status>

Commits a transaction, while optionally updating documents.

pub async fn rollback<'_>(
    &'_ mut self,
    request: impl IntoRequest<RollbackRequest>
) -> Result<Response<()>, Status>

Rolls back a transaction.

pub async fn run_query<'_>(
    &'_ mut self,
    request: impl IntoRequest<RunQueryRequest>
) -> Result<Response<Streaming<RunQueryResponse>>, Status>

Runs a query.

pub async fn write<'_>(
    &'_ mut self,
    request: impl IntoStreamingRequest<Message = WriteRequest>
) -> Result<Response<Streaming<WriteResponse>>, Status>

Streams batches of document updates and deletes, in order.

pub async fn listen<'_>(
    &'_ mut self,
    request: impl IntoStreamingRequest<Message = ListenRequest>
) -> Result<Response<Streaming<ListenResponse>>, Status>

Listens to changes.

pub async fn list_collection_ids<'_>(
    &'_ mut self,
    request: impl IntoRequest<ListCollectionIdsRequest>
) -> Result<Response<ListCollectionIdsResponse>, Status>

Lists all the collection IDs underneath a document.

Trait Implementations

impl<T: Clone> Clone for FirestoreClient<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.