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 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
#![allow(clippy::needless_doctest_main)]
//! # mediator-rs
//!
//! 
//! 
//! 
//! 
//!
//! An implementation of the Mediator pattern in Rust
//! inspired in C# [MediatR](https://github.com/jbogard/MediatR).
//!
//! ## Mediator Pattern
//! https://en.wikipedia.org/wiki/Mediator_pattern
//!
//! ## Usage
//! ```toml
//! [dependencies]
//! mediator = "0.2"
//! ```
//!
//! ## Tests
//! To run the tests use the following command:
//! ```bash
//! cargo test --all-features
//! ```
//!
//! ## Examples
//!
//! ### Basic usage
//! ```rust
//! use mediator::{DefaultMediator, Mediator, Request, Event, RequestHandler, EventHandler};
//!
//! #[derive(Clone, Debug)]
//! enum Op {
//! Add(f32, f32),
//! Sub(f32, f32),
//! Mul(f32, f32),
//! Div(f32, f32),
//! }
//!
//! struct MathRequest(Op);
//! impl Request<Option<f32>> for MathRequest {}
//!
//! #[derive(Clone, Debug)]
//! struct MathEvent(Op, Option<f32>);
//! impl Event for MathEvent {}
//!
//! struct MathRequestHandler(DefaultMediator);
//! impl RequestHandler<MathRequest, Option<f32>> for MathRequestHandler {
//! fn handle(&mut self, req: MathRequest) -> Option<f32> {
//! let result = match req.0 {
//! Op::Add(a, b) => Some(a + b),
//! Op::Sub(a, b) => Some(a - b),
//! Op::Mul(a, b) => Some(a * b),
//! Op::Div(a, b) => {
//! if b == 0.0 { None } else { Some(a / b) }
//! }
//! };
//!
//! self.0.publish(MathEvent(req.0, result)).expect("publish failed");
//! result
//! }
//! }
//!
//! fn main() {
//! let mut mediator = DefaultMediator::builder()
//! .add_handler_deferred(MathRequestHandler)
//! .subscribe_fn(|event: MathEvent| {
//! println!("{:?}", event);
//! })
//! .build();
//!
//! let result = mediator.send(MathRequest(Op::Add(1.0, 2.0))).expect("send failed");
//! assert_eq!(result, Some(3.0));
//! }
//! ```
//!
//! ### Async
//! Require the `async` feature enable.
//!
//! ```rust
//! use mediator::{DefaultAsyncMediator, AsyncMediator, Request};
//!
//! struct MulRequest(f32, f32);
//! impl Request<f32> for MulRequest {}
//!
//! #[tokio::main]
//! async fn main() {
//! let mut mediator = DefaultAsyncMediator::builder()
//! .add_handler(|req: MulRequest| async move {
//! tokio::time::sleep(std::time::Duration::from_secs(1)).await;
//! req.0 * req.1
//! })
//! .build();
//!
//! let result = mediator.send(MulRequest(2.0, 3.0)).await.expect("send failed");
//! assert_eq!(result, 6.0);
//! }
//! ```
//!
//! ### Streams
//! Require the `streams` feature enable.
//!
//! ```rust
//! use mediator::{StreamRequest, Event, DefaultAsyncMediator, AsyncMediator, box_stream};
//! use mediator::futures::{StreamExt, BoxStream};
//!
//! struct CountdownRequest(u32);
//! impl StreamRequest for CountdownRequest {
//! type Stream = BoxStream<'static, u32>;
//! type Item = u32;
//! }
//!
//! #[tokio::main]
//! async fn main() {
//! let mut mediator = DefaultAsyncMediator::builder()
//! .add_stream_handler_fn(|req: CountdownRequest| box_stream! { yx move =>
//! let mut count = req.0;
//! while count > 0 {
//! tokio::time::sleep(std::time::Duration::from_secs(1)).await;
//! yx.yield_one(count);
//! count -= 1;
//! }
//! })
//! .build();
//!
//! let mut stream = mediator.stream(CountdownRequest(3)).await.expect("stream failed");
//! assert_eq!(stream.next().await.unwrap(), 3);
//! assert_eq!(stream.next().await.unwrap(), 2);
//! assert_eq!(stream.next().await.unwrap(), 1);
//! assert_eq!(stream.next().await, None);
//! }
//! ```
/// A convenient result type.
pub type Result<T> = std::result::Result<T, error::Error>;
/// Module for the mediator request-response.
mod request;
pub use request::*;
/// Module for the mediator events.
mod event;
pub use event::*;
/// Module for the mediator.
mod mediator;
pub use crate::mediator::*;
/// Module for the errors.
pub mod error;
/// Module for streams.
#[cfg(feature = "streams")]
mod streams;
#[cfg(feature = "streams")]
pub use streams::*;
#[cfg(feature = "interceptors")]
mod interceptor;
#[cfg(feature = "interceptors")]
pub use interceptor::*;
/// Re-exports for futures/stream utilities.
#[cfg(feature = "async")]
pub mod futures;
#[cfg(feature = "async")]
pub use async_trait::async_trait;
// Default implementations.
#[cfg(feature = "impls")]
mod default_impls;
// Default exports
#[cfg(feature = "impls")]
pub use default_impls::mediator_impl::DefaultMediator;
#[cfg(all(feature = "impls", feature = "async"))]
pub use default_impls::async_mediator_impl::DefaultAsyncMediator;
/// Provides default implementations.
#[cfg(feature = "impls")]
pub mod impls {
pub use crate::default_impls::mediator_impl::Builder;
pub use crate::default_impls::mediator_impl::DefaultMediator;
}
/// Provides async default implementations.
#[cfg(all(feature = "impls", feature = "async"))]
pub mod impls_async {
pub use crate::default_impls::async_mediator_impl::Builder;
pub use crate::default_impls::async_mediator_impl::DefaultAsyncMediator;
}