Trait Api 

pub trait Api:
    Serialize
    + for<'de> Deserialize<'de>
    + Send
    + Sync
    + Debug
    + 'static {
    type Response: Clone + Serialize + for<'de> Deserialize<'de> + Send + Sync + Debug;
    type Error: ApiError;

    // Required method
    fn name() -> ApiName;
}

An API request type. This trait is used by BonsaiDb’s server to allow a client to send a request of this type, and the server can respond with a Result<Api::Response,Api::Error>.

Deriving this trait

This trait can be derived. The only required attribute is name:

• name = "api-name" or name = "api-name", authority = "api-authority": Configures the Api’s fully qualified name. This name must be unique across all other Apis installed. When creating an Api that is meant to be reused, ensure that a unique authority is used to prevent name collisions.
• response = ResponseType: Configures the Api::Response associated type. This is the type that the handler will return upon success. If not specified, () is used.
• error = ErrorType: Configures the Api::Error associated type. This is the type that the handler will return upon error. If not specified, Infallible is used.

use bonsaidb_core::api::Api;
use serde::{Deserialize, Serialize};

#[derive(Api, Debug, Serialize, Deserialize)]
#[api(name = "list-records", response = Vec<Record>)]
struct ListRecords {
    starting_id: u64,
}

#[derive(Debug, Serialize, Deserialize, Clone)]
struct Record {
    title: String,
}

Required Associated Types

type Response: Clone + Serialize + for<'de> Deserialize<'de> + Send + Sync + Debug

The type that represents an API response. This type will be sent to clients from the server.

type Error: ApiError

The error type that this can return.

Required Methods

fn name() -> ApiName

Returns the unique name of this api.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl Api for AlterUserPermissionGroupMembership

type Error = Error

type Response = ()

impl Api for AlterUserRoleMembership

type Error = Error

type Response = ()

impl Api for ApplyTransaction

type Error = Error

type Response = Vec<OperationResult>

impl Api for AssumeIdentity

type Error = Error

type Response = Session

impl Api for Authenticate

Available on crate features password-hashing or token-authentication only.

type Error = Error

type Response = Session

impl Api for Compact

type Error = Error

type Response = ()

impl Api for CompactCollection

type Error = Error

type Response = ()

impl Api for CompactKeyValueStore

type Error = Error

type Response = ()

impl Api for Count

type Error = Error

type Response = u64

impl Api for CreateDatabase

type Error = Error

type Response = ()

impl Api for CreateSubscriber

type Error = Error

type Response = u64

impl Api for CreateUser

type Error = Error

type Response = u64

impl Api for DeleteDatabase

type Error = Error

type Response = ()

impl Api for DeleteDocs

type Error = Error

type Response = u64

impl Api for DeleteUser

type Error = Error

type Response = ()

impl Api for ExecuteKeyOperation

type Error = Error

type Response = Output

impl Api for Get

type Error = Error

type Response = Option<OwnedDocument>

impl Api for GetMultiple

type Error = Error

type Response = Vec<OwnedDocument>

impl Api for LastTransactionId

type Error = Error

type Response = Option<u64>

impl Api for List

type Error = Error

type Response = Vec<OwnedDocument>

impl Api for ListAvailableSchemas

type Error = Error

type Response = Vec<SchemaSummary>

impl Api for ListDatabases

type Error = Error

type Response = Vec<Database>

impl Api for ListExecutedTransactions

type Error = Error

type Response = Vec<Executed>

impl Api for ListHeaders

type Error = Error

type Response = Vec<Header>

impl Api for LogOutSession

type Error = Error

type Response = ()

impl Api for MessageReceived

type Error = Error

type Response = MessageReceived

impl Api for Publish

type Error = Error

type Response = ()

impl Api for PublishToAll

type Error = Error

type Response = ()

impl Api for Query

type Error = Error

type Response = Vec<Serialized>

impl Api for QueryWithDocs

type Error = Error

type Response = MappedSerializedDocuments

impl Api for Reduce

type Error = Error

type Response = Bytes

impl Api for ReduceGrouped

type Error = Error

type Response = Vec<MappedSerializedValue>

impl Api for SetUserPassword

Available on crate feature password-hashing only.

type Error = Error

type Response = ()

impl Api for SubscribeTo

type Error = Error

type Response = ()

impl Api for UnregisterSubscriber

type Error = Error

type Response = ()

impl Api for UnsubscribeFrom

type Error = Error

type Response = ()