Struct sit_core::repository::Repository

pub struct Repository { /* fields omitted */ }

Repository is the container for all SIT artifacts

Methods

impl Repository

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

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

pub 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.

pub 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

pub fn open_and_upgrade<P: Into<PathBuf>, U: AsRef<[Upgrade]>>(     path: P,     upgrades: U ) -> Result<Self, Error>

Opens and, if necessary, upgrades an existing repository. Allow to specify which particular upgrades should be allowed.

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

pub fn find_in_or_above<P: Into<PathBuf>, S: AsRef<str>>(     dir: S,     path: P ) -> Option<PathBuf>

Given relative path of path (such as ".sit"), finds a repository in a directory or above

impl Repository

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

Populates repository with default files

pub fn items_path(&self) -> &Path

Returns items path

pub fn config(&self) -> &Config

Returns repository's config

pub fn item_iter(&self) -> Result<ItemIter, Error>

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

pub fn new_item(&self) -> Result<Item, Error>

Creates and returns a new item with a unique ID

pub fn new_named_item<S: Into<String>>(&self, name: S) -> Result<Item, Error>

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

pub fn item<S: AsRef<str>>(&self, name: S) -> Option<Item>

Finds an item by name (if there is one)

pub fn modules_path(&self) -> &Path

Returns path to modules. The target directory may not exist.

pub fn module_iter(&self) -> Result<Box<dyn Iterator<Item = PathBuf>>, Error>

Returns an iterator over the list of modules (directories under modules directory)

Trait Implementations

impl HasPath for Repository

fn path(&self) -> &Path

Returns a reference to a path

impl PartialEq<Repository> for Repository

fn eq(&self, rhs: &Repository) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Debug for Repository

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

Formats the value using the given formatter.