Struct umm::java::Project

pub struct Project {
    files: Vec<File>,
    names: Vec<String>,
    classpath: Vec<String>,
    sourcepath: Vec<String>,
    root_dir: String,
}

Struct representing a Java project. Any index i in any collection in this struct always refers to the same JavaFile.

Fields

files: Vec<File>

Collection of java files in this project

names: Vec<String>

Names of java files in this project.

classpath: Vec<String>

Classpath

sourcepath: Vec<String>

Source path

root_dir: String

Root directory

Implementations

impl Project

pub fn check_health(&self) -> Result<()>

Checks the project for common CodingRooms errors

impl Project

pub fn new() -> Result<Self>

Initializes a Project, by discovering java files in the UMM_DIR directory. Also downloads some jar files required for unit testing and mutation testing.

pub fn new_script() -> Result<Self, Box<EvalAltResult>>

Macro generated variant of #fn_name that returns EvalAltResult. This allows the function to be used in scripts.

pub fn identify(&self, name: &str) -> Result<File>

Attempts to identify the correct file from the project from a partial or fully formed name as expected by a java compiler.

Returns a reference to the identified file, if any.

• name: partial/fully formed name of the Java file to look for.

pub fn identify_mut_script( &mut self, name: &str ) -> Result<File, Box<EvalAltResult>>

Macro generated variant of #fn_name that returns EvalAltResult. This allows the function to be used in scripts.

pub fn contains(&self, name: &str) -> bool

Returns true if project contains a file with the given name.

pub async fn download_libraries_if_needed(&self) -> Result<()>

Downloads certain libraries like JUnit if found in imports. times out after 20 seconds.

pub async fn update_vscode_settings(&self) -> Result<()>

Creates a vscode settings.json file for the project.

pub fn files(&self) -> &[File]

Get a reference to the project’s files.

pub fn info(&self) -> Result<()>

Prints project struct as a json

pub fn info_script(&self) -> Result<(), Box<EvalAltResult>>

Macro generated variant of #fn_name that returns EvalAltResult. This allows the function to be used in scripts.

pub fn describe(&self) -> String

Returns a short summary of the project, it’s files, their fields and methods.

pub async fn update_vscode_tasks(&self) -> Result<()>

Writes a .vscode/tasks.json file for the project.

pub fn serve_project_code(&self) -> Result<()>

Serves the project code as a static website.

Trait Implementations

impl Clone for Project

fn clone(&self) -> Project

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CustomType for Project

fn build(builder: TypeBuilder<'_, Self>)

Builds the custom type for use with the [Engine].

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.

impl<'de> Deserialize<'de> for Project

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Project

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.