Struct Layout 

pub struct Layout { /* private fields */ }

Where the tracker lives: a root directory and the project prefix inside it.

Implementations

impl Layout

pub fn new(root: impl Into<PathBuf>, prefix: impl Into<String>) -> Self

Build a layout from an explicit root and prefix.

An empty prefix falls back to DEFAULT_PREFIX.

pub fn resolve(root: Option<&Path>, prefix: Option<&str>) -> Result<Self>

Resolve from explicit arguments, falling back to the environment, the directory the caller stands in, the seat’s own file, and finally the compiled defaults. The order is the caller, then the environment, then the working directory when that is a tracker, then the seat file.

Errors

Returns an error if the current directory cannot be resolved, or if <root>/vissue.toml exists but cannot be read or parsed.

pub fn require_tracker(&self) -> Result<()>

Refuse a guessed root that holds no tracker.

A reading verb answering “none” is indistinguishable from a tracker with nothing in it, and the two mean opposite things: one is an answer and the other is a caller standing in the wrong directory. A root somebody named is trusted, empty or not, because they said which one they meant.

Errors

crate::error::Error::NotATracker when the root was the working directory and carries neither vissue.toml nor the prefix directory.

pub fn root(&self) -> &Path

Tracker root: the directory that holds vissue.toml and prefix.

pub fn prefix(&self) -> &str

Directory name under Self::root that holds one subdirectory per project.

pub fn projects_dir(&self) -> PathBuf

<root>/<prefix>: the directory scanned for projects.

pub fn project_issues_path(&self, project: &str) -> PathBuf

<root>/<prefix>/<project>/issues.org.

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Layout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Layout

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

Formats the value using the given formatter.

impl Eq for Layout

impl PartialEq for Layout

fn eq(&self, other: &Layout) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Layout