Skip to main content

Crate bee

Crate bee 

Source
Expand description

bee-rs — Rust client for the Swarm Bee API.

Functional parity target with bee-js (the canonical TypeScript client) and bee-go (the typed Go port). bee-go is the primary reference for shape and behavior; bee-js is the source of truth for wire-format edge cases.

Re-exports§

pub use dev::DevClient;
pub use swarm::Error;
pub use swarm::Result;

Modules§

api
Generic API surface: upload/download options, headers, rich return types, and the pin / tag / stewardship endpoint methods. Mirrors pkg/api in bee-go.
debug
Debug / operator endpoints. Mirrors pkg/debug in bee-go.
dev
Bee dev-mode wrapper. The dev-mode endpoint surface is a strict subset of production Bee, so this is mostly a documentation / discovery signal: callers can let bee = DevClient::new(url)?; and use the same accessors they already know from Client.
file
File / data / chunk / SOC / feed / collection uploads and downloads. Mirrors pkg/file in bee-go.
gsoc
GSOC send / subscribe + offline soc_address. Mirrors pkg/gsoc in bee-go and bee-js Bee.gsocSend / gsocSubscribe.
manifest
Mantaray manifest trie. Mirrors pkg/manifest in bee-go and src/manifest in bee-js.
postage
Postage batch CRUD + stamp metadata. Mirrors pkg/postage in bee-go.
pss
PSS send / subscribe / receive. Mirrors pkg/pss in bee-go and Bee.pssSend / Bee.pssSubscribe / Bee.pssReceive in bee-js.
storage
High-level storage helpers built on top of Client.
swarm
Foundational types for the Swarm protocol: typed bytes, BMT chunk addressing, SOC primitives, and the crate-level error type.

Structs§

Client
Top-level Bee API client.