Struct cargo::core::package::Package

pub struct Package { /* fields omitted */ }

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.

Methods

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 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 true if the package is set to publish.

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, config: &Config) -> CargoResult<String>

pub fn include_lockfile(&self) -> bool

Returns if package should include Cargo.lock.

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 Eq for Package

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, 

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) -> Self

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

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 ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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.

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 Serialize for Package

fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.