Skip to main content

Crate cellbook

Crate cellbook 

Source
Expand description

Cellbook core library.

Provides the user-facing API for cellbook projects. The runtime lives in cargo-cellbook.

Values in the context store are serialized with postcard. Stored types must implement Serialize and loaded types must implement DeserializeOwned.

Re-exports§

pub use context::CellContext;
pub use errors::ContextError;
pub use errors::Error;
pub use errors::Result;
pub use image::open_image;
pub use image::open_image_bytes;
pub use registry::CellInfo;
pub use futures;
pub use inventory;
pub use serde;

Modules§

context
Context handle for cells to access the host’s store.
errors
image
Image viewing utilities.
registry
Cell registry using inventory for automatic collection.
test
Test utilities for cellbook.

Macros§

consume
Load and remove a value in one operation.
consumev
Load and remove a value with schema version checking.
load
Load a value from the context.
loadv
Load a value from the context with schema version checking.
remove
Remove a value from the context.
store
Store a value in the context.
storev
Store a value in the context with schema version metadata.

Traits§

StoreSchema
Opt-in schema version metadata for versioned shared-store operations.

Attribute Macros§

cell
Marks an async function as a cellbook cell.
init
Marks an async function as the required cellbook init entrypoint.

Derive Macros§

StoreSchema
Derive cellbook::StoreSchema with a version set by #[store_schema(version = N)].