Struct Project

pub struct Project { /* private fields */ }

The Project contains the tasks, layout information, and other related objects that would help with project building.

The project itself should be able to provide all information required to build a project, but should not be the driver of the building itself. Instead, project visitors should be driven to create project files.

By default, projects are created in the current directory.

Example

let mut task_provider = project.tasks().register_task::<Empty>("hello_world").expect("Couldn't create 'hello_task'");
task_provider.configure_with(|empty, _project| {
    empty.do_first(|_, _| {
        println!("Hello, World");
        Ok(())
    }).unwrap();
    Ok(())
}).unwrap();

Implementations

impl Project

pub fn new() -> Result<SharedProject, PayloadError<ProjectError>>

Create a new Project, with the current directory as the the directory to load

pub fn in_dir( path: impl AsRef<Path>, ) -> Result<SharedProject, PayloadError<ProjectError>>

Creates an assemble project in a specified directory.

pub fn with_id<I>(id: I) -> Result<SharedProject, PayloadError<ProjectError>>

where I: TryInto<ProjectId>, ProjectError: From<<I as TryInto<ProjectId>>::Error>,

Creates an assemble project in the current directory using an identifier

pub fn in_dir_with_id<Id, P>( path: P, id: Id, ) -> Result<SharedProject, PayloadError<ProjectError>>

where Id: TryInto<ProjectId>, P: AsRef<Path>, ProjectError: From<<Id as TryInto<ProjectId>>::Error>,

Creates an assemble project in a specified directory.

pub fn in_dir_with_id_and_root<Id, P>( path: P, id: Id, root: Option<&SharedProject>, settings: Option<Weak<RwLock<RawRwLock, Settings>>>, ) -> Result<SharedProject, PayloadError<ProjectError>>

where Id: TryInto<ProjectId>, P: AsRef<Path>, ProjectError: From<<Id as TryInto<ProjectId>>::Error>,

Creates an assemble project in a specified directory.

pub fn id(&self) -> &ProjectId

Get the id of the project

pub fn build_dir(&self) -> impl Provider<PathBuf> + Clone

Gets the directory where created files should be stored

pub fn set_build_dir(&mut self, dir: &str)

Always set as relative to the project dir

pub fn registered_tasks(&self) -> Vec<TaskId>

Gets a list of all tasks by TaskId

pub fn file<T>( &self, any_value: T, ) -> Result<RegularFile, PayloadError<ProjectError>>

where T: AsRef<Path>,

Create files using some valid types

Allowed types:

• &str
• String
• Path
• Regular File

pub fn visitor<R, V>(&self, visitor: &mut V) -> R

where V: VisitProject<R>,

Run a visitor on the project

pub fn visitor_mut<R, V>(&mut self, visitor: &mut V) -> R

where V: VisitMutProject<R>,

Run a mutable visitor on the project

pub fn project_dir(&self) -> PathBuf

The directory of the project

pub fn root_dir(&self) -> PathBuf

The project directory for the root directory

pub fn task_container(&self) -> &TaskContainer

Get access to the task container

pub fn task_container_mut(&mut self) -> &mut TaskContainer

Get access to the task container

pub fn variant( &self, variant: &str, ) -> Option<impl Provider<ConfigurableArtifact>>

Get an outgoing variant

pub fn as_shared(&self) -> SharedProject

Gets the shared reference version of this project

pub fn task_id_factory(&self) -> &TaskIdFactory

Gets the factory for generating task ids

pub fn properties(&self) -> &HashMap<String, Option<String>>

pub fn set_property(&mut self, key: String, value: impl Into<Option<String>>)

pub fn get_property(&self, key: &str) -> Option<&Option<String>>

pub fn has_property(&self, key: &str) -> bool

pub fn subprojects(&self) -> Vec<&SharedProject>

Gets the subprojects for this project.

pub fn default_tasks(&self) -> &Vec<TaskId>

Gets the default tasks for this project.

Default tasks are executed if no other tasks are provided.

pub fn set_default_tasks<I>(&mut self, iter: I)

where I: IntoIterator<Item = TaskId>,

Set the default tasks for this project.

pub fn registries_mut<F>( &mut self, configure: F, ) -> Result<(), PayloadError<ProjectError>>

where F: FnOnce(&mut RegistryContainer) -> Result<(), PayloadError<ProjectError>>,

apply a configuration function on the registries container

pub fn registries<R, F>( &self, configure: F, ) -> Result<R, PayloadError<ProjectError>>

where F: FnOnce(&RegistryContainer) -> Result<R, PayloadError<ProjectError>>,

apply a function on the registries container

pub fn configurations(&self) -> &ConfigurationHandler

Get the dependencies for this project

pub fn configurations_mut(&mut self) -> &mut ConfigurationHandler

Get a mutable reference to the dependencies container for this project

pub fn get_subproject<P>( &self, project: P, ) -> Result<&SharedProject, PayloadError<ProjectError>>

where P: AsRef<str>,

pub fn subproject<F>( &mut self, name: &str, configure: F, ) -> Result<(), PayloadError<ProjectError>>

where F: FnOnce(&mut Project) -> Result<(), PayloadError<ProjectError>>,

Create a sub project with a given name. The path used is the $PROJECT_DIR/name

pub fn subproject_in<P, F>( &mut self, name: &str, path: P, configure: F, ) -> Result<(), PayloadError<ProjectError>>

where F: FnOnce(&mut Project) -> Result<(), PayloadError<ProjectError>>, P: AsRef<Path>,

Create a sub project with a given name at a path.

pub fn root_project(&self) -> SharedProject

Gets the root project of this project.

pub fn parent_project(&self) -> Option<SharedProject>

Gets the parent project of this project, if it exists

pub fn variants(&self) -> &VariantHandler

The variants of this project

pub fn variants_mut(&mut self) -> &mut VariantHandler

The mutable variants of this project

Trait Implementations

impl CreateProjectDependencies for Project

fn project<S>(&self, path: S) -> ProjectDependency

where S: AsRef<str>,

Creates an inter-project dependency with the default configuration

fn project_with<P, C>(&self, path: P, config: C) -> ProjectDependency

where P: AsRef<str>, C: AsRef<str>,

Creates an inter-project dependency with a given configuration

impl Debug for Project

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

Formats the value using the given formatter.

impl Display for Project

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

Formats the value using the given formatter.

impl Drop for Project

fn drop(&mut self)

Executes the destructor for this type.

impl ExtensionAware for Project

fn extensions(&self) -> &ExtensionContainer

Gets the extension container

fn extensions_mut(&mut self) -> &mut ExtensionContainer

Gets a mutable reference to the extension container

fn extension<E>(&self) -> Result<&E, PayloadError<ProjectError>>

where E: Extension,

If a single extension is registered with a given type, a reference to that value is returned as Some(_)

fn extension_mut<E>(&mut self) -> Result<&mut E, PayloadError<ProjectError>>

where E: Extension,

If a single extension is registered with a given type, a mutable reference to that value is returned as Some(_)

impl GetProjectId for Project

fn project_id(&self) -> ProjectId

fn parent_id(&self) -> Option<ProjectId>

fn root_id(&self) -> ProjectId

fn is_root(&self) -> bool

Get whether this project is a root

impl Plugin<Project> for BasePlugin

fn apply_to( &self, project: &mut Project, ) -> Result<(), PayloadError<ProjectError>>

Apply the plugin

fn plugin_id(&self) -> &str

The id of the plugin. A plugin of a certain ID can only added once

impl Plugin<Project> for Plugin

fn apply_to(&self, _project: &mut Project) -> ProjectResult

Apply the plugin

fn plugin_id(&self) -> &str

The id of the plugin. A plugin of a certain ID can only added once

impl Plugin<Project> for ProjectDependencyPlugin

fn apply_to( &self, project: &mut Project, ) -> Result<(), PayloadError<ProjectError>>

Apply the plugin

fn plugin_id(&self) -> &str

The id of the plugin. A plugin of a certain ID can only added once

impl PluginAware for Project

fn plugin_manager(&self) -> &PluginManager<Project>

Gets a reference to the plugin manager for this value.

fn plugin_manager_mut(&mut self) -> &mut PluginManager<Project>

Gets a mutable reference to the plugin manager for this value.

fn apply_plugin<P>(&mut self) -> Result<(), PayloadError<ProjectError>>

where P: Plugin<Self>,

Apply a plugin to this.

impl ProjectExec for Project

fn exec<E>(&self, spec: E) -> ProjectResult<ExecHandle>

where E: Into<ExecSpec>,

Execute something that can be made into an ExecSpec

fn exec_with<F>(&self, config: F) -> ProjectResult<ExecResult>

where F: FnOnce(&mut ExecSpecBuilder),

Automatically executes a spec and logs output streams

fn builder(&self) -> ExecSpecBuilder

Create a new builder

impl ProjectResourceExt for Project

fn get_resource<R>( &self, resource: R, ) -> Result<Box<dyn Artifact>, PayloadError<InvalidResourceLocation>>

where R: TryInto<ResourceLocation>,

Try to get a resource from a project.

impl SettingsAware for Project

fn with_settings<F, R>(&self, func: F) -> R

where F: FnOnce(&Settings) -> R,

fn with_settings_mut<F, R>(&mut self, func: F) -> R

where F: FnOnce(&mut Settings) -> R,