Struct AppManifest 

pub struct AppManifest {
    pub name: String,
    pub paths: AppPaths,
    pub file: Option<PathBuf>,
    pub warnings: Vec<String>,
}

rws.app.toml, parsed: the app’s name and where each part of it lives.

Default is the conventional layout with no name.

Fields

name: String

[app] name (or a top-level name). AppManifest::load falls back to the [package] name of the project’s Cargo.toml, then to the directory’s name; [AppManifest::from_str] leaves it empty.

paths: AppPaths

[paths], the layout’s defaults for every key not given.

file: Option<PathBuf>

The file it was read from — None when AppManifest::load found none (the conventional layout) or for [AppManifest::from_str].

warnings: Vec<String>

Keys and tables the parser doesn’t know, as line N: … notes.

Implementations

impl AppManifest

pub fn conventional(name: impl Into<String>) -> AppManifest

The conventional layout for an app called name.

pub fn parse(text: &str) -> Result<AppManifest, ManifestError>

Parse a manifest’s text (also text.parse::<AppManifest>()).

Tables [app] (name) and [paths] (the ROLES); values are strings; paths are relative to the project root and stay inside it (no leading /, no drive letter, no ..). Unknown keys and tables become Self::warnings.

pub fn load(dir: impl AsRef<Path>) -> Result<AppManifest, ManifestError>

The manifest of the project in dir: its rws.app.toml, or the conventional layout when there is none. The name falls back to Cargo.toml’s [package] name, then to the directory’s name.

pub fn layout(&self, dir: impl AsRef<Path>) -> Vec<LayoutEntry>

Every role of the layout, with whether its path exists under dir (a regular file for main/lib, a directory for the rest).

Trait Implementations

impl Clone for AppManifest

fn clone(&self) -> AppManifest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AppManifest

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

Formats the value using the given formatter.

impl Default for AppManifest

fn default() -> AppManifest

Returns the “default value” for a type.

impl Eq for AppManifest

impl FromStr for AppManifest

type Err = ManifestError

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<AppManifest, ManifestError>

Parses a string s to return a value of this type.

impl PartialEq for AppManifest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AppManifest