Struct Manifest

pub struct Manifest<PackageMetadata = Value, WorkspaceMetadata = Value> {

    pub package: Option<Package<PackageMetadata>>,
    pub cargo_features: Option<Vec<String>>,
    pub workspace: Option<Workspace<WorkspaceMetadata>>,
    pub dependencies: Option<DepsSet>,
    pub dev_dependencies: Option<DepsSet>,
    pub build_dependencies: Option<DepsSet>,
    pub target: Option<TargetDepsSet>,
    pub features: Option<FeatureSet>,
    pub bin: Vec<Product>,
    pub bench: Vec<Product>,
    pub test: Vec<Product>,
    pub example: Vec<Product>,
    pub patch: Option<PatchSet>,
    pub lib: Option<Product>,
    pub profile: Option<Profiles>,
    pub badges: Option<Badges>,
}

The top-level Cargo.toml structure

The Metadata is a type for [package.metadata] table. You can replace it with your own struct type if you use the metadata and don’t want to use the catch-all Value type.

Fields

package: Option<Package<PackageMetadata>>

cargo_features: Option<Vec<String>>

workspace: Option<Workspace<WorkspaceMetadata>>

dependencies: Option<DepsSet>

dev_dependencies: Option<DepsSet>

build_dependencies: Option<DepsSet>

target: Option<TargetDepsSet>

features: Option<FeatureSet>

bin: Vec<Product>

Note that due to autobins feature this is not the complete list unless you run complete_from_path

bench: Vec<Product>

test: Vec<Product>

example: Vec<Product>

patch: Option<PatchSet>

lib: Option<Product>

Note that due to autolibs feature this is not the complete list unless you run complete_from_path

profile: Option<Profiles>

badges: Option<Badges>

Implementations

impl Manifest<Value>

pub fn from_slice(cargo_toml_content: &[u8]) -> Result<Self, Error>

Parse contents of a Cargo.toml file already loaded as a byte slice.

It does not call complete_from_path, so may be missing implicit data.

pub fn from_path(cargo_toml_path: impl AsRef<Path>) -> Result<Self, Error>

Parse contents from a Cargo.toml file on disk.

Calls complete_from_path.

impl<Metadata: for<'a> Deserialize<'a>> Manifest<Metadata>

pub fn from_slice_with_metadata( cargo_toml_content: &[u8], ) -> Result<Self, Error>

Parse Cargo.toml, and parse its [package.metadata] into a custom Serde-compatible type.

It does not call complete_from_path, so may be missing implicit data.

pub fn from_path_with_metadata( cargo_toml_path: impl AsRef<Path>, ) -> Result<Self, Error>

Parse contents from Cargo.toml file on disk, with custom Serde-compatible metadata type.

Calls complete_from_path

pub fn complete_from_path(&mut self, path: &Path) -> Result<(), Error>

Cargo.toml may not contain explicit information about [lib], [[bin]] and [package].build, which are inferred based on files on disk.

This scans the disk to make the data in the manifest as complete as possible.

pub fn complete_from_abstract_filesystem<FS: AbstractFilesystem>( &mut self, fs: &FS, ) -> Result<(), Error>

Cargo.toml may not contain explicit information about [lib], [[bin]] and [package].build, which are inferred based on files on disk.

You can provide any implementation of directory scan, which doesn’t have to be reading straight from disk (might scan a tarball or a git repo, for example).

pub fn autobins(&self) -> bool

pub fn autoexamples(&self) -> bool

pub fn autotests(&self) -> bool

pub fn autobenches(&self) -> bool

Trait Implementations

impl<PackageMetadata: Clone, WorkspaceMetadata: Clone> Clone for Manifest<PackageMetadata, WorkspaceMetadata>

fn clone(&self) -> Manifest<PackageMetadata, WorkspaceMetadata>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<PackageMetadata: Debug, WorkspaceMetadata: Debug> Debug for Manifest<PackageMetadata, WorkspaceMetadata>

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

Formats the value using the given formatter.

impl<PackageMetadata, WorkspaceMetadata> Default for Manifest<PackageMetadata, WorkspaceMetadata>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, PackageMetadata, WorkspaceMetadata> Deserialize<'de> for Manifest<PackageMetadata, WorkspaceMetadata>

where PackageMetadata: Deserialize<'de>, WorkspaceMetadata: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for Manifest<Value>

fn from_str(cargo_toml_content: &str) -> Result<Self, Self::Err>

Parse contents of a Cargo.toml file loaded as a string

Note: this is not a file name, but file’s content. See from_path.

It does not call complete_from_path, so may be missing implicit data.

type Err = Error

The associated error which can be returned from parsing.

impl<PackageMetadata: PartialEq, WorkspaceMetadata: PartialEq> PartialEq for Manifest<PackageMetadata, WorkspaceMetadata>

fn eq(&self, other: &Manifest<PackageMetadata, WorkspaceMetadata>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<PackageMetadata, WorkspaceMetadata> Serialize for Manifest<PackageMetadata, WorkspaceMetadata>

where PackageMetadata: Serialize, WorkspaceMetadata: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<PackageMetadata, WorkspaceMetadata> StructuralPartialEq for Manifest<PackageMetadata, WorkspaceMetadata>