Struct sit_core::repository::Repository

pub struct Repository { /* fields omitted */ }

Repository is the container for all SIT artifacts

Methods

impl Repository

fn new<P: Into<PathBuf>>(path: P) -> Result<Self, Error>

Attempts creating a new repository. Fails with Error::AlreadyExists if a repository already exists.

fn new_with_config<P: Into<PathBuf>>(
    path: P,
    config: Config
) -> Result<Self, Error>

Attempts creating a new repository with a specified config. Fails with Error::AlreadyExists if a repository already exists.

fn open<P: Into<PathBuf>>(path: P) -> Result<Self, Error>

Opens an existing repository. Fails if there's no valid repository at the given path

fn find_in_or_above<P: Into<PathBuf>, S: AsRef<str>>(
    dir: S,
    path: P
) -> Result<Self, Error>

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

Populates repository with default files

fn path(&self) -> &Path

Returns repository path

fn issues_path(&self) -> &Path

Returns issues path

fn config(&self) -> &Config

Returns repository's config

fn issue_iter(&self) -> Result<IssueIter, Error>

Returns an unordered (as in "order not defined") issue iterator

fn new_issue(&self) -> Result<Issue, Error>

Creates and returns a new issue with a unique ID

fn new_named_issue<S: Into<String>>(&self, name: S) -> Result<Issue, Error>

Creates and returns a new issue with a specific name. Will fail if there's an issue with the same name.

Trait Implementations

impl Debug for Repository

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.