Struct cargo_test_support::registry::Package

pub struct Package { /* private fields */ }

A builder for creating a new package in a registry.

This uses “source replacement” using an automatically generated .cargo/config file to ensure that dependencies will use these packages instead of contacting crates.io. See source-replacement.md for more details on how source replacement works.

Call publish to finalize and create the package.

If no files are specified, an empty lib.rs file is automatically created.

The Cargo.toml file is automatically generated based on the methods called on Package (for example, calling dep() will add to the [dependencies] automatically). You may also specify a Cargo.toml file to override the generated one.

This supports different registry types:

• Regular source replacement that replaces crates.io (the default).
• A “local registry” which is a subset for vendoring (see Package::local).
• An “alternative registry” which requires specifying the registry name (see Package::alternative).

This does not support “directory sources”. See directory.rs for VendorPackage which implements directory sources.

Example

use cargo_test_support::registry::Package;
use cargo_test_support::project;

// Publish package "a" depending on "b".
Package::new("a", "1.0.0")
    .dep("b", "1.0.0")
    .file("src/lib.rs", r#"
        extern crate b;
        pub fn f() -> i32 { b::f() * 2 }
    "#)
    .publish();

// Publish package "b".
Package::new("b", "1.0.0")
    .file("src/lib.rs", r#"
        pub fn f() -> i32 { 12 }
    "#)
    .publish();

// Create a project that uses package "a".
let p = project()
    .file("Cargo.toml", r#"
        [package]
        name = "foo"
        version = "0.0.1"

        [dependencies]
        a = "1.0"
    "#)
    .file("src/main.rs", r#"
        extern crate a;
        fn main() { println!("{}", a::f()); }
    "#)
    .build();

p.cargo("run").with_stdout("24").run();

Implementations

impl Package

pub fn new(name: &str, vers: &str) -> Package

Creates a new package builder. Call publish() to finalize and build the package.

pub fn local(&mut self, local: bool) -> &mut Package

Call with true to publish in a “local registry”.

See source-replacement.html#local-registry-sources for more details on local registries. See local_registry.rs for the tests that use this.

pub fn alternative(&mut self, alternative: bool) -> &mut Package

Call with true to publish in an “alternative registry”.

The name of the alternative registry is called “alternative”.

See src/doc/src/reference/registries.md for more details on alternative registries. See alt_registry.rs for the tests that use this.

pub fn file(&mut self, name: &str, contents: &str) -> &mut Package

Adds a file to the package.

pub fn file_with_mode( &mut self, path: &str, mode: u32, contents: &str, ) -> &mut Package

Adds a file with a specific Unix mode.

pub fn symlink(&mut self, dst: &str, src: &str) -> &mut Package

Adds a symlink to a path to the package.

pub fn extra_file(&mut self, path: &str, contents: &str) -> &mut Package

Adds an “extra” file that is not rooted within the package.

Normal files are automatically placed within a directory named $PACKAGE-$VERSION. This allows you to override that behavior, typically for testing invalid behavior.

pub fn dep(&mut self, name: &str, vers: &str) -> &mut Package

Adds a normal dependency. Example:

[dependencies]
foo = {version = "1.0"}

pub fn feature_dep( &mut self, name: &str, vers: &str, features: &[&str], ) -> &mut Package

Adds a dependency with the given feature. Example:

[dependencies]
foo = {version = "1.0", "features": ["feat1", "feat2"]}

pub fn target_dep( &mut self, name: &str, vers: &str, target: &str, ) -> &mut Package

Adds a platform-specific dependency. Example:

[target.'cfg(windows)'.dependencies]
foo = {version = "1.0"}

pub fn registry_dep(&mut self, name: &str, vers: &str) -> &mut Package

Adds a dependency to the alternative registry.

pub fn dev_dep(&mut self, name: &str, vers: &str) -> &mut Package

Adds a dev-dependency. Example:

[dev-dependencies]
foo = {version = "1.0"}

pub fn build_dep(&mut self, name: &str, vers: &str) -> &mut Package

Adds a build-dependency. Example:

[build-dependencies]
foo = {version = "1.0"}

pub fn add_dep(&mut self, dep: &Dependency) -> &mut Package

pub fn yanked(&mut self, yanked: bool) -> &mut Package

Specifies whether or not the package is “yanked”.

pub fn proc_macro(&mut self, proc_macro: bool) -> &mut Package

Specifies whether or not this is a proc macro.

pub fn feature(&mut self, name: &str, deps: &[&str]) -> &mut Package

Adds an entry in the [features] section.

pub fn rust_version(&mut self, rust_version: &str) -> &mut Package

Specify a minimal Rust version.

pub fn invalid_json(&mut self, invalid: bool) -> &mut Package

Causes the JSON line emitted in the index to be invalid, presumably causing Cargo to skip over this version.

pub fn links(&mut self, links: &str) -> &mut Package

pub fn cargo_feature(&mut self, feature: &str) -> &mut Package

pub fn schema_version(&mut self, version: u32) -> &mut Package

Sets the index schema version for this package.

See cargo::sources::registry::IndexPackage for more information.

pub fn publish(&self) -> String

Creates the package and place it in the registry.

This does not actually use Cargo’s publishing system, but instead manually creates the entry in the registry on the filesystem.

Returns the checksum for the package.

pub fn archive_dst(&self) -> PathBuf

Returns the path to the compressed package file.