https://github.com/rustgd/shrev-rs

Shred based event handler
https://github.com/rustgd/shrev-rs

events multithreading ring-buffer rust

Last synced: 4 days ago
JSON representation

Shred based event handler

• Host: GitHub
• URL: https://github.com/rustgd/shrev-rs
• Owner: rustgd
• Created: 2017-07-26T08:25:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-06-04T10:09:47.000Z (over 2 years ago)
• Last Synced: 2024-12-11T20:10:32.856Z (11 days ago)
• Topics: events, multithreading, ring-buffer, rust
• Language: Rust
• Size: 113 KB
• Stars: 59
• Watchers: 4
• Forks: 12
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# `shrev`

[![crates.io badge](https://img.shields.io/crates/v/shrev.svg)](https://crates.io/crates/shrev) [![docs badge](https://docs.rs/shrev/badge.svg)](https://docs.rs/shrev)

A pull based event channel, with events stored in a ring buffer,

meant to be used as a resource in [`specs`].

 

[`specs`]: https://github.com/slide-rs/specs

## Example usage

```rust

extern crate shrev;

use shrev::EventChannel;

#[derive(Clone, Debug, PartialEq, Eq)]

pub struct TestEvent {

    data: u32,

}

fn main() {

    let mut channel = EventChannel::new();

    channel.drain_vec_write(&mut vec![TestEvent { data: 1 }, TestEvent { data: 2 }]);

    let mut reader_id = channel.register_reader();

    // Should be empty, because reader was created after the write

    assert_eq!(

        Vec::::default(),

        channel.read(&mut reader_id).cloned().collect::>()

    );

    // Should have data, as a second write was done

    channel.single_write(TestEvent { data: 5 });

    assert_eq!(

        vec![TestEvent { data: 5 }],

        channel.read(&mut reader_id).cloned().collect::>()

    );

    // We can also just send in an iterator.

    channel.iter_write(

        [TestEvent { data: 8 }, TestEvent { data: 9 }]

            .iter()

            .cloned(),

    );

    assert_eq!(

        vec![TestEvent { data: 8 }, TestEvent { data: 9 }],

        channel.read(&mut reader_id).cloned().collect::>()

    );

}

```

## License

`shrev-rs` is free and open source software distributed under the terms of both

the MIT License and the Apache License 2.0.

Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in the work by you, as defined in the Apache-2.0 license, shall

be dual licensed as above, without any additional terms or conditions.