Struct Metadata

#[non_exhaustive]
pub struct Metadata {
    pub packages: Vec<Package>,
    pub workspace_members: Vec<PackageId>,
    pub workspace_default_members: WorkspaceDefaultMembers,
    pub resolve: Option<Resolve>,
    pub workspace_root: Utf8PathBuf,
    pub target_directory: Utf8PathBuf,
    pub workspace_metadata: Value,
    /* private fields */
}

Starting point for metadata returned by cargo metadata

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.

packages: Vec<Package>

A list of all crates referenced by this crate (and the crate itself)

workspace_members: Vec<PackageId>

A list of all workspace members

workspace_default_members: WorkspaceDefaultMembers

The list of default workspace members

This not available if running with a version of Cargo older than 1.71.

resolve: Option<Resolve>

Dependencies graph

workspace_root: Utf8PathBuf

Workspace root

target_directory: Utf8PathBuf

Build directory

workspace_metadata: Value

The workspace-level metadata object. Null if non-existent.

Implementations

impl Metadata

pub fn root_package(&self) -> Option<&Package>

Get the workspace’s root package of this metadata instance.

pub fn workspace_packages(&self) -> Vec<&Package>

Get the workspace packages.

pub fn workspace_default_packages(&self) -> Vec<&Package>

Get the workspace default packages.

Panics

This will panic if running with a version of Cargo older than 1.71.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<Metadata, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> Index<&'a PackageId> for Metadata

type Output = Package

The returned type after indexing.

fn index(&self, idx: &'a PackageId) -> &Package

Performs the indexing (container[index]) operation.

impl Serialize for Metadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.