Struct Project

pub struct Project {
    pub root: PathBuf,
    pub main: (FileName, TreeName),
    pub files: HashMap<FileName, File>,
    pub std: HashSet<ActionName>,
}

the base structure represents the folder on the disk with some auxiliary info

Structure

• root is a root of the project. Every import relates to it.
• main is a pointer to the file and definition when the tree is started.
• files is a map of the files
• std is a set of the standard actions

Fields

root: PathBuf

main: (FileName, TreeName)

files: HashMap<FileName, File>

std: HashSet<ActionName>

Implementations

impl<'a> Project

pub fn find_file(&'a self, f_name: &str) -> Result<&'a File, TreeError>

pub fn find_root( &'a self, name: &TreeName, file: &FileName, ) -> Result<&'a Tree, TreeError>

pub fn find_tree(&self, file: &FileName, tree: &TreeName) -> Option<&Tree>

pub fn build_with_root( main_file: FileName, main_call: TreeName, root: PathBuf, ) -> Result<Project, TreeError>

build the project with the given root and main file

Suppose we have the following structure:

• root_folder
  • folder
    • main.tree # root tree_name
  • other.tree

Setting up the root as root_folder allows pulling in the other.tree file.

pub fn build(main_file: FileName, root: PathBuf) -> Result<Project, TreeError>

build the project with the given main file and root. The root will be found in the main file. If there are more than one root in the main file, the first one will be used.

pub fn build_from_text(text: String) -> Result<Project, TreeError>

build the project with the given text. The root will be empty.

Note

If there are some imports to the other files they will not work unless the imports are absolute,

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 Default for Project

fn default() -> Project

Returns the “default value” for a type.