bonsaidb_server/
lib.rs

1#![doc = include_str!(".crate-docs.md")]
2#![cfg_attr(not(feature = "included-from-omnibus"), doc = include_str!("../server-feature-flags.md"))]
3#![forbid(unsafe_code)]
4#![warn(
5    clippy::cargo,
6    missing_docs,
7    // clippy::missing_docs_in_private_items,
8    clippy::pedantic,
9    future_incompatible,
10    rust_2018_idioms,
11)]
12#![allow(
13    clippy::missing_errors_doc, // TODO clippy::missing_errors_doc
14    clippy::missing_panics_doc, // TODO clippy::missing_panics_doc
15    clippy::option_if_let_else,
16    clippy::module_name_repetitions,
17)]
18
19/// Types for defining API handlers.
20pub mod api;
21mod backend;
22/// Command-line interface for the server.
23#[cfg(feature = "cli")]
24pub mod cli;
25mod config;
26mod dispatch;
27mod error;
28pub(crate) mod hosted;
29mod server;
30
31#[cfg(feature = "acme")]
32pub use config::{
33    AcmeConfiguration, LETS_ENCRYPT_PRODUCTION_DIRECTORY, LETS_ENCRYPT_STAGING_DIRECTORY,
34};
35
36pub use self::backend::{Backend, BackendError, ConnectionHandling, NoBackend};
37pub use self::config::{BonsaiListenConfig, DefaultPermissions, ServerConfiguration};
38pub use self::error::Error;
39pub use self::server::{
40    ApplicationProtocols, ConnectedClient, CustomServer, HttpService, LockedClientDataGuard, Peer,
41    Server, ServerDatabase, StandardTcpProtocols, TcpService, Transport,
42};
43
44#[cfg(test)]
45mod tests;
46
47#[cfg(any(feature = "test-util", test))]
48pub mod test_util;
49
50#[cfg(not(feature = "included-from-omnibus"))]
51pub use bonsaidb_core as core;
52#[cfg(not(feature = "included-from-omnibus"))]
53pub use bonsaidb_local as local;
54pub use fabruic;