Expand description

Networked client for bonsaidb-server.

This crate supports two methods for accessing a BonsaiDb server: QUIC and WebSockets.

QUIC is a new protocol built atop UDP. It is designed to operate more reliably than TCP, and features TLS built-in at the protocol level. WebSockets are an established protocol built atop TCP and HTTP.

Client provides access to BonsaiDb by implementing the StorageConnection trait.

WASM Support

This crate supports compiling to WebAssembly. When using WebAssembly, the only protocol available is WebSockets.

Feature Flags

By default, the full feature is enabled. These features are prefixed by client- when being enabled from the omnibus bonsaidb crate.

  • full: Enables trusted-dns and websockets
  • trusted-dns: Enables using trust-dns for DNS resolution. If not enabled, all DNS resolution is done with the OS’s default name resolver.
  • websockets: Enables WebSocket support for bonsaidb-client.
  • password-hashing: Enables the ability to use password authentication using Argon2.
  • tracing: Enables tracing annotations on some functions and dependencies.

Re-exports

pub use url;
pub use fabruic;

Structs

Builds a new Client with custom settings.

Client for connecting to a BonsaiDb server.

A database on a remote server.

A PubSub subscriber from a remote server.

Enums

Errors related to working with Client

Traits

A handler of CustomApi responses.