simplejrpc 0.1.0

Unix-socket JSON-RPC 2.0 SDK with middleware, config, and validation
Documentation
//! Unix-domain-socket JSON-RPC 2.0 SDK (Go `simplejrpc-go` compatible framing
//! and `{code,data,msg,meta}` app envelope).
//!
//! | Module | Role |
//! |--------|------|
//! | [`server`] / [`client`] / [`codec`] / [`middleware`] | transport + dispatch |
//! | [`response`] | app envelope |
//! | [`error`] | typed errors (`200xxx` business codes) |
//! | [`config`] / [`valid`] | config + field rules |
//!
//! `AppResponse.code` is HTTP-style (`200`/`404`). [`RpcCode`] / [`Error::code`]
//! use `200xxx`. Handlers return `Result<Value>`; the server maps errors via
//! [`Error::to_app_response`].
//!
//! To extend behavior, implement the small traits on wrappers (`Rule`,
//! [`RequestView`], [`AppResponseView`], [`MiddlewareChainOps`], [`ErrorMapping`],
//! [`RpcClient`], `codec::FrameReader*`).
//!
//! ```no_run
//! use simplejrpc::prelude::*;
//! use serde_json::json;
//!
//! # async fn demo() -> simplejrpc::Result<()> {
//! let server = Server::builder()
//!     .register("ping", |_| async { Ok(json!("pong")) })
//!     .build();
//! server.serve("/tmp/simplejrpc.sock").await?;
//! # Ok(())
//! # }
//! ```
//!
//! Framing: `Content-Length: N\r\n\r\n` + body (see [`codec::DEFAULT_MAX_FRAME_LEN`]).

#![deny(missing_docs)]
#![warn(rust_2018_idioms)]
#![cfg_attr(docsrs, feature(doc_cfg))]

pub mod client;
pub mod codec;
pub mod config;
pub mod error;
pub mod macros;
pub mod middleware;
pub mod response;
pub mod sanitize;
pub mod server;
pub mod util;
pub mod valid;

pub use client::{encode_rpc_request, Client, ClientBuilder, RpcClient};
pub use codec::{FrameReader, FrameReaderMut, FrameReaderView};
pub use error::{Error, ErrorMapping, Result, RpcCode};
pub use middleware::{Middleware, MiddlewareChain, MiddlewareChainMut, MiddlewareChainOps};
pub use response::{AppResponse, AppResponseMut, AppResponseView, Meta};
pub use sanitize::CLIENT_INTERNAL_MSG;
pub use server::{
    HandlerFn, Request, RequestMut, RequestView, RpcHandler, Server, ServerBuilder,
};
pub use valid::{rule_fn, FieldRule, Rule, Validator};

/// Convenient re-exports for application code.
///
/// Prefer `use simplejrpc::prelude::*;` in binaries and examples.
///
/// # Examples
///
/// ```
/// use simplejrpc::prelude::*;
/// use serde_json::json;
///
/// let server = Server::builder()
///     .register("ping", |_| async { Ok(json!("pong")) })
///     .build();
/// let _ = server;
/// ```
pub mod prelude {
    pub use crate::client::Client;
    pub use crate::error::{Error, Result, RpcCode};
    pub use crate::middleware::Middleware;
    pub use crate::response::AppResponse;
    pub use crate::server::{Request, Server, ServerBuilder};
    pub use crate::{register_methods, rpc_handler};
}