beamdb 0.17.0

BEAM — distributed graph database syncing over WebSocket, WebRTC, and multicast. Successor to rod.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

//! Storage and network adapters for BEAM.
//!
//! This module contains all adapter implementations that connect the
//! [`crate::Node`] graph engine to external systems:
//!
//! # Storage Adapters
//!
//! - [`MemoryStorage`] — in-memory `HashMap`-backed storage (default)
//! - [`RedbStorage`] — persistent embedded storage via [`redb`] (native only)
//! - [`FjallStorage`] — persistent LSM-tree storage via [`fjall`] (native only, feature-gated)
//! - [`WasmIdbStorage`] — persistent IndexedDB storage (browser/WASM only)
//! - [`WasmNodeFsStorage`] — persistent `node:fs/promises` storage (Node.js WASM, `node-fs` feature)
//! - [`WasmOpfsStorage`] — persistent OPFS storage (browser/WASM only)
//!
//! # Storage Read/Write Split
//!
//! Storage adapters that implement [`Actor::try_clone_storage`] are started
//! as two actors by the Router: a read actor (receives `Get`) and a write
//! actor (receives `Put`, `BatchPut`, `Flush`). Both share the same
//! underlying store via `Arc`, so reads see committed writes immediately.
//!
//! - [`RedbStorage`] splits — the write actor's `spawn_blocking` fsync no
//!   longer blocks the read actor's concurrent `Get` queries.
//! - [`FjallStorage`] splits — though less critical than redb (fjall's writes
//!   are journal appends, not fsyncs), the split still provides backpressure
//!   isolation.
//! - [`MemoryStorage`] does not split — in-memory writes are synchronous
//!   (no fsync), so splitting provides no benefit and would break
//!   read-after-write ordering.
//!
//! # Network Adapters
//!
//! - [`OutgoingWebsocketManager`] — outgoing WebSocket client manager (native only)
//! - [`WsServer`] — incoming WebSocket server with optional TLS (native only)
//! - [`WsConn`] — per-connection WebSocket actor (native only)
//! - [`Multicast`] — UDP multicast LAN discovery (native only)
//! - [`WebRtcPeer`] — WebRTC data channel P2P connection (feature-gated)
//!
//! # Adapter Protocol
//!
//! All adapters implement the [`crate::actor::Actor`] trait and receive
//! [`crate::message::Message`] via the actor system. Storage adapters
//! handle `Get`, `Put`, `BatchPut`, and `Flush`. Network adapters
//! handle `Put` and `Get` by serializing to the wire format and
//! forwarding to remote peers.

mod memory_storage;

#[cfg(not(target_arch = "wasm32"))]
mod multicast;

#[cfg(feature = "persy")]
pub mod persy_storage;

#[cfg(feature = "fjall")]
mod fjall_storage;

#[cfg(not(target_arch = "wasm32"))]
mod redb_storage;

#[cfg(feature = "webrtc")]
mod webrtc;

#[cfg(not(target_arch = "wasm32"))]
mod ws_client;

#[cfg(not(target_arch = "wasm32"))]
mod ws_conn;

#[cfg(not(target_arch = "wasm32"))]
mod ws_server;

#[cfg(target_arch = "wasm32")]
mod wasm_ws;

#[cfg(target_arch = "wasm32")]
mod wasm_idb;

#[cfg(all(target_arch = "wasm32", feature = "node-fs"))]
mod wasm_node_fs;

#[cfg(target_arch = "wasm32")]
mod wasm_opfs;

pub use memory_storage::MemoryStorage;

#[cfg(not(target_arch = "wasm32"))]
pub use multicast::Multicast;

#[cfg(feature = "persy")]
pub use persy_storage::PersyStorage;

#[cfg(feature = "fjall")]
pub use fjall_storage::FjallStorage;

#[cfg(not(target_arch = "wasm32"))]
pub use redb_storage::RedbStorage;

#[cfg(not(target_arch = "wasm32"))]
pub use ws_client::OutgoingWebsocketManager;

#[cfg(not(target_arch = "wasm32"))]
pub use ws_conn::WsConn;

#[cfg(not(target_arch = "wasm32"))]
pub use ws_server::{WsServer, WsServerConfig};

#[cfg(target_arch = "wasm32")]
pub use wasm_ws::WasmWsConn;

#[cfg(target_arch = "wasm32")]
pub use wasm_idb::WasmIdbStorage;

#[cfg(all(target_arch = "wasm32", feature = "node-fs"))]
pub use wasm_node_fs::WasmNodeFsStorage;

#[cfg(target_arch = "wasm32")]
pub use wasm_opfs::WasmOpfsStorage;

#[cfg(feature = "webrtc")]
pub use webrtc::{WebRtcPeer, WebRtcRole};