Struct cargo_toml::Package

#[non_exhaustive]
pub struct Package<Metadata = Value> {

    pub name: String,
    pub edition: Inheritable<Edition>,
    pub rust_version: Option<Inheritable<String>>,
    pub version: Inheritable<String>,
    pub build: Option<OptionalFile>,
    pub workspace: Option<String>,
    pub authors: Inheritable<Vec<String>>,
    pub links: Option<String>,
    pub description: Option<Inheritable<String>>,
    pub homepage: Option<Inheritable<String>>,
    pub documentation: Option<Inheritable<String>>,
    pub readme: Inheritable<OptionalFile>,
    pub keywords: Inheritable<Vec<String>>,
    pub categories: Inheritable<Vec<String>>,
    pub exclude: Inheritable<Vec<String>>,
    pub include: Inheritable<Vec<String>>,
    pub license: Option<Inheritable<String>>,
    pub license_file: Option<Inheritable<PathBuf>>,
    pub repository: Option<Inheritable<String>>,
    pub default_run: Option<String>,
    pub autobins: bool,
    pub autoexamples: bool,
    pub autotests: bool,
    pub autobenches: bool,
    pub publish: Inheritable<Publish>,
    pub resolver: Option<Resolver>,
    pub metadata: Option<Metadata>,
}

The [package] section of the Manifest. This is where crate properties are.

Note that most of these properties can be inherited from a workspace, and therefore not available just from reading a single Cargo.toml. See Manifest::inherit_workspace.

You can replace Metadata generic type with your own to parse into something more useful than a generic toml Value

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Careful: some names are uppercase, case-sensitive. - changes to _ when used as a Rust identifier.

edition: Inheritable<Edition>

Package’s edition opt-in.

rust_version: Option<Inheritable<String>>

MSRV 1.x (beware: does not require semver formatting)

version: Inheritable<String>

Must parse as semver, e.g. “1.9.0”

build: Option<OptionalFile>

Build script definition

workspace: Option<String>

Workspace this package is a member of (None if it’s implicit)

authors: Inheritable<Vec<String>>

e.g. [“Author e@mail”, “etc”] Deprecated.

links: Option<String>

It doesn’t link to anything

description: Option<Inheritable<String>>

A short blurb about the package. This is not rendered in any format when uploaded to crates.io (aka this is not markdown).

homepage: Option<Inheritable<String>>

Project’s homepage

documentation: Option<Inheritable<String>>

Path to your custom docs. Unnecssary if you rely on docs.rs.

readme: Inheritable<OptionalFile>

This points to a file under the package root (relative to this Cargo.toml). implied if README.md, README.txt or README exists.

keywords: Inheritable<Vec<String>>

Up to 5, for search

categories: Inheritable<Vec<String>>

This is a list of up to five categories where this crate would fit. e.g. [“command-line-utilities”, “development-tools::cargo-plugins”]

exclude: Inheritable<Vec<String>>

Don’t publish these files

include: Inheritable<Vec<String>>

Publish these files

license: Option<Inheritable<String>>

e.g. “MIT”

license_file: Option<Inheritable<PathBuf>>

If license is not standard

repository: Option<Inheritable<String>>

(HTTPS) URL to crate’s repository

default_run: Option<String>

The default binary to run by cargo run.

autobins: bool

Discover binaries from the file system

autoexamples: bool

Discover examples from the file system

autotests: bool

Discover tests from the file system

autobenches: bool

Discover benchmarks from the file system

publish: Inheritable<Publish>

Disable publishing or select custom registries.

resolver: Option<Resolver>

“2” is the only useful value

metadata: Option<Metadata>

Arbitrary metadata of any type, an extension point for 3rd party tools.

Implementations

impl<Metadata> Package<Metadata>

pub fn new(name: impl Into<String>, version: impl Into<String>) -> Self

Prefer creating it by parsing a Manifest instead.

pub fn authors(&self) -> &[String]

Panics if the field is not available (inherited from a workspace that hasn’t been loaded)

pub fn categories(&self) -> &[String]

Panics if the field is not available (inherited from a workspace that hasn’t been loaded)

pub fn categories_mut(&mut self) -> &mut Vec<String>

Panics if the field is not available (inherited from a workspace that hasn’t been loaded)

pub fn description(&self) -> Option<&str>

Panics if the field is not available (inherited from a workspace that hasn’t been loaded)

pub fn set_description(&mut self, description: Option<String>)

pub fn documentation(&self) -> Option<&str>

Panics if the field is not available (inherited from a workspace that hasn’t been loaded)

pub fn set_documentation(&mut self, documentation: Option<String>)

pub fn edition(&self) -> Edition

Panics if the field is not available (inherited from a workspace that hasn’t been loaded)

pub fn exclude(&self) -> &[String]

Panics if the field is not available (inherited from a workspace that hasn’t been loaded)

pub fn include(&self) -> &[String]

Panics if the field is not available (inherited from a workspace that hasn’t been loaded)

pub fn homepage(&self) -> Option<&str>

Panics if the field is not available (inherited from a workspace that hasn’t been loaded)

pub fn set_homepage(&mut self, homepage: Option<String>)

pub fn keywords(&self) -> &[String]

Panics if the field is not available (inherited from a workspace that hasn’t been loaded)

pub fn license(&self) -> Option<&str>

Panics if the field is not available (inherited from a workspace that hasn’t been loaded)

pub fn license_file(&self) -> Option<&Path>

Panics if the field is not available (inherited from a workspace that hasn’t been loaded)

pub fn publish(&self) -> &Publish

Panics if the field is not available (inherited from a workspace that hasn’t been loaded)

pub fn readme(&self) -> &OptionalFile

Panics if the field is not available (inherited from a workspace that hasn’t been loaded)

pub fn repository(&self) -> Option<&str>

Panics if the field is not available (inherited from a workspace that hasn’t been loaded)

pub fn set_repository(&mut self, repository: Option<String>)

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

Panics if the field is not available (inherited from a workspace that hasn’t been loaded)

pub fn version(&self) -> &str

Panics if the field is not available (inherited from a workspace that hasn’t been loaded)

pub fn links(&self) -> Option<&str>

The property that doesn’t actually link with anything.

Can’t be inherited.

pub fn name(&self) -> &str

Name of the package/crate. Libraries and binaries can override it.

Can’t be inherited.

Trait Implementations

impl<Metadata: Clone> Clone for Package<Metadata>

fn clone(&self) -> Package<Metadata>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Metadata: Debug> Debug for Package<Metadata>

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

Formats the value using the given formatter.

impl<Metadata: Default> Default for Package<Metadata>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, Metadata> Deserialize<'de> for Package<Metadata>

where Metadata: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Metadata: PartialEq> PartialEq for Package<Metadata>

fn eq(&self, other: &Package<Metadata>) -> 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<Metadata> Serialize for Package<Metadata>

where Metadata: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Metadata: Eq> Eq for Package<Metadata>

impl<Metadata> StructuralEq for Package<Metadata>

impl<Metadata> StructuralPartialEq for Package<Metadata>