Struct Metadata 

#[non_exhaustive]
pub struct Metadata {
    pub version: VersionPin,
    pub app_exe: Option<PathBuf>,
    pub app_version_info: VersionInfo,
    pub target_dir: Option<Utf8PathBuf>,
    pub runtime_manifest: Utf8PathBuf,
    pub workspace: WorkspaceMetadata,
    pub packages: Vec<PackageMetadata>,
    pub compilation_units: Vec<CompilationUnitMetadata>,
    pub current_profile: String,
    pub profiles: Vec<String>,
    pub extra: HashMap<String, Value>,
}

Top level data structure printed by scarb 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.

version: VersionPin

The metadata format version.

This struct will not deserialize if version does not match.

app_exe: Option<PathBuf>

Path to scarb executable.

app_version_info: VersionInfo

Scarb’s version.

target_dir: Option<Utf8PathBuf>

Path to the target (build) directory if known by Scarb at the moment of generating metadata.

runtime_manifest: Utf8PathBuf

Path to the manifest of package or workspace that Scarb has been run from.

Compatibility

With very old Scarb versions (<0.5.0), this field may end up being empty path upon deserializing from scarb metadata call. In this case, fall back to WorkspaceMetadata.manifest field value.

workspace: WorkspaceMetadata

Current workspace metadata.

packages: Vec<PackageMetadata>

Metadata of all packages used in this workspace, or just members of it if this is an output of scarb metadata --no-deps.

In the former case, use WorkspaceMetadata::members to filter workspace members.

compilation_units: Vec<CompilationUnitMetadata>

List of all Scarb compilation units produced in this workspace.

current_profile: String

Name of the currently selected profile

profiles: Vec<String>

List of all available profiles names

extra: HashMap<String, Value>

Additional data not captured by deserializer.

Implementations

impl Metadata

pub fn get_package(&self, id: &PackageId) -> Option<&PackageMetadata>

Returns reference to PackageMetadata corresponding to the PackageId.

pub fn is_builtin_plugin( &self, plugin: &CompilationUnitCairoPluginMetadata, ) -> Option<bool>

Checks if the plugin associated with CompilationUnitCairoPluginMetadata is built-in into Scarb.

pub fn get_compilation_unit( &self, id: &CompilationUnitId, ) -> Option<&CompilationUnitMetadata>

Returns reference to CompilationUnitMetadata corresponding to the CompilationUnitId.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

type Output = CompilationUnitMetadata

The returned type after indexing.

fn index(&self, idx: &'a CompilationUnitId) -> &Self::Output

Performs the indexing (container[index]) operation.

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

type Output = PackageMetadata

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl PartialEq for Metadata

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Metadata

impl StructuralPartialEq for Metadata