Skip to main content

board

pinto::service

Function board 

Source 
pub async fn board(project_dir: &Path, query: &BoardQuery) -> Result<Board>
Expand description

Load the board in project_dir, grouping PBIs in the column order from config.toml.

PBIs in each known column use ascending rank order, matching list. Items whose statuses do not match a configured column are collected in Board::orphaned rather than discarded.

You can narrow down the display with BoardQuery:

  • If roots_only is set, include only PBIs whose persisted parent link is unset. This is evaluated before the other filters, so a child is not promoted when its parent is hidden.
  • If sprint is set, include only PBIs assigned to that sprint. Filters apply to both sorting and orphan detection.
  • If labels is specified, only PBIs matching the requested labels will be targeted. The default LabelMatch::Any mode is OR; LabelMatch::All is AND.
  • If statuses is set, display only those known columns in their configured order. Unknown names return Error::UnknownStatus. Orphaned PBIs are omitted when a subset is requested.

Error::NotInitialized if the board is uninitialized.