Struct Project 

pub struct Project {

    pub aliases: Vec<ProjectAlias>,
    pub config: ProjectConfig,
    pub dependencies: Vec<ProjectDependencyConfig>,
    pub file_groups: BTreeMap<Id, FileGroup>,
    pub id: Id,
    pub inherited: Option<InheritedTasks>,
    pub language: LanguageType,
    pub layer: LayerType,
    pub root: PathBuf,
    pub source: WorkspaceRelativePathBuf,
    pub stack: StackType,
    pub tasks: BTreeMap<Id, Task>,
    pub task_targets: Vec<Target>,
    pub toolchains: Vec<Id>,
}

Fields

aliases: Vec<ProjectAlias>

Unique aliases derived from plugins, typically toolchain manifests.

config: ProjectConfig

Project configuration loaded from “moon.*”, if it exists.

dependencies: Vec<ProjectDependencyConfig>

List of other projects this project depends on.

file_groups: BTreeMap<Id, FileGroup>

File groups specific to the project. Inherits all file groups from the global config.

id: Id

Unique ID for the project. Is the LHS of the projects setting.

inherited: Option<InheritedTasks>

Task configuration that was inherited from “.moon/tasks”.

language: LanguageType

Primary programming language of the project.

layer: LayerType

The type of layer within the stack. Is used for layer constraints.

root: PathBuf

Absolute path to the project’s root folder.

source: WorkspaceRelativePathBuf

Relative path from the workspace root to the project root.

stack: StackType

The technology stack of the project.

tasks: BTreeMap<Id, Task>

Tasks specific to the project. Inherits all tasks from the global config. Note: This map is empty when the project is in the project graph!

task_targets: Vec<Target>

List of targets of all tasks configured or inherited for the project. Includes internal tasks!

toolchains: Vec<Id>

Toolchains derived from the configured language.

Implementations

impl Project

pub fn get_dependency_ids(&self) -> Vec<&Id>

Return a list of project IDs this project depends on.

pub fn get_enabled_toolchains(&self) -> Vec<&Id>

Return a list of all toolchains that are enabled for this project. Toolchains can be disabled through config.

pub fn get_enabled_toolchains_for_task<'task>( &self, task: &'task Task, ) -> Vec<&'task Id>

Return a list of all task specific toolchains that are enabled for this project. Toolchains can be disabled through config.

pub fn get_file_group( &self, group_id: impl AsRef<str>, ) -> Result<&FileGroup, ProjectError>

Return the file group by ID or fail with an error.

pub fn get_task(&self, task_id: impl AsRef<str>) -> Result<&Task, ProjectError>

Return the task by ID or fail with an error.

pub fn is_root_level(&self) -> bool

Return true if the root-level project.

pub fn matches_locator(&self, locator: &str) -> bool

Return true if the provided locator string (an ID or alias) matches the current project.

pub fn to_fragment(&self) -> ProjectFragment

Convert the project into a fragment.

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.

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

where Project: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Project

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

Formats the value using the given formatter.

impl PartialEq for Project

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.