Struct SharedProject

pub struct SharedProject(/* private fields */);

The shared project allows for many projects to share references to the same Project instance.

Implementations

impl SharedProject

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

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

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

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

pub fn guard<'g, T, F: Fn(&Project) -> &T + 'g>( &'g self, func: F, ) -> ProjectResult<Guard<'_, T>>

pub fn guard_mut<'g, T, F1, F2>( &'g self, ref_getter: F1, mut_getter: F2, ) -> ProjectResult<GuardMut<'_, T>>

where F1: Fn(&Project) -> &T + 'g, F2: Fn(&mut Project) -> &mut T + 'g,

pub fn tasks(&self) -> GuardMut<'_, TaskContainer>

pub fn register_task<T: Task + Send + Sync + Debug + 'static>( &self, id: &str, ) -> ProjectResult<TaskHandle<T>>

pub fn get_task(&self, id: &TaskId) -> ProjectResult<AnyTaskHandle>

Gets a task with a given name

pub fn get_typed_task<T: Task + Send + Sync>( &self, id: &TaskId, ) -> ProjectResult<TaskHandle<T>>

Gets a typed task

pub fn find_task<P: AsRef<TaskPath>>( &self, path: P, ) -> ProjectResult<AnyTaskHandle>

Finds a task, using this project as the base task

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

where P: AsRef<str>,

pub fn allprojects<F: Fn(&Project) + Clone>(&self, callback: F)

Executes a callback on this project and all sub projects

pub fn allprojects_mut<F: Fn(&mut Project) + Clone>(&self, callback: F)

Executes a callback on this project and all sub projects

pub fn task_container(&self) -> Guard<'_, TaskContainer>

Gets the task container for this project

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

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

Get access to the registries container

pub fn configurations_mut(&mut self) -> GuardMut<'_, ConfigurationHandler>

Get a guard to the dependency container within the project

pub fn configurations(&self) -> Guard<'_, ConfigurationHandler>

Get a guard to the dependency container within the project

pub fn workspace(&self) -> Guard<'_, Workspace>

pub fn apply_plugin<P: Plugin<Project>>(&self) -> ProjectResult

Apply a plugin to this.

Trait Implementations

impl Clone for SharedProject

fn clone(&self) -> SharedProject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CreateProjectDependencies for SharedProject

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

Creates an inter-project dependency with the default configuration

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

Creates an inter-project dependency with a given configuration

impl Debug for SharedProject

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

Formats the value using the given formatter.

impl Default for SharedProject

fn default() -> Self

Returns the “default value” for a type.

impl Display for SharedProject

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

Formats the value using the given formatter.

impl From<Arc<(RwLock<RawRwLock, Project>, ProjectId)>> for SharedProject

fn from(arc: Arc<(RwLock<Project>, ProjectId)>) -> Self

Converts to this type from the input type.

impl GetProjectId for SharedProject

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 TryFrom<Weak<(RwLock<RawRwLock, Project>, ProjectId)>> for SharedProject

type Error = ()

The type returned in the event of a conversion error.

fn try_from( value: Weak<(RwLock<Project>, ProjectId)>, ) -> Result<Self, Self::Error>

Performs the conversion.