tagged-channels

This library makes it easy to tag (WebSocket, SSE, ...) channels with e.g. user-id and then send events to all the channels opened by a particular user. It's framework agnostic, but for now has only an [axum example]. If you're using it with another framework, consider PR-ing an adapted example.

Usage

```rust,no_run

// We're going to tag channels

[derive(Clone, Eq, Hash, PartialEq)]

enum Tag { UserId(i32), IsAdmin, }

// Events we're going to send

[derive(Deserialize, Serialize)]

[serde(tag = "_type")]

enum Message { Ping, }

// Create the manager let mut manager = TaggedChannels::::new();

// Message to user#1 manager.sendbytag(&Tag::UserId(1), Message::Ping).await;

// Message to all admins manager.sendbytag(&Tag::UserId(1), Message::Ping).await;

// Message to everyone manager.broadcast(Message::Ping).await;

// Connect and tag the channel as belonging to the user#1 who is an admin let mut channel = manager.create_channel([Tag::UserId(1), Tag::IsAdmin]);

// Receive events coming from the channel while let Some(event) = channel.recv().await { // send the event through WebSocket or SSE } ```

Look at the full [axum example] for detail.

Contributing

We appreciate all kinds of contributions, thank you!

Note on README

Most of the readme is automatically copied from the crate documentation by cargo-sync-readme. This way the readme is always in sync with the docs and examples are tested.

So if you find a part of the readme you'd like to change between <!-- cargo-sync-readme start --> and <!-- cargo-sync-readme end --> markers, don't edit README.md directly, but rather change the documentation on top of src/lib.rs and then synchronize the readme with: bash cargo sync-readme (make sure the cargo command is installed): bash cargo install cargo-sync-readme

If you have [rusty-hook] installed the changes will apply automatically on commit.

License

This project is licensed under the MIT license.