Struct cli_xtask::config::DistPackageConfigBuilder

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

Configures and constructs DistPackageConfig.

This struct is build from DistConfigBuilder.

Examples

Creates DistConfigBuilder and DistPackageConfigBuilder from the workspace root package:

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

let workspace = workspace::current();

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

Creates DistConfigBuilder and DistPackageConfigBuilder from the name of package:

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)?;

Creates DistPackageConfigBuilder from the name of package and DistConfigBuilder:

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()?;

Implementations

impl<'a> DistPackageConfigBuilder<'a>

pub fn all_binaries(&self) -> Vec<DistTargetConfigBuilder<'a>>

Creates new DistTargetConfigBuilders from all binary targets of the package.

Errors

Returns an error if the DistTargetConfig cannot be built.

Examples

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

let workspace = workspace::current();

let (dist_config, pkg_config) = DistConfigBuilder::from_package_name(workspace, "xtask")?;
let target_builders = pkg_config.all_binaries();
let targets = target_builders
    .into_iter()
    .map(DistTargetConfigBuilder::build)
    .collect::<Result<Vec<_>>>()?;
let pkg_config = pkg_config.targets(targets).build()?;
let dist_config = dist_config.package(pkg_config).build()?;

let target = &dist_config.packages()[0].targets()[0];
assert_eq!(target.name(), "xtask");

pub fn all_targets(&self, kind: &str) -> Vec<DistTargetConfigBuilder<'a>>

Creates new DistTargetConfigBuilders from given kind of targets in the package.

Errors

Returns an error if the DistTargetConfig cannot be built.

Examples

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

let workspace = workspace::current();

let (dist_config, pkg_config) = DistConfigBuilder::from_package_name(workspace, "cli-xtask")?;
let target_builders = pkg_config.all_targets("lib");
let targets = target_builders
    .into_iter()
    .map(DistTargetConfigBuilder::build)
    .collect::<Result<Vec<_>>>()?;
let pkg_config = pkg_config.targets(targets).build()?;
let dist_config = dist_config.package(pkg_config).build()?;

let target = &dist_config.packages()[0].targets()[0];
assert_eq!(target.name(), "cli-xtask");

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

Create a new DistTargetConfigBuilder from the name of the binary target.

Errors

Returns an error if the binary target with the given name is not found.

Examples

use cli_xtask::{
    clap::CommandFactory,
    config::{DistConfigBuilder, DistTargetConfigBuilder},
    workspace, Result,
};

let workspace = workspace::current();

let (dist_config, pkg_config) = DistConfigBuilder::from_package_name(workspace, "xtask")?;
let target_builder = pkg_config.binary_by_name("xtask")?;
let target = target_builder.build()?;
let pkg_config = pkg_config.target(target).build()?;
let dist_config = dist_config.package(pkg_config).build()?;

let target = &dist_config.packages()[0].targets()[0];
assert_eq!(target.name(), "xtask");

pub fn target_by_name(
    &self,
    name: &str,
    kind: &str
) -> Result<DistTargetConfigBuilder<'a>>

Create a new DistTargetConfigBuilder from the name and kind of the target.

Errors

Returns an error if the target with the given name and kind is not found.

Examples

use cli_xtask::{
    clap::CommandFactory,
    config::{DistConfigBuilder, DistTargetConfigBuilder},
    workspace, Result,
};

let workspace = workspace::current();

let (dist_config, pkg_config) = DistConfigBuilder::from_package_name(workspace, "cli-xtask")?;
let target_builder = pkg_config.target_by_name("cli-xtask", "lib")?;
let target = target_builder.build()?;
let pkg_config = pkg_config.target(target).build()?;
let dist_config = dist_config.package(pkg_config).build()?;

let target = &dist_config.packages()[0].targets()[0];
assert_eq!(target.name(), "cli-xtask");

pub fn target(self, target: DistTargetConfig<'a>) -> Self

Add a target of the package to the list of targets to be distributed.

Examples

use cli_xtask::{
    clap::CommandFactory,
    config::{DistConfigBuilder, DistTargetConfigBuilder},
    workspace, Result,
};

let workspace = workspace::current();

let (dist_config, pkg_config) = DistConfigBuilder::from_package_name(workspace, "cli-xtask")?;
let target_builder = pkg_config.target_by_name("cli-xtask", "lib")?;
let target = target_builder.build()?;
let pkg_config = pkg_config.target(target).build()?;
let dist_config = dist_config.package(pkg_config).build()?;

let target = &dist_config.packages()[0].targets()[0];
assert_eq!(target.name(), "cli-xtask");

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

Add a targets of the package to the list of targets to be distributed.

Examples

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

let workspace = workspace::current();

let (dist_config, pkg_config) = DistConfigBuilder::from_package_name(workspace, "cli-xtask")?;
let target_builders = pkg_config.all_targets("lib");
let targets = target_builders
    .into_iter()
    .map(DistTargetConfigBuilder::build)
    .collect::<Result<Vec<_>>>()?;
let pkg_config = pkg_config.targets(targets).build()?;
let dist_config = dist_config.package(pkg_config).build()?;

let target = &dist_config.packages()[0].targets()[0];
assert_eq!(target.name(), "cli-xtask");

pub fn license_files(self, files: impl IntoIterator<Item = Utf8PathBuf>) -> Self

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

Adds a package license files to the list of files to be distributed.

If the given path is a relative path, it is resolved against the package root direcotry.

Examples

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

let workspace = workspace::current();

let (dist_config, pkg_config) = DistConfigBuilder::from_root_package(workspace)?;
let pkg_config = pkg_config.license_files(
    ["LICENSE-MIT", "LICENSE-APACHE"]
        .into_iter()
        .map(Into::into),
);

pub fn documents(self, files: impl IntoIterator<Item = Utf8PathBuf>) -> Self

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

Adds a package documentation files to the list of files to be distributed.

If the given path is a relative path, it is resolved against the package root direcotry.

Examples

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

let workspace = workspace::current();

let (dist_config, pkg_config) = DistConfigBuilder::from_root_package(workspace)?;
let pkg_config = pkg_config.documents(["CHANGELOG.md"].into_iter().map(Into::into));

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

Builds a DistPackageConfig from the current configuration.

Errors

Returns an error if the DistPackageConfig cannot be built.

Trait Implementations

impl<'a> Debug for DistPackageConfigBuilder<'a>

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

Formats the value using the given formatter.