Struct cargo::core::package::Package

pub struct Package {
    inner: Rc<PackageInner>,
}

Information about a package that is available somewhere in the file system.

A package is a Cargo.toml file plus all the files that are part of it.

Fields

inner: Rc<PackageInner>

Implementations

impl Package

pub fn new(manifest: Manifest, manifest_path: &Path) -> Package

Creates a package from a manifest and its location.

pub fn dependencies(&self) -> &[Dependency]

Gets the manifest dependencies.

pub fn manifest(&self) -> &Manifest

Gets the manifest.

pub fn manifest_mut(&mut self) -> &mut Manifest

Gets the manifest.

pub fn manifest_path(&self) -> &Path

Gets the path to the manifest.

pub fn name(&self) -> InternedString

Gets the name of the package.

pub fn package_id(&self) -> PackageId

Gets the PackageId object for the package (fully defines a package).

pub fn root(&self) -> &Path

Gets the root folder of the package.

pub fn summary(&self) -> &Summary

Gets the summary for the package.

pub fn targets(&self) -> &[Target]

Gets the targets specified in the manifest.

pub fn library(&self) -> Option<&Target>

Gets the library crate for this package, if it exists.

pub fn version(&self) -> &Version

Gets the current package version.

pub fn authors(&self) -> &Vec<String>

Gets the package authors.

pub fn publish(&self) -> &Option<Vec<String>>

Returns None if the package is set to publish. Returns Some(allowed_registries) if publishing is limited to specified registries or if package is set to not publish.

pub fn proc_macro(&self) -> bool

Returns true if this package is a proc-macro.

pub fn rust_version(&self) -> Option<&RustVersion>

Gets the package’s minimum Rust version.

pub fn has_custom_build(&self) -> bool

Returns true if the package uses a custom build script for any target.

pub fn map_source(self, to_replace: SourceId, replace_with: SourceId) -> Package

pub fn to_registry_toml(&self, ws: &Workspace<'_>) -> CargoResult<String>

pub fn include_lockfile(&self) -> bool

Returns if package should include Cargo.lock.

pub fn serialized(&self) -> SerializedPackage

Trait Implementations

impl Clone for Package

fn clone(&self) -> Package

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Package

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

Formats the value using the given formatter.

impl Display for Package

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

Formats the value using the given formatter.

impl Hash for Package

fn hash<H: Hasher>(&self, into: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Package

fn cmp(&self, other: &Package) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Package> for Package

fn eq(&self, other: &Package) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Package> for Package

fn partial_cmp(&self, other: &Package) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Package

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes