Struct cargo_toml::Package

source · [−]

pub struct Package<Metadata = Value> {Show 24 fields
    pub name: String,
    pub edition: Edition,
    pub version: String,
    pub build: Option<Value>,
    pub workspace: Option<String>,
    pub authors: Vec<String>,
    pub links: Option<String>,
    pub description: Option<String>,
    pub homepage: Option<String>,
    pub documentation: Option<String>,
    pub readme: Option<String>,
    pub keywords: Vec<String>,
    pub categories: Vec<String>,
    pub license: Option<String>,
    pub license_file: Option<String>,
    pub repository: Option<String>,
    pub default_run: Option<String>,
    pub autobins: bool,
    pub autoexamples: bool,
    pub autotests: bool,
    pub autobenches: bool,
    pub publish: Publish,
    pub resolver: Option<Resolver>,
    pub metadata: Option<Metadata>,
}

Expand description

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

Fields

name: String

Careful: some names are uppercase

edition: Editionversion: String

e.g. “1.9.0”

build: Option<Value>workspace: Option<String>authors: Vec<String>

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

links: Option<String>description: Option<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<String>documentation: Option<String>readme: Option<String>

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

keywords: Vec<String>categories: 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”]

license: Option<String>

e.g. “MIT”

license_file: Option<String>repository: Option<String>default_run: Option<String>

The default binary to run by cargo run.

autobins: boolautoexamples: boolautotests: boolautobenches: boolpublish: Publishresolver: Option<Resolver>

“2” is the only useful value

metadata: Option<Metadata>

Trait Implementations

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

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

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

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

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

Formats the value using the given formatter. Read more

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. Read more

impl<Metadata: PartialEq> PartialEq<Package<Metadata>> 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 ==. Read more

fn ne(&self, other: &Package<Metadata>) -> bool

This method tests for !=.

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. Read more

impl<Metadata> StructuralPartialEq for Package<Metadata>

Auto Trait Implementations

impl<Metadata> RefUnwindSafe for Package<Metadata> where
Metadata: RefUnwindSafe,

impl<Metadata> Send for Package<Metadata> where
Metadata: Send,

impl<Metadata> Sync for Package<Metadata> where
Metadata: Sync,

impl<Metadata> Unpin for Package<Metadata> where
Metadata: Unpin,

impl<Metadata> UnwindSafe for Package<Metadata> where
Metadata: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

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

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

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

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

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

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

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,