# Struct cargo::core::package::Package

source ·

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

Expand description

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§

source§

### impl Package

source

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

Creates a package from a manifest and its location.

source

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

Gets the manifest dependencies.

source

#### pub fn manifest(&self) -> &Manifest

Gets the manifest.

source

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

Gets the manifest.

source

#### pub fn manifest_path(&self) -> &Path

Gets the path to the manifest.

source

#### pub fn name(&self) -> InternedString

Gets the name of the package.

source

#### pub fn package_id(&self) -> PackageId

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

source

#### pub fn root(&self) -> &Path

Gets the root folder of the package.

source

#### pub fn summary(&self) -> &Summary

Gets the summary for the package.

source

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

Gets the targets specified in the manifest.

source

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

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

source

#### pub fn version(&self) -> &Version

Gets the current package version.

source

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

Gets the package authors.

source

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

source

#### pub fn proc_macro(&self) -> bool

Returns `true` if this package is a proc-macro.

source

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

Gets the package’s minimum Rust version.

source

#### pub fn has_custom_build(&self) -> bool

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

source

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

source

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

source

#### pub fn include_lockfile(&self) -> bool

Returns if package should include `Cargo.lock`.

source

#### pub fn serialized(&self) -> SerializedPackage

## Trait Implementations§

source§

### impl Clone for Package

source§

#### fn clone(&self) -> Package

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for Package

source§

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

Formats the value using the given formatter. Read more
source§

### impl Display for Package

source§

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

Formats the value using the given formatter. Read more
source§

### impl Hash for Package

source§

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

Feeds this value into the given `Hasher`. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given `Hasher`. Read more
source§

### impl Ord for Package

source§

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

This method returns an `Ordering` between `self` and `other`. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

### impl PartialEq<Package> for Package

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

#### 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.
source§

### impl PartialOrd<Package> for Package

source§

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

This method returns an ordering between `self` and `other` values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more
1.0.0 · source§

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

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more
1.0.0 · source§

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

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

### impl Eq for Package

## Auto Trait Implementations§

§

### impl RefUnwindSafe for Package

§

### impl !Send for Package

§

### impl !Sync for Package

§

### impl Unpin for Package

§

### impl UnwindSafe for Package

## Blanket Implementations§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

### impl<Q, K> Comparable<K> for Qwhere Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

#### fn compare(&self, key: &K) -> Ordering

Compare self to `key` and return their ordering.
§

### impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

### impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

#### fn equivalent(&self, key: &K) -> bool

Compare self to `key` and return `true` if they are equal.
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T> Instrument for T

source§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
source§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
source§

### impl<T, U> Into<U> for Twhere U: From<T>,

source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source§

### impl<T> Same<T> for T

§

#### type Output = T

Should always be `Self`
source§

### impl<T> ToOwned for Twhere T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

### impl<T> ToString for Twhere T: Display + ?Sized,

source§

#### default fn to_string(&self) -> String

Converts the given value to a `String`. Read more
source§

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

#### fn vzip(self) -> V

source§

### impl<T> WithSubscriber for T

source§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
source§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more

## 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