Crate bonsaidb_client
source · [−]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.
Minimum Supported Rust Version (MSRV)
While this project is alpha, we are actively adopting the current version of
Rust. The current minimum version is 1.58
, and we plan on updating the MSRV to
implement namespaced
Features as soon as the
feature is released.
WASM Support
This crate supports compiling to WebAssembly. When using WebAssembly, the only protocol available is WebSockets.
Testing Websockets in a Browser
We have a fully deployed example application available that can be downloaded and run locally. This example is confirmed to work using Firefox on a local machine, or any modern browser when accessing https://minority-game.gooey.rs/.
- Ensure that the browser is able to talk to the IP/port that you’re bound to.
Browsers try to prevent malicious scripts. You may need to bind
0.0.0.0
instead oflocalhost
, for example, to circumvent these protections. - All Chrome-based browsers require secure websockets over localhost. This makes Chrome not a great candidate for testing WASM applications locally, as installing a valid certificate in a test/dev environment can be tricky and/or annoying.
Feature Flags
By default, the full
feature is enabled. These features are prefixed by
client-
when being enabled from the omnibus bonsaidb
crate.
full
: Enablestrusted-dns
andwebsockets
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
: EnablesWebSocket
support forbonsaidb-client
.password-hashing
: Enables the ability to use password authentication using Argon2.tracing
: Enablestracing
annotations on some functions and dependencies.
Re-exports
Structs
Client for connecting to a BonsaiDb server.
A database on a remote server.
A PubSub
subscriber from a remote server.
Enums
Traits
A handler of CustomApi
responses.