TomlPackage in cargo_util_schemas::manifest - Rust
Description: Represents the `package`/`project` sections of a `Cargo.toml`.

Skip to main content

## TomlPackage

# Struct TomlPackage

Source

    pub struct TomlPackage {Show 33 fields
        pub edition: Option<InheritableString>,
        pub rust_version: Option<InheritableRustVersion>,
        pub name: Option<PackageName>,
        pub version: Option<InheritableSemverVersion>,
        pub authors: Option<InheritableVecString>,
        pub build: Option<TomlPackageBuild>,
        pub metabuild: Option<StringOrVec>,
        pub default_target: Option<String>,
        pub forced_target: Option<String>,
        pub links: Option<String>,
        pub exclude: Option<InheritableVecString>,
        pub include: Option<InheritableVecString>,
        pub publish: Option<InheritableVecStringOrBool>,
        pub workspace: Option<String>,
        pub im_a_teapot: Option<bool>,
        pub autolib: Option<bool>,
        pub autobins: Option<bool>,
        pub autoexamples: Option<bool>,
        pub autotests: Option<bool>,
        pub autobenches: Option<bool>,
        pub default_run: Option<String>,
        pub description: Option<InheritableString>,
        pub homepage: Option<InheritableString>,
        pub documentation: Option<InheritableString>,
        pub readme: Option<InheritableStringOrBool>,
        pub keywords: Option<InheritableVecString>,
        pub categories: Option<InheritableVecString>,
        pub license: Option<InheritableString>,
        pub license_file: Option<InheritableString>,
        pub repository: Option<InheritableString>,
        pub resolver: Option<String>,
        pub metadata: Option<Value>,
        pub _invalid_cargo_features: Option<InvalidCargoFeatures>,
    }

Expand description

Represents the `package`/`project` sections of a `Cargo.toml`.

Note that the order of the fields matters, since this is the order they are serialized to a TOML file. For example, you cannot have values after the field `metadata`, since it is a table and values cannot appear after tables.

## Fields§

§`edition: Option<InheritableString>`§`rust_version: Option<InheritableRustVersion>`§`name: Option<PackageName>`§`version: Option<InheritableSemverVersion>`§`authors: Option<InheritableVecString>`§`build: Option<TomlPackageBuild>`§`metabuild: Option<StringOrVec>`§`default_target: Option<String>`§`forced_target: Option<String>`§`links: Option<String>`§`exclude: Option<InheritableVecString>`§`include: Option<InheritableVecString>`§`publish: Option<InheritableVecStringOrBool>`§`workspace: Option<String>`§`im_a_teapot: Option<bool>`§`autolib: Option<bool>`§`autobins: Option<bool>`§`autoexamples: Option<bool>`§`autotests: Option<bool>`§`autobenches: Option<bool>`§`default_run: Option<String>`§`description: Option<InheritableString>`§`homepage: Option<InheritableString>`§`documentation: Option<InheritableString>`§`readme: Option<InheritableStringOrBool>`§`keywords: Option<InheritableVecString>`§`categories: Option<InheritableVecString>`§`license: Option<InheritableString>`§`license_file: Option<InheritableString>`§`repository: Option<InheritableString>`§`resolver: Option<String>`§`metadata: Option<Value>`§`_invalid_cargo_features: Option<InvalidCargoFeatures>`

Provide a helpful error message for a common user error.

## Implementations§

Source§

### impl TomlPackage

Source

#### pub fn new(name: PackageName) -> Self

Source

#### pub fn normalized_name(&self) -> Result<&PackageName, UnresolvedError>

Source

#### pub fn normalized_edition(&self) -> Result<Option<&String>, UnresolvedError>

Source

#### pub fn normalized_rust_version( &self, ) -> Result<Option<&RustVersion>, UnresolvedError>

Source

#### pub fn normalized_version(&self) -> Result<Option<&Version>, UnresolvedError>

Source

#### pub fn normalized_authors( &self, ) -> Result<Option<&Vec<String>>, UnresolvedError>

Source

#### pub fn normalized_build(&self) -> Result<Option<&[String]>, UnresolvedError>

Source

#### pub fn normalized_exclude( &self, ) -> Result<Option<&Vec<String>>, UnresolvedError>

Source

#### pub fn normalized_include( &self, ) -> Result<Option<&Vec<String>>, UnresolvedError>

Source

#### pub fn normalized_publish( &self, ) -> Result<Option<&VecStringOrBool>, UnresolvedError>

Source

#### pub fn normalized_description(&self) -> Result<Option<&String>, UnresolvedError>

Source

#### pub fn normalized_homepage(&self) -> Result<Option<&String>, UnresolvedError>

Source

#### pub fn normalized_documentation( &self, ) -> Result<Option<&String>, UnresolvedError>

Source

#### pub fn normalized_readme(&self) -> Result<Option<&String>, UnresolvedError>

Source

#### pub fn normalized_keywords( &self, ) -> Result<Option<&Vec<String>>, UnresolvedError>

Source

#### pub fn normalized_categories( &self, ) -> Result<Option<&Vec<String>>, UnresolvedError>

Source

#### pub fn normalized_license(&self) -> Result<Option<&String>, UnresolvedError>

Source

#### pub fn normalized_license_file( &self, ) -> Result<Option<&String>, UnresolvedError>

Source

#### pub fn normalized_repository(&self) -> Result<Option<&String>, UnresolvedError>

## Trait Implementations§

Source§

### impl Clone for TomlPackage

Source§

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

Returns a duplicate 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 TomlPackage

Source§

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

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

### impl Default for TomlPackage

Source§

#### fn default() -> TomlPackage

Returns the “default value” for a type. Read more
Source§

### impl<'de> Deserialize<'de> for TomlPackage

Source§

#### fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

### impl Serialize for TomlPackage

Source§

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

Serialize this value into the given Serde serializer. Read more

## Auto Trait Implementations§

§

### impl Freeze for TomlPackage

§

### impl RefUnwindSafe for TomlPackage

§

### impl Send for TomlPackage

§

### impl Sync for TomlPackage

§

### impl Unpin for TomlPackage

§

### impl UnsafeUnpin for TomlPackage

§

### impl UnwindSafe for TomlPackage

## Blanket Implementations§

Source§

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

Source§

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

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

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

Source§

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

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

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

Source§

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

Returns the argument unchanged.

Source§

### impl<T, U> Into<U> for T
where 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> Serialize for T
where T: Serialize + ?Sized,

Source§

#### fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

#### fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

Source§

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

Source§

#### 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### 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 T
where U: TryFrom<T>,

Source§

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

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

## 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: 736 bytes