Struct DistPackageConfig

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

Configuration for the distribution of the package.

Implementations

impl<'a> DistPackageConfig<'a>

pub fn name(&self) -> &str

Returns the name of the package.

pub fn metadata(&self) -> &'a Package

Returns the metadata of the package.

pub fn targets(&self) -> &[DistTargetConfig<'_>]

Returns the list of targets to be distributed.

Targets can be added by associated functions of DistPackageConfigBuilder.

If no targets are added, the list of targets is constructed from all binaries target of the package.

pub fn root_directory(&self) -> &Utf8Path

Returns the path to the package’s root directory.

pub fn cargo_build_options(&self) -> &[String]

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

Returns the list of cargo build options to be used when building the

pub fn license_files(&self) -> &[Utf8PathBuf]

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

Returns the list of license files to be distributed.

License files can be added by DistPackageConfigBuilder::license_files function.

If no license files are added, the list of license files is constructed from the license-file field of the [package] section of the manifest.

If no license files are added and the license-file field is not present, the file matches the pattern /^LICENSE(?:-|_|\.|$)/i in the root directory of the package.

pub fn documents(&self) -> &[Utf8PathBuf]

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

Returns the list of documentation files to be distributed.

Documentation files can be added by DistPackageConfigBuilder::documents function. If no documentation files are added, this function returns empty list.

Trait Implementations

impl<'a> Debug for DistPackageConfig<'a>

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

Formats the value using the given formatter.