Expand description
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*).
use simplejrpc::prelude::*;
use serde_json::json;
let server = Server::builder()
.register("ping", |_| async { Ok(json!("pong")) })
.build();
server.serve("/tmp/simplejrpc.sock").await?;Framing: Content-Length: N\r\n\r\n + body (see codec::DEFAULT_MAX_FRAME_LEN).
Re-exports§
pub use client::encode_rpc_request;pub use client::Client;pub use client::ClientBuilder;pub use client::RpcClient;pub use codec::FrameReader;pub use codec::FrameReaderMut;pub use codec::FrameReaderView;pub use error::Error;pub use error::ErrorMapping;pub use error::Result;pub use error::RpcCode;pub use middleware::Middleware;pub use middleware::MiddlewareChain;pub use middleware::MiddlewareChainMut;pub use middleware::MiddlewareChainOps;pub use response::AppResponse;pub use response::AppResponseMut;pub use response::AppResponseView;pub use response::Meta;pub use sanitize::CLIENT_INTERNAL_MSG;pub use server::HandlerFn;pub use server::Request;pub use server::RequestMut;pub use server::RequestView;pub use server::RpcHandler;pub use server::Server;pub use server::ServerBuilder;pub use valid::rule_fn;pub use valid::FieldRule;pub use valid::Rule;pub use valid::Validator;
Modules§
- client
- Unix-socket JSON-RPC client (compatible with Go
NewRpcSimpleClient). - codec
- VSCode / LSP style
Content-Lengthframing (compatible with GoVSCodeObjectCodec). - config
- JSON configuration with optional environment prefix (compatible with Go
core/config). - error
- Error model aligned with Go
core/gerror. - macros
- Declarative macros to cut boilerplate.
- middleware
- Middleware traits and onion chain (compatible with Go
RPCMiddleware). - prelude
- Convenient re-exports for application code.
- response
- Application response envelope (
gsock.Response). - sanitize
- Client-facing error messages derived from typed
crate::Errorvariants. - server
- Request context and Unix-socket JSON-RPC server.
- util
- Small utilities (Go
boxs/gpathsubset). - valid
- Lightweight validation (Go
core/gvalidsubset), designed for extension.
Macros§
- define_
rpc_ codes - Define custom RPC business codes.
- define_
rpc_ codes_ with_ msg - Define codes with explicit messages (preferred for production).
- register_
methods - Register multiple methods on a server builder.
- rpc_
handler - Identity macro that documents the expected handler closure shape.
- validate_
object - Validate a JSON object with inline rules.