ioevent

Crates.ioioevent
lib.rsioevent
version0.1.0-rc.3
created_at2025-04-18 08:22:46.283746+00
updated_at2025-04-25 04:58:48.722517+00
descriptionTransform Any tokio Async I/O into Event-Driven Architecture with Low Overhead.
homepage
repositoryhttps://github.com/BERADQ/ioevent
max_upload_size
id1638995
size105,760
Ninnana (BERADQ)

documentation

README

IOEVENT

GitHub License GitHub Issues or Pull Requests Crates.io Version docs.rs

A lightweight Rust crate for building event-driven applications on top of Tokio's async I/O streams with low overhead. Facilitates decoupled architectures, suitable for inter-process communication or modular designs.

Features

  • Event-driven Architecture: Transforms async I/O operations into unified event streams
  • Tokio Integration: Built upon and integrates seamlessly with Tokio's async runtime
  • Extensibility: Supports custom event types and dynamic handler registration
  • Bi-directional Communication: Enables event emission and response handling through Procedure Calls

Quick Examples

See full working examples in the examples directory.

Define Events

#[derive(Deserialize, Serialize, Debug, Event)]
pub struct Ping {
    pub timestamp: i64,
}

// Custom event tag
#[derive(Deserialize, Serialize, Debug, Event)]
#[event(tag = "com::demo::my::Event")]
pub struct CustomEvent(pub String, pub i64);

Create Subscribers

#[subscriber]
async fn handle_ping(state: State<AppState>, event: Ping) -> Result {
    state.wright.emit(&Pong { timestamp: event.timestamp })?;
    Ok(())
}

static SUBSCRIBERS: &[Subscriber<AppState>] = &[create_subscriber!(handle_ping)];

Build and Run

// Build the event bus
let subscribers = Subscribers::init(SUBSCRIBERS);
let mut builder = BusBuilder::new(subscribers);
builder.add_pair(IoPair::stdio());
let (bus, effect_wright) = builder.build();

// Run the bus
let state = State::new(AppState {}, effect_wright);
bus.run(state, &|error| { eprintln!("{:?}", error); }).await;

Procedure Call (RPC)

See the complete RPC example in examples/rpc.

Define Procedures

// Custom the path
#[derive(Deserialize, Serialize, Debug, ProcedureCall)]
#[procedure(path = "com::demo::my::CallPrint")]
pub struct CallPrint(pub String);
impl ProcedureCallRequest for CallPrint {
    type RESPONSE = CallPrintResponse;
}

#[derive(Deserialize, Serialize, Debug, ProcedureCall)]
pub struct CallPrintResponse(pub u64);
impl ProcedureCallResponse for CallPrintResponse {}

Handle Procedures

#[procedure]
async fn print_handler(request: CallPrint) -> Result {
    println!("Message: {}", request.0);
    Ok(CallPrintResponse(42))
}

Make Calls

let response = state.call(&CallPrint("Hello".to_string())).await?;
//  ^ CallPrintResponse

License

This project is licensed under the Unlicense - see the LICENSE file for details.

Commit count: 61

cargo fmt