Struct cargo_deb::manifest::Config

pub struct Config {

    pub manifest_dir: PathBuf,
    pub deb_output_path: Option<String>,
    pub target: Option<String>,
    pub target_dir: PathBuf,
    pub name: String,
    pub deb_name: String,
    pub deb_version: String,
    pub license: Option<String>,
    pub license_file: Option<PathBuf>,
    pub license_file_skip_lines: usize,
    pub copyright: String,
    pub changelog: Option<String>,
    pub homepage: Option<String>,
    pub documentation: Option<String>,
    pub repository: Option<String>,
    pub description: String,
    pub extended_description: Option<String>,
    pub maintainer: String,
    pub depends: String,
    pub recommends: Option<String>,
    pub section: Option<String>,
    pub priority: String,
    pub conflicts: Option<String>,
    pub breaks: Option<String>,
    pub replaces: Option<String>,
    pub provides: Option<String>,
    pub architecture: String,
    pub conf_files: Option<String>,
    pub triggers_file: Option<PathBuf>,
    pub maintainer_scripts: Option<PathBuf>,
    pub features: Vec<String>,
    pub default_features: bool,
    pub strip: bool,
    pub separate_debug_symbols: bool,
    pub preserve_symlinks: bool,
    // some fields omitted
}

Cargo deb configuration read from the manifest and cargo metadata

Fields

manifest_dir: PathBuf

Root directory where Cargo.toml is located. It’s a subdirectory in workspaces.

deb_output_path: Option<String>

User-configured output path for *.deb

target: Option<String>

Triple. None means current machine architecture.

target_dir: PathBuf

CARGO_TARGET_DIR

name: String

The name of the project to build

deb_name: String

The name to give the Debian package; usually the same as the Cargo project name

deb_version: String

The version to give the Debian package; usually the same as the Cargo version

license: Option<String>

The software license of the project (SPDX format).

license_file: Option<PathBuf>

The location of the license file

license_file_skip_lines: usize

number of lines to skip when reading license_file

copyright: String

The copyright of the project (Debian’s copyright file contents).

changelog: Option<String>

homepage: Option<String>

The homepage URL of the project.

documentation: Option<String>

Documentation URL from Cargo.toml. Fallback if homepage is missing.

repository: Option<String>

The URL of the software repository.

description: String

A short description of the project.

extended_description: Option<String>

An extended description of the project.

maintainer: String

The maintainer of the Debian package. In Debian control file Maintainer field format.

depends: String

The Debian dependencies required to run the project.

recommends: Option<String>

The Debian recommended dependencies.

section: Option<String>

The Debian software category to which the package belongs.

priority: String

The Debian priority of the project. Typically ‘optional’.

conflicts: Option<String>

Conflicts Debian control field.

See PackageTransition.

breaks: Option<String>

Breaks Debian control field.

See PackageTransition.

replaces: Option<String>

Replaces Debian control field.

See PackageTransition.

provides: Option<String>

Provides Debian control field.

See PackageTransition.

architecture: String

The Debian architecture of the target system.

conf_files: Option<String>

A list of configuration files installed by the package.

triggers_file: Option<PathBuf>

The location of the triggers file

maintainer_scripts: Option<PathBuf>

The path where possible maintainer scripts live

features: Vec<String>

List of Cargo features to use during build

default_features: bool

strip: bool

Should the binary be stripped from debug symbols?

separate_debug_symbols: bool

Should the debug symbols be moved to a separate file included in the package? (implies strip:true)

preserve_symlinks: bool

Should symlinks be preserved in the assets

Implementations

impl Config

pub fn from_manifest(
    manifest_path: &Path,
    package_name: Option<&str>,
    output_path: Option<String>,
    target: Option<&str>,
    variant: Option<&str>,
    deb_version: Option<String>,
    listener: &dyn Listener
) -> CDResult<Config>

Makes a new config from Cargo.toml in the current working directory.

None target means the host machine’s architecture.

pub fn resolve_assets(&mut self) -> CDResult<()>

pub fn add_debug_assets(&mut self)

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.