Struct x_core::XCoreContext

pub struct XCoreContext { /* private fields */ }

Core context shared across all of x.

Implementations

impl XCoreContext

pub fn new( project_root: &'static Utf8Path, current_dir: Utf8PathBuf, config: XCoreConfig ) -> Result<Self>

Creates a new XCoreContext.

pub fn project_root(&self) -> &'static Utf8Path

Returns the project root for this workspace.

pub fn config(&self) -> &XCoreConfig

Returns the core config.

pub fn current_dir(&self) -> &Utf8Path

Returns the current working directory for this process.

pub fn current_rel_dir(&self) -> &Utf8Path

Returns the current working directory for this process, relative to the project root.

pub fn current_dir_is_root(&self) -> bool

Returns true if x has been run from the project root.

pub fn git_cli(&self) -> Result<&GitCli>

Returns the Git CLI for this workspace.

pub fn package_graph(&self) -> Result<&PackageGraph>

Returns the package graph for this workspace.

pub fn partition_workspace_names<'a, B>( &self, names: impl IntoIterator<Item = &'a str> ) -> Result<(B, B)>where B: Default + Extend<&'a str>,

For a given list of workspace packages, returns a tuple of (known, unknown) packages.

Initializes the package graph if it isn’t already done so, and returns an error if the

pub fn subsets(&self) -> Result<&WorkspaceSubsets<'_>>

Returns information about the subsets for this workspace.

pub fn hakari_builder(&self) -> Result<HakariBuilder<'_>>

Returns a Hakari builder for this workspace.

pub fn hakari_toml_options(&self) -> TomlOptions

Returns the default Hakari TOML options for this workspace.

Trait Implementations

impl Debug for XCoreContext

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

Formats the value using the given formatter.