Struct ControlBackend 

pub struct ControlBackend { /* private fields */ }

JSON-RPC client after a matching initialize.

Implementations

impl ControlBackend

pub fn connect( path: &Path, layout: &Layout, agent: &str, ) -> Result<Self, ControlAttachError>

Connect, initialize with a required agent, and refuse a root/prefix mismatch so mutations never hit the wrong vault.

Errors

Returns an error if the socket cannot be reached, initialize fails, or the serve root/prefix does not match layout.

pub fn connect_as( path: &Path, layout: &Layout, agent: &str, client: &str, ) -> Result<Self, ControlAttachError>

Same as Self::connect with an explicit initialize.client name.

Errors

Returns an error if the socket cannot be reached, initialize fails, or the serve root/prefix does not match layout.

Trait Implementations

impl BoardBackend for ControlBackend

fn wait(&self, last: u64, timeout_ms: u64) -> Result<u64, Error>

Panics

Panics if the control client lock is poisoned.

fn last_since_revision(&self) -> Option<Option<u64>>

Panics

Panics if the since lock is poisoned.

fn invalidate_since(&self)

Panics

Panics if the query lock is poisoned.

fn layout(&self) -> &Layout

Vault this backend reads and writes.

fn generation(&self) -> u64

File-watcher generation.

fn revision(&self) -> u64

Serve catalog revision. Core is always 0.

fn live(&self) -> BackendKind

Which store this backend is.

fn identity(&self) -> &str

Claim and update identity (core: constructor; control: serve initialize).

fn list(&self, q: ListQuery) -> Result<ListPage, Error>

Filtered issue list for the List pane.

fn ready(&self, project: Option<&str>) -> Result<ListPage, Error>

Actionable ready queue, optionally scoped to project.

fn get(&self, id: &str) -> Result<IssueDetail, Error>

Full metadata for one issue.

fn excerpt(&self, id: &str) -> Result<Excerpt, Error>

On-disk heading range, capped and screened for secrets.

fn search(&self, query: &str, limit: usize) -> Result<Vec<SearchHit>, Error>

Title and body search hits, capped at limit.

fn claims( &self, holder: Option<&str>, project: Option<&str>, ) -> Result<Vec<ClaimRow>, Error>

Open claims, optionally filtered by holder and project.

fn agenda( &self, days: i64, project: Option<&str>, ) -> Result<Vec<AgendaRow>, Error>

Deadlines and scheduled dates inside days.

fn tree(&self, id: &str) -> Result<TreeNode, Error>

Parent and child tree rooted at id.

fn related( &self, id: &str, depth: usize, limit: usize, ) -> Result<Vec<RelatedHit>, Error>

Related issues by graph walk and text overlap.

fn recall(&self, id: &str, depth: usize) -> Result<Recall, Error>

The working set for id: plan, declared inputs and their deeds.

fn deed(&self, id: &str, add: &[String]) -> Result<MutResult, Error>

Cite deed accessions on id.

fn projects(&self) -> Result<Vec<String>, Error>

Project names under the layout prefix.

fn claim(&self, id: &str, force: bool) -> Result<MutResult, Error>

Claim id as Self::identity. force takes over another holder.

fn note(&self, id: &str, text: &str) -> Result<MutResult, Error>

Append a one-line logbook note.

fn update(&self, req: UpdateReq) -> Result<MutResult, Error>

Change state, priority, or blocker edges.

fn create(&self, project: &str, title: &str) -> Result<MutResult, Error>

Create a TODO in project with title.

fn open(&self, id: &str) -> Result<IssueDetail, Error>

Same metadata as Self::get; control also marks the issue opened.

fn refresh(&self) -> Result<(), Error>

Re-read the files. Core uses this after an out-of-band write. Control is a no-op; serve sees the file event.

impl Debug for ControlBackend

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.