Struct Workspace 

pub struct Workspace {
    pub cartridges: Vec<Cartridge>,
    pub module_roots: Vec<PathBuf>,
    pub paths: Vec<CartridgePath>,
    /* private fields */
}

Fields

cartridges: Vec<Cartridge>

module_roots: Vec<PathBuf>

cartridges/modules folders, which hold plain CommonJS modules such as server that are required without a cartridge/ segment.

paths: Vec<CartridgePath>

Implementations

impl Workspace

pub fn scan(roots: &[PathBuf], settings: &Value) -> Self

The heavier indexes are left until something asks for them.

pub fn cartridge_of(&self, file: &Path) -> Option<&Cartridge>

pub fn cartridges_from(&self, file: &Path) -> Vec<&Cartridge>

Every cartridge, with the one owning file first: */cartridge/... most often means “this cartridge, then the rest of the path”.

pub fn templates(&self) -> &[String]

Template paths as SFCC spells them: no locale folder, no .isml, forward slashes. Deduplicated, since the same path exists in every overriding cartridge.

pub fn resource_keys(&self) -> &HashSet<String>

Keys of every default bundle; which bundle is not recorded, since a form resolves labels against several.

pub fn controllers(&self) -> &Controllers

Trait Implementations

impl Debug for Workspace

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

Formats the value using the given formatter.

impl Default for Workspace

fn default() -> Workspace

Returns the “default value” for a type.