ebus 1.3.0

Basic Event Bus implementation
Documentation

About The Project

This is a small Eventbus implementation that can be used to asynchronously transmit data to subscribers of a EventBus instance.

Usage

  • To build the lib run: cargo build --release
  • To run the example run: cargo run --example basic-implementation

Basic Example

use ebus::{async_subscriber, EventBus, Subscriber};

#[derive(Default)]
pub struct ExampleSubscriber;

#[async_subscriber]
impl Subscriber for ExampleSubscriber {
    type Input = String;

    async fn on_event_publish(&mut self, event: &Self::Input) {
        println!("Received Data: {:#?}", event);
    }
}

#[tokio::main]
async fn main() {
    // Create a new event bus
    let mut event_bus = EventBus::default();

    // Create a new subscriber and subscribe it to the event bus
    let subscriber = ExampleSubscriber::default();
    event_bus.subscribe(subscriber);

    // Create an event and queue it for processing
    let event_data = "Hello World!".to_owned();
    event_bus.queue_and_process(event_data).await;
}

Roadmap

See the open issues for a full list of proposed features (and known issues).

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feat(amazing)/amazing-feature)
  3. Commit your Changes (git commit -m 'feat(amazing): such progress')
  4. Push to the Branch (git push origin feat(amazing)/amazing-feature)
  5. Open a Pull Request

License

Distributed under the MIT or Apache 2 License. See LICENSE-MIT or LICENSE-APACHE for more information.