Struct bonsaidb_client::RemoteDatabase

pub struct RemoteDatabase { /* private fields */ }

A database on a remote server.

Implementations

impl RemoteDatabase

pub fn name(&self) -> &str

Returns the name of the database.

Methods from Deref<Target = Client>

pub async fn send_api_request_async<Api: Api>(
    &self,
    request: &Api
) -> Result<Api::Response, ApiError<Api::Error>>

Sends an api request.

pub fn invoke_api_request<Api: Api>(&self, request: &Api) -> Result<(), Error>

Sends an api request without waiting for a result. The response from the server will be ignored.

pub fn send_api_request<Api: Api>(
    &self,
    request: &Api
) -> Result<Api::Response, ApiError<Api::Error>>

Sends an api request.

pub async fn effective_permissions(&self) -> Option<Permissions>

Returns the current effective permissions for the client. Returns None if unauthenticated.

Trait Implementations

impl AsyncConnection for RemoteDatabase

type Storage = Client

The AsyncStorageConnection type that is paired with this type.

fn storage(&self) -> Self::Storage

Returns the StorageConnection implementor that this database belongs to.

fn list_executed_transactions<'life0, 'async_trait>(
    &'life0 self,
    starting_id: Option<u64>,
    result_limit: Option<u32>
) -> Pin<Box<dyn Future<Output = Result<Vec<Executed>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Lists executed transactions from this Schema. By default, a maximum of 1000 entries will be returned, but that limit can be overridden by setting result_limit. A hard limit of 100,000 results will be returned. To begin listing after another known transaction_id, pass transaction_id + 1 into starting_id.

fn last_transaction_id<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Option<u64>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Fetches the last transaction id that has been committed, if any.

fn compact<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Compacts the entire database to reclaim unused disk space.

fn compact_key_value_store<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Compacts the key value store to reclaim unused disk space.

fn collection<C>(&self) -> AsyncCollection<'_, Self, C> where
    C: Collection, 

Accesses a collection for the connected Schema.

fn view<V>(&self) -> AsyncView<'_, Self, V> where
    V: SerializedView, 

Initializes View for schema::View V.

fn compact_collection<'life0, 'async_trait, C>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    C: 'async_trait + Collection,
    Self: 'async_trait, 

Compacts the collection to reclaim unused disk space.

impl AsyncKeyValue for RemoteDatabase

fn execute_key_operation<'life0, 'async_trait>(
    &'life0 self,
    op: KeyOperation
) -> Pin<Box<dyn Future<Output = Result<Output, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Executes a single KeyOperation.

fn set_key<S, V>(&'a self, key: S, value: &'a V) -> AsyncBuilder<'a, Self, V> where
    S: Into<String>,
    V: Serialize + Send + Sync, 

Sets key to value. This function returns a builder that is also a Future. Awaiting the builder will execute Command::Set with the options given.

fn set_binary_key<S>(
    &'a self,
    key: S,
    bytes: &'a [u8]
) -> AsyncBuilder<'a, Self, ()> where
    S: Into<String>, 

Sets key to bytes. This function returns a builder that is also a Future. Awaiting the builder will execute Command::Set with the options given.

fn set_numeric_key<S, V>(&self, key: S, value: V) -> AsyncBuilder<'_, Self, ()> where
    S: Into<String>,
    V: Into<Numeric>, 

Sets key to value. This stores the value as a Numeric, enabling atomic math operations to be performed on this key. This function returns a builder that is also a Future. Awaiting the builder will execute Command::Set with the options given.

fn increment_key_by<S, V>(&self, key: S, value: V) -> AsyncBuilder<'_, Self, V> where
    S: Into<String> + Send + Sync,
    V: Into<Numeric> + TryFrom<Numeric, Error = IncompatibleTypeError> + Send + Sync, 

Increments key by value. The value stored must be a Numeric, otherwise an error will be returned. The result of the increment will be the value’s type. For example, if the stored value is currently a u64, but value is a f64, the current value will be converted to an f64, and the stored value will be an f64.

fn decrement_key_by<S, V>(&self, key: S, value: V) -> AsyncBuilder<'_, Self, V> where
    S: Into<String> + Send + Sync,
    V: Into<Numeric> + TryFrom<Numeric, Error = IncompatibleTypeError> + Send + Sync, 

Decrements key by value. The value stored must be a Numeric, otherwise an error will be returned. The result of the decrement will be the value’s type. For example, if the stored value is currently a u64, but value is a f64, the current value will be converted to an f64, and the stored value will be an f64.

fn get_key<S>(&self, key: S) -> AsyncBuilder<'_, Self> where
    S: Into<String>, 

Gets the value stored at key. This function returns a builder that is also a Future. Awaiting the builder will execute Command::Get with the options given.

fn delete_key<'life0, 'async_trait, S>(
    &'life0 self,
    key: S
) -> Pin<Box<dyn Future<Output = Result<KeyStatus, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    S: 'async_trait + Into<String> + Send,
    Self: 'async_trait, 

Deletes the value stored at key.

fn key_namespace(&self) -> Option<&str>

The current namespace.

fn with_key_namespace(&self, namespace: &str) -> Namespaced<'_, Self>

Access this Key-Value store within a namespace. When using the returned Namespaced instance, all keys specified will be separated into their own storage designated by namespace.

impl AsyncLowLevelConnection for RemoteDatabase

fn schematic(&self) -> &Schematic

Returns the schema for the database.

fn apply_transaction<'life0, 'async_trait>(
    &'life0 self,
    transaction: Transaction
) -> Pin<Box<dyn Future<Output = Result<Vec<OperationResult>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Applies a Transaction to the Schema. If any operation in the Transaction fails, none of the operations will be applied to the Schema.

fn get_from_collection<'life0, 'life1, 'async_trait>(
    &'life0 self,
    id: DocumentId,
    collection: &'life1 CollectionName
) -> Pin<Box<dyn Future<Output = Result<Option<OwnedDocument>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Retrieves the document with id stored within the named collection.

fn get_multiple_from_collection<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    ids: &'life1 [DocumentId],
    collection: &'life2 CollectionName
) -> Pin<Box<dyn Future<Output = Result<Vec<OwnedDocument>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Retrieves all documents matching ids from the named collection. Documents that are not found are not returned, but no error will be generated.

fn list_from_collection<'life0, 'life1, 'async_trait>(
    &'life0 self,
    ids: Range<DocumentId>,
    order: Sort,
    limit: Option<u32>,
    collection: &'life1 CollectionName
) -> Pin<Box<dyn Future<Output = Result<Vec<OwnedDocument>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Retrieves all documents within the range of ids from the named collection. To retrieve all documents, pass in .. for ids.

fn list_headers_from_collection<'life0, 'life1, 'async_trait>(
    &'life0 self,
    ids: Range<DocumentId>,
    order: Sort,
    limit: Option<u32>,
    collection: &'life1 CollectionName
) -> Pin<Box<dyn Future<Output = Result<Vec<Header>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Retrieves all headers within the range of ids from the named collection. To retrieve all documents, pass in .. for ids.

fn count_from_collection<'life0, 'life1, 'async_trait>(
    &'life0 self,
    ids: Range<DocumentId>,
    collection: &'life1 CollectionName
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Counts the number of documents within the range of ids from the named collection.

fn compact_collection_by_name<'life0, 'async_trait>(
    &'life0 self,
    collection: CollectionName
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Compacts the collection to reclaim unused disk space.

fn query_by_name<'life0, 'life1, 'async_trait>(
    &'life0 self,
    view: &'life1 ViewName,
    key: Option<QueryKey<Bytes>>,
    order: Sort,
    limit: Option<u32>,
    access_policy: AccessPolicy
) -> Pin<Box<dyn Future<Output = Result<Vec<Serialized>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Queries for view entries from the named view.

fn query_by_name_with_docs<'life0, 'life1, 'async_trait>(
    &'life0 self,
    view: &'life1 ViewName,
    key: Option<QueryKey<Bytes>>,
    order: Sort,
    limit: Option<u32>,
    access_policy: AccessPolicy
) -> Pin<Box<dyn Future<Output = Result<MappedSerializedDocuments, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Queries for view entries from the named view with their source documents.

fn reduce_by_name<'life0, 'life1, 'async_trait>(
    &'life0 self,
    view: &'life1 ViewName,
    key: Option<QueryKey<Bytes>>,
    access_policy: AccessPolicy
) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Reduces the view entries from the named view.

fn reduce_grouped_by_name<'life0, 'life1, 'async_trait>(
    &'life0 self,
    view: &'life1 ViewName,
    key: Option<QueryKey<Bytes>>,
    access_policy: AccessPolicy
) -> Pin<Box<dyn Future<Output = Result<Vec<MappedSerializedValue>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Reduces the view entries from the named view, reducing the values by each unique key.

fn delete_docs_by_name<'life0, 'life1, 'async_trait>(
    &'life0 self,
    view: &'life1 ViewName,
    key: Option<QueryKey<Bytes>>,
    access_policy: AccessPolicy
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Deletes all source documents for entries that match within the named view.

fn insert<'life0, 'async_trait, C, PrimaryKey, B>(
    &'life0 self,
    id: Option<PrimaryKey>,
    contents: B
) -> Pin<Box<dyn Future<Output = Result<CollectionHeader<<C as Collection>::PrimaryKey>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    PrimaryKey: for<'k> KeyEncoding<'k, <C as Collection>::PrimaryKey> + 'async_trait + Send,
    C: 'async_trait + Collection,
    B: 'async_trait + Into<Bytes> + Send,
    Self: 'async_trait, 

Inserts a newly created document into the connected schema::Schema for the Collection C. If id is None a unique id will be generated. If an id is provided and a document already exists with that id, a conflict error will be returned.

fn update<'life0, 'life1, 'async_trait, C, D>(
    &'life0 self,
    doc: &'life1 mut D
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    C: 'async_trait + Collection,
    D: 'async_trait + Document<C> + Send + Sync,
    Self: 'async_trait, 

Updates an existing document in the connected schema::Schema for the Collection(schema::Collection) C. Upon success, doc.revision will be updated with the new revision.

fn overwrite<'a, 'life0, 'async_trait, C, PrimaryKey>(
    &'life0 self,
    id: PrimaryKey,
    contents: Vec<u8, Global>
) -> Pin<Box<dyn Future<Output = Result<CollectionHeader<<C as Collection>::PrimaryKey>, Error>> + Send + 'async_trait, Global>> where
    'a: 'async_trait,
    'life0: 'async_trait,
    C: Collection + 'async_trait,
    PrimaryKey: for<'k> KeyEncoding<'k, <C as Collection>::PrimaryKey> + 'async_trait,
    Self: 'async_trait, 

Overwrites an existing document, or inserts a new document. Upon success, doc.revision will be updated with the new revision information.

fn get<'life0, 'async_trait, C, PrimaryKey>(
    &'life0 self,
    id: PrimaryKey
) -> Pin<Box<dyn Future<Output = Result<Option<OwnedDocument>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    C: Collection + 'async_trait,
    PrimaryKey: for<'k> KeyEncoding<'k, <C as Collection>::PrimaryKey> + 'async_trait,
    Self: 'async_trait, 

Retrieves a stored document from Collection C identified by id.

fn get_multiple<'life0, 'async_trait, C, PrimaryKey, DocumentIds, I>(
    &'life0 self,
    ids: DocumentIds
) -> Pin<Box<dyn Future<Output = Result<Vec<OwnedDocument, Global>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    C: Collection + 'async_trait,
    DocumentIds: IntoIterator<Item = PrimaryKey, IntoIter = I> + Send + Sync + 'async_trait,
    I: Iterator<Item = PrimaryKey> + Send + Sync + 'async_trait,
    PrimaryKey: for<'k> KeyEncoding<'k, <C as Collection>::PrimaryKey> + 'async_trait,
    Self: 'async_trait, 

Retrieves all documents matching ids. Documents that are not found are not returned, but no error will be generated.

fn list<'life0, 'async_trait, C, R, PrimaryKey>(
    &'life0 self,
    ids: R,
    order: Sort,
    limit: Option<u32>
) -> Pin<Box<dyn Future<Output = Result<Vec<OwnedDocument, Global>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    C: Collection + 'async_trait,
    R: Into<Range<PrimaryKey>> + Send + 'async_trait,
    PrimaryKey: for<'k> KeyEncoding<'k, <C as Collection>::PrimaryKey> + 'async_trait,
    Self: 'async_trait, 

Retrieves all documents within the range of ids. To retrieve all documents, pass in .. for ids.

fn list_headers<'life0, 'async_trait, C, R, PrimaryKey>(
    &'life0 self,
    ids: R,
    order: Sort,
    limit: Option<u32>
) -> Pin<Box<dyn Future<Output = Result<Vec<Header, Global>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    C: Collection + 'async_trait,
    R: Into<Range<PrimaryKey>> + Send + 'async_trait,
    PrimaryKey: for<'k> KeyEncoding<'k, <C as Collection>::PrimaryKey> + 'async_trait,
    Self: 'async_trait, 

Retrieves all documents within the range of ids. To retrieve all documents, pass in .. for ids.

fn count<'life0, 'async_trait, C, R, PrimaryKey>(
    &'life0 self,
    ids: R
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    C: Collection + 'async_trait,
    R: Into<Range<PrimaryKey>> + Send + 'async_trait,
    PrimaryKey: for<'k> KeyEncoding<'k, <C as Collection>::PrimaryKey> + 'async_trait,
    Self: 'async_trait, 

Counts the number of documents within the range of ids.

fn delete<'life0, 'life1, 'async_trait, C, H>(
    &'life0 self,
    doc: &'life1 H
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    C: 'async_trait + Collection,
    H: 'async_trait + HasHeader + Send + Sync,
    Self: 'async_trait, 

Removes a Document from the database.

fn query<'life0, 'async_trait, V>(
    &'life0 self,
    key: Option<QueryKey<<V as View>::Key>>,
    order: Sort,
    limit: Option<u32>,
    access_policy: AccessPolicy
) -> Pin<Box<dyn Future<Output = Result<Vec<Map<<V as View>::Key, <V as View>::Value>, Global>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    V: 'async_trait + SerializedView,
    Self: 'async_trait, 

Queries for view entries matching View(super::AsyncView).

fn query_with_docs<'life0, 'async_trait, V>(
    &'life0 self,
    key: Option<QueryKey<<V as View>::Key>>,
    order: Sort,
    limit: Option<u32>,
    access_policy: AccessPolicy
) -> Pin<Box<dyn Future<Output = Result<MappedDocuments<OwnedDocument, V>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    V: 'async_trait + SerializedView,
    Self: 'async_trait, 

Queries for view entries matching View with their source documents.

fn query_with_collection_docs<'life0, 'async_trait, V>(
    &'life0 self,
    key: Option<QueryKey<<V as View>::Key>>,
    order: Sort,
    limit: Option<u32>,
    access_policy: AccessPolicy
) -> Pin<Box<dyn Future<Output = Result<MappedDocuments<CollectionDocument<<V as View>::Collection>, V>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    V: SerializedView + 'async_trait,
    Self: 'async_trait,
    <V as View>::Collection: SerializedCollection,
    <<V as View>::Collection as SerializedCollection>::Contents: Debug, 

Queries for view entries matching View with their source documents, deserialized.

fn reduce<'life0, 'async_trait, V>(
    &'life0 self,
    key: Option<QueryKey<<V as View>::Key>>,
    access_policy: AccessPolicy
) -> Pin<Box<dyn Future<Output = Result<<V as View>::Value, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    V: 'async_trait + SerializedView,
    Self: 'async_trait, 

Reduces the view entries matching View.

fn reduce_grouped<'life0, 'async_trait, V>(
    &'life0 self,
    key: Option<QueryKey<<V as View>::Key>>,
    access_policy: AccessPolicy
) -> Pin<Box<dyn Future<Output = Result<Vec<MappedValue<<V as View>::Key, <V as View>::Value>, Global>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    V: 'async_trait + SerializedView,
    Self: 'async_trait, 

Reduces the view entries matching View, reducing the values by each unique key.

fn delete_docs<'life0, 'async_trait, V>(
    &'life0 self,
    key: Option<QueryKey<<V as View>::Key>>,
    access_policy: AccessPolicy
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    V: 'async_trait + SerializedView,
    Self: 'async_trait, 

Deletes all of the documents associated with this view.

impl AsyncPubSub for RemoteDatabase

type Subscriber = RemoteSubscriber

The Subscriber type for this PubSub connection.

fn create_subscriber<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Self::Subscriber, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Create a new Subscriber for this relay.

fn publish_bytes<'life0, 'async_trait>(
    &'life0 self,
    topic: Vec<u8>,
    payload: Vec<u8>
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Publishes a payload to all subscribers of topic.

fn publish_bytes_to_all<'life0, 'async_trait>(
    &'life0 self,
    topics: impl IntoIterator<Item = Vec<u8>> + Send + 'async_trait,
    payload: Vec<u8>
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Publishes a payload to all subscribers of all topics.

fn publish<'life0, 'life1, 'life2, 'async_trait, Topic, Payload>(
    &'life0 self,
    topic: &'life1 Topic,
    payload: &'life2 Payload
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Topic: 'async_trait + Serialize + Send + Sync,
    Payload: 'async_trait + Serialize + Send + Sync,
    Self: 'async_trait, 

Publishes a payload to all subscribers of topic.

fn publish_to_all<'topics, 'life0, 'life1, 'async_trait, Topics, Topic, Payload>(
    &'life0 self,
    topics: Topics,
    payload: &'life1 Payload
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'topics: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Topics: 'async_trait + 'topics + IntoIterator<Item = &'topics Topic> + Send,
    Topic: 'async_trait + 'topics + Serialize + Send,
    Payload: 'async_trait + Serialize + Send + Sync,
    Self: 'async_trait, 

Publishes a payload to all subscribers of all topics.

impl Clone for RemoteDatabase

fn clone(&self) -> RemoteDatabase

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Connection for RemoteDatabase

type Storage = Client

The StorageConnection type that is paired with this type.

fn storage(&self) -> Self::Storage

Returns the StorageConnection implementor that this database belongs to.

fn list_executed_transactions(
    &self,
    starting_id: Option<u64>,
    result_limit: Option<u32>
) -> Result<Vec<Executed>, Error>

Lists executed transactions from this Schema. By default, a maximum of 1000 entries will be returned, but that limit can be overridden by setting result_limit. A hard limit of 100,000 results will be returned. To begin listing after another known transaction_id, pass transaction_id + 1 into starting_id.

fn last_transaction_id(&self) -> Result<Option<u64>, Error>

Fetches the last transaction id that has been committed, if any.

fn compact(&self) -> Result<(), Error>

Compacts the entire database to reclaim unused disk space.

fn compact_key_value_store(&self) -> Result<(), Error>

Compacts the key value store to reclaim unused disk space.

fn collection<C>(&self) -> Collection<'_, Self, C> where
    C: Collection, 

Accesses a collection for the connected Schema.

fn view<V>(&self) -> View<'_, Self, V, <V as View>::Key> where
    V: SerializedView, 

Accesses a schema::View from this connection.

fn compact_collection<C>(&self) -> Result<(), Error> where
    C: Collection, 

Compacts the collection to reclaim unused disk space.

impl Debug for RemoteDatabase

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

Formats the value using the given formatter.

impl Deref for RemoteDatabase

type Target = Client

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl HasSession for RemoteDatabase

fn session(&self) -> Option<&Session>

Returns the currently authenticated session, if any.

fn allowed_to<'a, R, P>(&self, resource_name: R, action: &P) -> bool where
    R: AsRef<[Identifier<'a>]>,
    P: Action, 

Checks if action is permitted against resource_name.

fn check_permission<'a, R, P>(
    &self,
    resource_name: R,
    action: &P
) -> Result<(), Error> where
    R: AsRef<[Identifier<'a>]>,
    P: Action, 

Checks if action is permitted against resource_name. If permission is denied, returns a PermissionDenied error.

impl KeyValue for RemoteDatabase

fn execute_key_operation(&self, op: KeyOperation) -> Result<Output, Error>

Executes a single KeyOperation.

fn set_key<S, V>(&'a self, key: S, value: &'a V) -> Builder<'a, Self, V> where
    S: Into<String>,
    V: Serialize + Send + Sync, 

Sets key to value. This function returns a builder that is also a Future. Awaiting the builder will execute Command::Set with the options given.

fn set_binary_key<S>(&'a self, key: S, bytes: &'a [u8]) -> Builder<'a, Self, ()> where
    S: Into<String>, 

Sets key to bytes. This function returns a builder that is also a Future. Awaiting the builder will execute Command::Set with the options given.

fn set_numeric_key<S, V>(&self, key: S, value: V) -> Builder<'_, Self, ()> where
    S: Into<String>,
    V: Into<Numeric>, 

Sets key to value. This stores the value as a Numeric, enabling atomic math operations to be performed on this key. This function returns a builder that is also a Future. Awaiting the builder will execute Command::Set with the options given.

fn increment_key_by<S, V>(&self, key: S, value: V) -> Builder<'_, Self, V> where
    S: Into<String> + Send + Sync,
    V: Into<Numeric> + TryFrom<Numeric, Error = IncompatibleTypeError> + Send + Sync, 

Increments key by value. The value stored must be a Numeric, otherwise an error will be returned. The result of the increment will be the value’s type. For example, if the stored value is currently a u64, but value is a f64, the current value will be converted to an f64, and the stored value will be an f64.

fn decrement_key_by<S, V>(&self, key: S, value: V) -> Builder<'_, Self, V> where
    S: Into<String> + Send + Sync,
    V: Into<Numeric> + TryFrom<Numeric, Error = IncompatibleTypeError> + Send + Sync, 

Decrements key by value. The value stored must be a Numeric, otherwise an error will be returned. The result of the decrement will be the value’s type. For example, if the stored value is currently a u64, but value is a f64, the current value will be converted to an f64, and the stored value will be an f64.

fn get_key<S>(&self, key: S) -> Builder<'_, Self> where
    S: Into<String>, 

Gets the value stored at key. This function returns a builder that is also a Future. Awaiting the builder will execute Command::Get with the options given.

fn delete_key<S>(&self, key: S) -> Result<KeyStatus, Error> where
    S: Into<String> + Send, 

Deletes the value stored at key.

fn key_namespace(&self) -> Option<&str>

The current namespace.

fn with_key_namespace(&self, namespace: &str) -> Namespaced<'_, Self>

Access this Key-Value store within a namespace. When using the returned Namespaced instance, all keys specified will be separated into their own storage designated by namespace.

impl LowLevelConnection for RemoteDatabase

fn schematic(&self) -> &Schematic

Returns the schema for the database.

fn apply_transaction(
    &self,
    transaction: Transaction
) -> Result<Vec<OperationResult>, Error>

Applies a Transaction to the schema::Schema. If any operation in the Transaction fails, none of the operations will be applied to the schema::Schema.

fn get_from_collection(
    &self,
    id: DocumentId,
    collection: &CollectionName
) -> Result<Option<OwnedDocument>, Error>

Retrieves the document with id stored within the named collection.

fn get_multiple_from_collection(
    &self,
    ids: &[DocumentId],
    collection: &CollectionName
) -> Result<Vec<OwnedDocument>, Error>

Retrieves all documents matching ids from the named collection. Documents that are not found are not returned, but no error will be generated.

fn list_from_collection(
    &self,
    ids: Range<DocumentId>,
    order: Sort,
    limit: Option<u32>,
    collection: &CollectionName
) -> Result<Vec<OwnedDocument>, Error>

Retrieves all documents within the range of ids from the named collection. To retrieve all documents, pass in .. for ids.

fn list_headers_from_collection(
    &self,
    ids: Range<DocumentId>,
    order: Sort,
    limit: Option<u32>,
    collection: &CollectionName
) -> Result<Vec<Header>, Error>

Retrieves all headers within the range of ids from the named collection. To retrieve all documents, pass in .. for ids.

fn count_from_collection(
    &self,
    ids: Range<DocumentId>,
    collection: &CollectionName
) -> Result<u64, Error>

Counts the number of documents within the range of ids from the named collection.

fn compact_collection_by_name(
    &self,
    collection: CollectionName
) -> Result<(), Error>

Compacts the collection to reclaim unused disk space.

fn query_by_name(
    &self,
    view: &ViewName,
    key: Option<QueryKey<Bytes>>,
    order: Sort,
    limit: Option<u32>,
    access_policy: AccessPolicy
) -> Result<Vec<Serialized>, Error>

Queries for view entries from the named view.

fn query_by_name_with_docs(
    &self,
    view: &ViewName,
    key: Option<QueryKey<Bytes>>,
    order: Sort,
    limit: Option<u32>,
    access_policy: AccessPolicy
) -> Result<MappedSerializedDocuments, Error>

Queries for view entries from the named view with their source documents.

fn reduce_by_name(
    &self,
    view: &ViewName,
    key: Option<QueryKey<Bytes>>,
    access_policy: AccessPolicy
) -> Result<Vec<u8>, Error>

Reduces the view entries from the named view.

fn reduce_grouped_by_name(
    &self,
    view: &ViewName,
    key: Option<QueryKey<Bytes>>,
    access_policy: AccessPolicy
) -> Result<Vec<MappedSerializedValue>, Error>

Reduces the view entries from the named view, reducing the values by each unique key.

fn delete_docs_by_name(
    &self,
    view: &ViewName,
    key: Option<QueryKey<Bytes>>,
    access_policy: AccessPolicy
) -> Result<u64, Error>

Deletes all source documents for entries that match within the named view.

fn insert<C, PrimaryKey, B>(
    &self,
    id: Option<PrimaryKey>,
    contents: B
) -> Result<CollectionHeader<<C as Collection>::PrimaryKey>, Error> where
    C: Collection,
    PrimaryKey: Send + for<'k> KeyEncoding<'k, <C as Collection>::PrimaryKey>,
    B: Into<Bytes> + Send, 

Inserts a newly created document into the connected schema::Schema for the Collection C. If id is None a unique id will be generated. If an id is provided and a document already exists with that id, a conflict error will be returned.

fn update<C, D>(&self, doc: &mut D) -> Result<(), Error> where
    C: Collection,
    D: Document<C> + Send + Sync, 

Updates an existing document in the connected schema::Schema for the Collection C. Upon success, doc.revision will be updated with the new revision.

fn overwrite<C, PrimaryKey>(
    &self,
    id: PrimaryKey,
    contents: Vec<u8, Global>
) -> Result<CollectionHeader<<C as Collection>::PrimaryKey>, Error> where
    C: Collection,
    PrimaryKey: for<'k> KeyEncoding<'k, <C as Collection>::PrimaryKey>, 

Overwrites an existing document, or inserts a new document. Upon success, doc.revision will be updated with the new revision information.

fn get<C, PrimaryKey>(
    &self,
    id: PrimaryKey
) -> Result<Option<OwnedDocument>, Error> where
    C: Collection,
    PrimaryKey: for<'k> KeyEncoding<'k, <C as Collection>::PrimaryKey>, 

Retrieves a stored document from Collection C identified by id.

fn get_multiple<C, PrimaryKey, DocumentIds, I>(
    &self,
    ids: DocumentIds
) -> Result<Vec<OwnedDocument, Global>, Error> where
    C: Collection,
    DocumentIds: IntoIterator<Item = PrimaryKey, IntoIter = I> + Send + Sync,
    I: Iterator<Item = PrimaryKey> + Send + Sync,
    PrimaryKey: for<'k> KeyEncoding<'k, <C as Collection>::PrimaryKey>, 

Retrieves all documents matching ids. Documents that are not found are not returned, but no error will be generated.

fn list<C, R, PrimaryKey>(
    &self,
    ids: R,
    order: Sort,
    limit: Option<u32>
) -> Result<Vec<OwnedDocument, Global>, Error> where
    C: Collection,
    R: Into<Range<PrimaryKey>> + Send,
    PrimaryKey: for<'k> KeyEncoding<'k, <C as Collection>::PrimaryKey>, 

Retrieves all documents within the range of ids. To retrieve all documents, pass in .. for ids.

fn list_headers<C, R, PrimaryKey>(
    &self,
    ids: R,
    order: Sort,
    limit: Option<u32>
) -> Result<Vec<Header, Global>, Error> where
    C: Collection,
    R: Into<Range<PrimaryKey>> + Send,
    PrimaryKey: for<'k> KeyEncoding<'k, <C as Collection>::PrimaryKey>, 

Retrieves all documents within the range of ids. To retrieve all documents, pass in .. for ids.

fn count<C, R, PrimaryKey>(&self, ids: R) -> Result<u64, Error> where
    C: Collection,
    R: Into<Range<PrimaryKey>> + Send,
    PrimaryKey: for<'k> KeyEncoding<'k, <C as Collection>::PrimaryKey>, 

Counts the number of documents within the range of ids.

fn delete<C, H>(&self, doc: &H) -> Result<(), Error> where
    C: Collection,
    H: HasHeader + Send + Sync, 

Removes a Document from the database.

fn query<V, Key>(
    &self,
    key: Option<QueryKey<Key>>,
    order: Sort,
    limit: Option<u32>,
    access_policy: AccessPolicy
) -> Result<Vec<Map<<V as View>::Key, <V as View>::Value>, Global>, Error> where
    V: SerializedView,
    Key: for<'k> KeyEncoding<'k, <V as View>::Key>, 

Queries for view entries matching View.

fn query_with_docs<V, Key>(
    &self,
    key: Option<QueryKey<Key>>,
    order: Sort,
    limit: Option<u32>,
    access_policy: AccessPolicy
) -> Result<MappedDocuments<OwnedDocument, V>, Error> where
    V: SerializedView,
    Key: for<'k> KeyEncoding<'k, <V as View>::Key>, 

Queries for view entries matching View with their source documents.

fn query_with_collection_docs<V, Key>(
    &self,
    key: Option<QueryKey<Key>>,
    order: Sort,
    limit: Option<u32>,
    access_policy: AccessPolicy
) -> Result<MappedDocuments<CollectionDocument<<V as View>::Collection>, V>, Error> where
    Key: for<'k> KeyEncoding<'k, <V as View>::Key>,
    V: SerializedView,
    <V as View>::Collection: SerializedCollection,
    <<V as View>::Collection as SerializedCollection>::Contents: Debug, 

Queries for view entries matching View with their source documents, deserialized.

fn reduce<V, Key>(
    &self,
    key: Option<QueryKey<Key>>,
    access_policy: AccessPolicy
) -> Result<<V as View>::Value, Error> where
    V: SerializedView,
    Key: for<'k> KeyEncoding<'k, <V as View>::Key>, 

Reduces the view entries matching View.

fn reduce_grouped<V, Key>(
    &self,
    key: Option<QueryKey<Key>>,
    access_policy: AccessPolicy
) -> Result<Vec<MappedValue<<V as View>::Key, <V as View>::Value>, Global>, Error> where
    V: SerializedView,
    Key: for<'k> KeyEncoding<'k, <V as View>::Key>, 

Reduces the view entries matching View, reducing the values by each unique key.

fn delete_docs<V, Key>(
    &self,
    key: Option<QueryKey<Key>>,
    access_policy: AccessPolicy
) -> Result<u64, Error> where
    V: SerializedView,
    Key: for<'k> KeyEncoding<'k, <V as View>::Key>, 

Deletes all of the documents associated with this view.

impl PubSub for RemoteDatabase

type Subscriber = RemoteSubscriber

The Subscriber type for this PubSub connection.

fn create_subscriber(&self) -> Result<Self::Subscriber, Error>

Create a new Subscriber for this relay.

fn publish_bytes(&self, topic: Vec<u8>, payload: Vec<u8>) -> Result<(), Error>

Publishes a payload to all subscribers of topic.

fn publish_bytes_to_all(
    &self,
    topics: impl IntoIterator<Item = Vec<u8>> + Send,
    payload: Vec<u8>
) -> Result<(), Error>

Publishes a payload to all subscribers of all topics.

fn publish<Topic, Payload>(
    &self,
    topic: &Topic,
    payload: &Payload
) -> Result<(), Error> where
    Topic: Serialize,
    Payload: Serialize, 

Publishes a payload to all subscribers of topic.

fn publish_to_all<'topics, Topics, Topic, Payload>(
    &self,
    topics: Topics,
    payload: &Payload
) -> Result<(), Error> where
    Topics: 'topics + IntoIterator<Item = &'topics Topic>,
    Topic: 'topics + Serialize,
    Payload: Serialize, 

Publishes a payload to all subscribers of all topics.