Struct CatalogService 

pub struct CatalogService<'a> { /* private fields */ }

Read-only queries over a cached &[IssueRec].

Implementations

impl<'a> CatalogService<'a>

pub fn from_recs(issues: &'a [IssueRec]) -> Self

Query over an already-loaded catalog snapshot.

pub fn issues_rows(&self, q: ListQuery) -> Result<Vec<IssueRow>>

List rows matching q, same filters and sort as issues_rows_from.

Errors

Does not fail for a parsed catalog.

pub fn ready(&self, project: Option<&str>) -> Result<Vec<IssueRow>>

Actionable issues: TODO or STARTED with no open blocker.

Errors

Does not fail for a parsed catalog.

pub fn detail(&self, id: &str) -> Result<IssueDetail>

One issue as a detail card, including body and logbook.

Errors

Returns an error if id is not in the catalog.

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

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

Errors

Returns an error if id is not in the catalog, or the heading’s file cannot be read.

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

Case-insensitive substring scan over id, title, properties, and body.

Errors

Does not fail for a parsed catalog.

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

Live claims, oldest first, optionally narrowed by holder or project.

Errors

Does not fail for a parsed catalog.

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

Dated open work in the next days days, plus anything already overdue.

Errors

Does not fail for a parsed catalog.

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

Parent/child subtree rooted at id.

Errors

Returns an error if id is not in the catalog.

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

Ranked related issues for id.

Errors

Returns an error if id is not in the catalog.

pub fn children(&self, id: &str) -> Result<Vec<WalkHit>>

Issues whose :PARENT: points at id.

Errors

Returns an error if id is not in the catalog and no children exist.

pub fn ancestors(&self, id: &str, depth: usize) -> Result<Vec<WalkHit>>

Transitive blocker ancestors, limited to depth hops.

Errors

Returns an error if id is not in the catalog, or the blocker graph cannot be built.

pub fn impact(&self, id: &str, depth: usize) -> Result<Vec<WalkHit>>

Transitive issues waiting on id, limited to depth hops.

Errors

Returns an error if id is not in the catalog, or the blocker graph cannot be built.

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

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

Errors

Returns an error if id is not in the catalog, or the blocker graph cannot be built.

pub fn backlinks(&self, id: &str) -> Result<Vec<WalkHit>>

Issues that refer to id through an edge, a parent, a discovered-from or pivoted-to property, or a body mention.

Errors

Returns an error if id is not in the catalog and no backlinks exist.

Trait Implementations

impl<'a> Debug for CatalogService<'a>

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

Formats the value using the given formatter.