ruststream 0.7.0-rc.12

Async messaging framework for Rust: broker-agnostic traits, router, codecs, and a conformance harness for broker authors.
Documentation
# Quick start

The fastest way to a running service is to scaffold one with `cargo generate`.

## Scaffold a project

```bash
cargo install cargo-generate
cargo generate --git https://github.com/powersemmi/ruststream templates/memory --name my-service
cd my-service
```

Scaffolding needs only `cargo generate`. `templates/memory` is the starter template for the
in-memory broker. A broker crate that ships a template is scaffolded the same way, naming that
crate's repository and the template's path (for example
`--git https://github.com/powersemmi/ruststream-nats templates/nats`); the broker's own
documentation names the templates it has. `cargo generate` writes an idiomatic, multi-file project:

```
my-service/
├── Cargo.toml
└── src/
    ├── main.rs      # #[ruststream::app] builds the service and mounts the router
    ├── orders.rs    # handlers as #[subscriber] functions (one publishes a reply)
    └── routes.rs    # collects the handlers into a Router
```

## Run it

`#[ruststream::app]` generates `main`, so the binary already understands the framework commands:

```bash
cargo run -- run                # or: ruststream run, with the CLI installed
```

`cargo run -- run` starts a tokio runtime. The service runs until you press ++ctrl+c++. It needs
no external broker.

## Generate the AsyncAPI document

```bash
cargo run -- asyncapi gen
```

The command prints the AsyncAPI document as JSON. The output flags (`-o`, `--yaml`) and the
document itself are covered in the [`asyncapi` module](https://docs.rs/ruststream/latest/ruststream/asyncapi/index.html).

## What the entry point looks like

=== "Macros"

    ```rust title="src/main.rs"
    --8<-- "examples/tutorial/main.rs:main"
    ```

=== "Manual"

    ```rust title="src/main.rs"
    --8<-- "examples/manual/tutorial/main.rs:main"
    ```

You write a function that builds the service; `#[ruststream::app]` turns it into `main`.

## Next

- Understand each piece in the [tutorial]tutorial.md.
- Learn the handler forms in [Subscribers]https://docs.rs/ruststream/latest/ruststream/runtime/index.html#subscribers.
- Drive everything from the [CLI]https://docs.rs/ruststream/latest/ruststream/runtime/cli/index.html.