Struct Router 

pub struct Router { /* private fields */ }

User-level map of project name to layout, plus the process default.

Implementations

impl Router

pub fn unrouted(default: Layout) -> Self

A router that never leaves default. Used when routing is off.

pub fn load(default: Layout) -> Result<Self>

Load $VISSUE_CONFIG or the XDG file over default.

A missing default-path file is a no-op. VISSUE_NO_ROUTE set to a non-empty value other than 0 / false ignores the file.

Errors

Returns an error if an explicit VISSUE_CONFIG path is missing, the file cannot be read or parsed, a route names an unknown layout, or a layout root is relative after expansion.

pub fn from_file(default: Layout, path: &Path) -> Result<Self>

Load an explicit config file. Tests and callers that already resolved the path use this.

Errors

Same as Self::load.

pub fn default_layout(&self) -> &Layout

The process default, from --root / VISSUE_ROOT / cwd.

pub fn is_routed(&self) -> bool

Whether any route is configured.

pub fn route(&self, project: &str) -> ProjectRef

Resolve a caller-facing project name to a layout and on-disk directory.

pub fn unique_layouts(&self) -> Vec<&Layout>

Unique layouts, default first, then named ones. Equality is (canonical root, prefix).

pub fn visible_projects(&self) -> Result<Vec<ProjectRef>>

Projects an unscoped list / projects should show.

Default-layout directories whose name is an identity route key are hidden. Alias keys appear; the alias directory on the routed layout does not appear under its raw name unless that name is also a default project.

Errors

Returns an error if a projects directory cannot be read.

pub fn extra_ids_for(&self, dir: &str) -> Result<Vec<String>>

Ids already used for dir on any unique layout, so a create can refuse a suffix the twin file already holds.

Errors

Returns an error if a twin file exists and cannot be parsed.

pub fn find_by_id(&self, id: &str) -> Result<RouteHit>

Locate one id. The longest matching route key or known project directory is tried first; then every remaining unique layout.

Errors

Error::IssueNotFound when no layout has the id. Error::DuplicateId when two distinct layouts define it.

pub fn duplicate_ids(&self) -> Result<Vec<(String, Vec<PathBuf>)>>

Ids that appear under more than one distinct unique layout.

Errors

Returns an error if a project file cannot be read.

Trait Implementations

impl Clone for Router

fn clone(&self) -> Router

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Router

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

Formats the value using the given formatter.