Expand description
JSON-RPC control wire: socket paths, framing, peer credentials, and types.
This crate does not bind a socket. The owner lives in vissue-serve.
Re-exports§
pub use frame::FrameError;pub use frame::Framing;pub use frame::MAX_HEADER_LINES;pub use frame::MAX_MESSAGE_BYTES;pub use frame::classify_first_line;pub use frame::is_header_line;pub use frame::read_message;pub use frame::write_message;pub use path::HUD_LOG_ENV;pub use path::HUD_SOCKET_ENV;pub use path::SERVE_LOG_ENV;pub use path::SOCKET_ENV;pub use path::beside_socket;pub use path::control_log_path;pub use path::default_socket_path;pub use path::hud_log_path;pub use path::hud_socket_path;pub use path::runtime_dir;pub use path::socket_lock_path;pub use path::socket_pid_path;pub use rpc::Error;pub use rpc::InitializeParams;pub use rpc::InitializeResult;pub use rpc::JsonRpcError;pub use rpc::JsonRpcId;pub use rpc::JsonRpcRequest;pub use rpc::JsonRpcResponse;pub use rpc::Method;pub use rpc::NOTIFY_ISSUE_SELECTED;pub use rpc::NOTIFY_SHUTTING_DOWN;pub use rpc::NOTIFY_VAULT_CHANGED;pub use rpc::Notification;pub use rpc::PROTOCOL_VERSION;pub use rpc::Request;pub use rpc::Response;pub use rpc::V1_CAPABILITIES;pub use rpc::error_from_core;pub use rpc::invalid_params;pub use rpc::invalid_request;pub use rpc::method_not_found;pub use rpc::parse_error;pub use rpc::parse_initialize_params;
Modules§
- client
- Unix-socket JSON-RPC client. Clients never bind the control socket.
- frame
- JSONL and LSP
Content-Lengthframing on one stream. - path
- Control-socket locations and the sibling files next to them.
- peercred
- Same-uid check for an accepted Unix socket. No
unsafein this crate. - rpc
- JSON-RPC 2.0 types. Handshake is camelCase; issue payloads are snake_case.
Structs§
- Agenda
Row - One dated row: a deadline or scheduled date on an open issue.
- Child
Consensus - One child of a plan, and what its own ballots settled on.
- Claim
Row - One live claim: who holds the issue and for how long.
- Event
- One entry in the on-disk change log. One entry in the change log.
- Excerpt
- A capped, secret-screened slice of a heading’s on-disk range.
- Issue
Detail - One issue as a detail card: properties, tags, file range, body, and logbook.
- Issue
Rec - One parsed heading plus the
issues.orgit came from. - Issue
Row - One list/ready row: the fields a board or JSON client paints.
- List
Query - Filters for
crate::catalog::CatalogService::issues_rows. - Logbook
Line - One logbook line on a detail card: note, state flip, or raw CLOCK.
- Plan
Consensus - What a plan’s children hold, child by child.
- Recall
- The working set for one issue: the plan it sits in, the products of the work it waits on, and what it has produced so far.
- Recall
Input - One declared input to an issue, and the deeds that input produced.
- Related
Hit - One ranked related-issue hit, with the evidence that produced the score.
- Search
Hit - One search match: the heading plus a short snippet of the hit.
- Tree
Node - A parent/child subtree node, with the issue’s own blockers.
- WalkHit
- One related heading from a walk: children, ancestors, impact, or backlinks.