Struct Settings

pub struct Settings { /* private fields */ }

Declares the configuration required to instantiate and configure the hierarchy of SharedProject which are part of this build. There’s exactly one settings instance that’s created per settings file.

Assembling a mutli-project build

One of the purposes of the Settings object is to allow you to declare projects which are included in this build.

When included, a ProjectDescriptor is created which can be used to configure the default values for several properties of the project.

Using Settings in a Settings File

Depends on the builder..

Implementations

impl Settings

pub fn new( assemble: &Arc<RwLock<RawRwLock, Assemble>>, root_dir: PathBuf, settings_file: PathBuf, ) -> Settings

Create a new Settings instance.

pub fn root_project(&self) -> &ProjectDescriptor

Gets the root project descriptor

pub fn root_project_mut(&mut self) -> &mut ProjectDescriptor

Gets a mutable reference to the root project descriptor

pub fn add_project<S, F>(&mut self, path: S, configure: F)

where S: AsRef<str>, F: FnOnce(&mut ProjectBuilder),

Adds a child project to the root project

pub fn include<S>(&mut self, path: S)

where S: AsRef<str>,

Includes a project a path.

pub fn include_all<S, I>(&mut self, paths: I)

where S: AsRef<str>, I: IntoIterator<Item = S>,

Includes a project a path.

pub fn find_project(&self, path: impl AsRef<Path>) -> Option<&ProjectDescriptor>

Find a project within this build

pub fn find_project_mut( &mut self, path: impl AsRef<Path>, ) -> Option<&mut ProjectDescriptor>

Find a project within this build

pub fn children_projects( &self, proj: &ProjectDescriptor, ) -> impl IntoIterator<Item = &ProjectDescriptor>

Gets the child project of a given project

pub fn root_dir(&self) -> &Path

Gets the root directory of this build

pub fn set_build_file_name(&mut self, path: impl AsRef<str>)

pub fn assemble(&self) -> &Arc<RwLock<RawRwLock, Assemble>>

Gets the assemble instance

pub fn settings_file(&self) -> &Path

pub fn project_graph(&self) -> &ProjectGraph

Gets the project graph

Trait Implementations

impl Debug for Settings

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

Formats the value using the given formatter.

impl PluginAware for Settings

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

Gets a reference to the plugin manager for this value.

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

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 SettingsAware for Settings

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,