Struct DistConfigBuilder

pub struct DistConfigBuilder<'a> { /* private fields */ }

Configures and constructs DistConfig.

Examples

use cli_xtask::{config::DistConfigBuilder, workspace};

let workspace = workspace::current();
let config = DistConfigBuilder::new("app", workspace).build()?;

Implementations

impl<'a> DistConfigBuilder<'a>

pub fn new(name: impl Into<String>, workspace: &'a Metadata) -> Self

Creates a new DistConfigBuilder from the given name.

Created DistConfig will be associated with current cargo workspace.

Examples

use cli_xtask::{config::DistConfigBuilder, workspace};

let workspace = workspace::current();
let config = DistConfigBuilder::new("app-v1.0", workspace).build()?;

pub fn from_default_packages( name: impl Into<String>, workspace: &'a Metadata, ) -> (Self, Vec<DistPackageConfigBuilder<'a>>)

Creates a new DistConfigBuilder from the default packages of the given workspace.

Created DistConfig will be associated with current cargo workspace.

Examples

use cli_xtask::{config::{DistConfigBuilder, DistPackageConfigBuilder}, workspace};

let workspace = workspace::current();

let (dist_config, pkg_configs) = DistConfigBuilder::from_default_packages("app-v1.0", workspace);
let pkg_configs = pkg_configs.into_iter().map(DistPackageConfigBuilder::build).collect::<Result<Vec<_>, _>>()?;
let dist_config = dist_config.packages(pkg_configs).build()?;

pub fn from_root_package( workspace: &'a Metadata, ) -> Result<(Self, DistPackageConfigBuilder<'a>)>

Creates a new DistConfigBuilder from the root package of given workspace.

The name of the created DistConfig will be generated from the name and version of the root package.

Errors

Returns an error if the root package is not found.

Examples

use cli_xtask::{config::DistConfigBuilder, workspace};

let workspace = workspace::current();

let (dist_config, pkg_config) = DistConfigBuilder::from_root_package(workspace)?;
let dist_config = dist_config.package(pkg_config.build()?).build()?;

let root_package = workspace.root_package().unwrap();
assert_eq!(
    dist_config.name(),
    format!("{}-v{}", root_package.name, root_package.version)
);

pub fn from_package_name( workspace: &'a Metadata, name: &str, ) -> Result<(Self, DistPackageConfigBuilder<'a>)>

Creates a new DistConfigBuilder from a package with the given name in the the given workspace.

The name of the created DistConfig will be generated from the name and version of the given package.

Errors

Returns an error if the package with the specified name is not found.

Examples

use cli_xtask::{config::DistConfigBuilder, workspace};

let workspace = workspace::current();
let package = workspace.workspace_packages()[0];

let (dist_config, pkg_config) = DistConfigBuilder::from_package_name(workspace, &package.name)?;
let dist_config = dist_config.package(pkg_config.build()?).build()?;

assert_eq!(
    dist_config.name(),
    format!("{}-v{}", package.name, package.version)
);

pub fn package_by_name( &self, name: &str, ) -> Result<DistPackageConfigBuilder<'a>>

Creates a new DistPackageConfigBuilder from the given package name.

Errors

Returns an error if the package with the specified name is not found.

Examples

use cli_xtask::{config::DistConfigBuilder, workspace};

let workspace = workspace::current();
let package = workspace.workspace_packages()[0];

let dist_config = DistConfigBuilder::new("app-dist", workspace);
let pkg_config = dist_config.package_by_name(&package.name)?.build()?;
let dist_config = dist_config.package(pkg_config).build()?;

pub fn package(self, package: DistPackageConfig<'a>) -> Self

Adds the given package to the DistConfig.

Examples

use cli_xtask::{config::DistConfigBuilder, workspace};

let workspace = workspace::current();
let package = workspace.workspace_packages()[0];

let dist_config = DistConfigBuilder::new("app-dist", workspace);
let pkg_config = dist_config.package_by_name(&package.name)?.build()?;
let dist_config = dist_config.package(pkg_config).build()?;

pub fn packages( self, packages: impl IntoIterator<Item = DistPackageConfig<'a>>, ) -> Self

Adds the given packages to the DistConfig.

Examples

use cli_xtask::{config::{DistConfigBuilder, DistPackageConfig}, workspace, Result};

let workspace = workspace::current();
let packages = workspace.workspace_packages();

let dist_config = DistConfigBuilder::new("app-dist", workspace);
let pkg_configs = packages.iter().map(|package| -> Result<DistPackageConfig> {
    let pkg_config = dist_config.package_by_name(&package.name)?.build()?;
    Ok(pkg_config)
}).collect::<Result<Vec<_>>>()?;
let dist_config = dist_config.packages(pkg_configs).build()?;

pub fn cargo_build_options( self, options: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Available on crate feature subcommand-dist-build-bin only.

Adds the given cargo build options to the DistConfig.

Examples

use cli_xtask::{config::{DistConfigBuilder, DistPackageConfig}, workspace, Result};

let workspace = workspace::current();
let packages = workspace.workspace_packages();

let dist_config = DistConfigBuilder::new("app-dist", workspace);
dist_config.cargo_build_options(["--features", "feature-a"]).build()?;

pub fn build(self) -> Result<DistConfig<'a>>

Builds a DistConfig from the current configuration.

Errors

Returns an error if the DistConfig cannot be built.

Trait Implementations

impl<'a> Debug for DistConfigBuilder<'a>

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

Formats the value using the given formatter.