oino-rpc 1.0.0

Oino JSONL RPC codec, RPC server over a SessionBackend, typed RPC client
Documentation 
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

//! `oino-rpc`: the JSONL RPC protocol (`--mode rpc`) for Oino.
//!
//! Strict JSONL over any byte stream: commands in, replies and client events out, with the
//! extension UI sub-protocol (`extension_ui_request` / `extension_ui_response`) and the Oino
//! extensions behind `_oino/hello` (modes.md §3–§4).
//!
//! # API map
//!
//! | Module | Contents |
//! |---|---|
//! | [`jsonl`] | [`jsonl::LineReader`], [`jsonl::serialize_line`] |
//! | [`wire`] | [`wire::session_event_json`] (also JSON mode), [`wire::rpc_event`] filtering |
//! | [`server`] | [`RpcServer`] over any `SessionBackend` |
//! | [`client`] | [`RpcClient`]: typed methods, [`Transport::StdioChild`] |
//! | [`backend`] | [`RpcBackend`]: `SessionBackend` over an [`RpcClient`]; [`backend::EventDecoder`] |
//!
//! `RpcBackend` lives here rather than in `oino-client` because `oino-rpc` already depends
//! on `oino-client` (deviations/modes.md).

#![forbid(unsafe_code)]
#![cfg_attr(
    test,
    allow(
        clippy::unwrap_used,
        clippy::expect_used,
        clippy::panic,
        reason = "tests assert by unwrapping"
    )
)]

pub mod backend;
pub mod client;
pub mod jsonl;
pub mod server;
pub mod wire;

pub use backend::RpcBackend;
pub use client::{ChildCommand, RpcClient, Transport};
pub use server::{RpcServer, RpcServerError};