Guides
Using beave-rs
| Guide | Purpose |
|---|---|
| Architecture | How sources, handlers, and sinks fit together, their trait contracts, and errors |
| Runtime guide | Registration, configuration, processing behavior, shutdown, and limitations, with topic guides for handlers, middleware, errors, tombstones, transactions, observability, and health checks |
| Adapters | Local, channel, Kafka, Pulsar, RabbitMQ, SQS, Pub/Sub, Azure Service Bus, and HTTP adapters, usage, and extension contracts |
| Codecs | Serialization contracts; JSON, raw bytes, UTF-8, Protobuf, Avro, MessagePack, and CBOR codecs; Base64 and compression wrappers |
| Testing | Testing handlers, middleware, and error policies with fabricated broker records |
| Handling dead letters | Finding the cause of dead letters, and reprocessing, parking, or dropping them on log and queue brokers |
| Monitoring and alerting | Signals to alert on, alert rules, and setups for Kubernetes, AWS, Google Cloud, and Azure |
Runtime topics: Handlers, Middleware, Errors and retries, Tombstones, Transactions, Observability, and Health checks.
Adapter references: Local adapters, Channel, Kafka, Pulsar, RabbitMQ, SQS, Pub/Sub, Azure Service Bus, and HTTP.
Codec references: JSON, Raw bytes, UTF-8, Protobuf, Avro, MessagePack, CBOR, and codec wrappers: Base64, Gzip, and Zstd.
Contributing
| Guide | Purpose |
|---|---|
| Local development brokers | Docker Compose Kafka, Pulsar, RabbitMQ, ElasticMQ, Pub/Sub emulator, and Service Bus emulator brokers, web consoles, broker examples, and live tests |
| Design plan | Product goals, agreed design direction, future work, and open questions |
| Versioning and releases | Version numbers, the compatibility contract, the minimum supported Rust version, and the website |
| Code guidelines | Module layout and implementation standards |
The runtime guide describes what works today. The design plan includes future APIs and capabilities; its examples are conceptual unless explicitly identified as implemented.
Keep repository documentation, code comments, and examples in English. Keep the root README focused on the project overview and quick start. Put detailed user and contributor explanations here, and document public API contracts alongside their Rust definitions. When behavior changes, update the relevant guide and keep planned capabilities distinct from implemented ones.