Struct Project 

#[non_exhaustive]
pub struct Project {
    pub root: PathBuf,
    pub config: Config,
}

A project: its root and what its shuyi.ron says. Build it with Project::new or Project::load (ADR-0039).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

root: PathBuf

The folder holding shuyi.ron.

config: Config

What it says.

Implementations

impl Project

pub fn new(root: impl Into<PathBuf>, config: Config) -> Self

The project at root whose shuyi.ron says config.

pub fn load(root: &Path) -> Result<Self, String>

The project whose shuyi.ron is in root.

pub fn find(start: &Path) -> Result<Self, (Code, String)>

The project of the first folder from start up that holds a shuyi.ron, or the problem code and the message why there is none: no file (codes::NO_PROJECT), or one that doesn’t read (codes::PROJECT_FILE).

pub fn part<'a, T>( &self, part: &'a Option<T>, name: &str, ) -> Result<&'a T, String>

The part part of the config, named name, or the error that names it as missing (a codes::PROJECT_FILE problem).

Trait Implementations

impl Clone for Project

fn clone(&self) -> Project

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Project

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

Formats the value using the given formatter.

impl PartialEq for Project

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Project