BulletinBoard Rust Client

The BulletinBoard crate provides an object storage solution for ArrayObject, designed for debugging and data acquisition workflows. For comprehensive documentation, refer to the BulletinBoard repository.

Important Notes

• Client operations do not verify success to maximize performance. Please consult the server logs for error details.
• Data transmission is not encrypted. Do not send confidential information over the network.
• This crate is under development; APIs and specifications may change. Compatibility between BulletinBoard and dbgbb is maintained for matching minor version numbers.
• Running tests will interact with the server and may erase existing data.

Usage Example

Before using bulletin-board-client, deploy a BulletinBoard server and configure the server address via an environment variable. For convenience, set it in your project's .cargo/config.toml:

[env]
BB_ADDR = "ADDRESS:PORT" # Or "PATH" for Unix socket

To post and retrieve bulletins:

use bulletin_board_client as bbclient;
use bbclient::*;

fn main() {
    let data: ArrayObject = vec![1f32, 2., -3., 5.].try_into().unwrap();
    bbclient::post("x", "tag", data.clone()).unwrap();

    let recv = bbclient::read("x", None, vec![]).unwrap().pop().unwrap();
    let restored = recv.try_into().unwrap();
    assert_eq!(data, restored);
}

To persist data:

use bulletin_board_client as bbclient;

fn main() {
    bbclient::archive("acv", "x", Some("tag")).unwrap();
    bbclient::reset_server().unwrap(); // Deletes all temporary data.

    bbclient::load("acv").unwrap();
    dbg!(bbclient::view_board().unwrap());
}

Refer to the documentation for detailed API usage.

Environment Variables

Crate Features