1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
//! `lowbull` is a Rust crate providing a framework for message handling and event monitoring.
//!
//! This crate defines two main modules: `core` and `watch`. The `core` module contains the foundational traits and types for message handling, while the `watch` module provides utilities for monitoring events.
//!
//! ## Usage
//!
//! To use `lowbull`, add it as a dependency in your `Cargo.toml`:
//!
//! ```toml
//! [dependencies]
//! lowbull = "0.1.0"
//! ```
//!
//! Then, you can use the crate in your Rust code by importing the necessary modules:
//!
//! ```rust
//! use lowbull::core::LowBullMaster;
//! use lowbull::watch::LowBullWatcher;
//! use anyhow::Result;
//!
//! // Your code here...
//! ```
//!
//! ## Examples
//!
//! Here's a simple example demonstrating the usage of `lowbull`:
//!
//! ```rust
//! use lowbull::core::LowBullMaster;
//! use lowbull::watch::LowBullWatcher;
//! use anyhow::Result;
//!
//! // Define message types
//! #[derive(Debug, Hash, PartialEq, Eq, Clone, Copy)]
//! enum Message {
//! StartRender,
//! StopRender,
//! GetRender,
//! }
//!
//! // Define response types
//! #[derive(Debug, Hash, PartialEq, Eq)]
//! enum Response {
//! Render(bool),
//! None,
//! }
//!
//! // Implement a message handler
//! struct Master {
//! render: bool,
//! #[cfg(debug_assertions)]
//! watcher: LowBullWatcher<Message>,
//! }
//!
//! impl LowBullMaster<Message, Response> for Master {
//! fn handle(&mut self, key: Message) -> Result<Response> {
//! if cfg!(debug_assertions) {
//! self.watcher.watch(key);
//! }
//!
//! match key {
//! Message::StartRender => {
//! self.render = true;
//! Ok(Response::None)
//! }
//! Message::StopRender => {
//! self.render = false;
//! Ok(Response::None)
//! }
//! Message::GetRender => Ok(Response::Render(self.render)),
//! }
//! }
//! }
//!
//! // Your code here...
//! ```
//!
//! For more examples and detailed usage, please refer to the documentation.
pub mod core;
pub mod watch;
#[cfg(test)]
mod tests {
use crate::{
core::LowBullMaster,
watch::{self, LowBullWatcher},
};
use anyhow::Result;
#[derive(Debug, Hash, PartialEq, Eq, Clone, Copy)]
enum Message {
Empty,
StartRender,
StopRender,
GetRender,
}
#[derive(Debug, Hash, PartialEq, Eq)]
enum Response {
Render(bool),
None,
}
struct Master {
render: bool,
#[cfg(debug_assertions)]
watcher: watch::LowBullWatcher<Message>,
}
impl LowBullMaster<Message, Response> for Master {
fn handle(&mut self, key: Message) -> Result<Response> {
if cfg!(debug_assertions) {
self.watcher.watch(key);
}
match key {
Message::StartRender => {
self.render = true;
Ok(Response::None)
}
Message::StopRender => {
self.render = false;
Ok(Response::None)
}
Message::Empty => Ok(Response::None),
Message::GetRender => Ok(Response::Render(self.render)),
}
}
}
#[test]
fn test_master() {
let mut master = Master {
render: false,
watcher: LowBullWatcher::new(1000),
};
assert_eq!(
master.handle(Message::GetRender).unwrap(),
Response::Render(false)
);
assert_eq!(master.handle(Message::StartRender).unwrap(), Response::None);
assert_eq!(
master.handle(Message::GetRender).unwrap(),
Response::Render(true)
);
assert_eq!(master.handle(Message::StopRender).unwrap(), Response::None);
assert_eq!(
master.handle(Message::GetRender).unwrap(),
Response::Render(false)
);
let responses = master
.handle_many(vec![
Message::StartRender,
Message::GetRender,
Message::StopRender,
Message::GetRender,
])
.unwrap();
assert_eq!(responses[0], Response::None);
assert_eq!(responses[1], Response::Render(true));
assert_eq!(responses[2], Response::None);
assert_eq!(responses[3], Response::Render(false));
for _ in 0..1000 {
master.handle(Message::Empty).unwrap();
}
// if cfg!(debug_assertions) {
// master.watcher.debug_history();
//}
}
}