Struct CompilationUnitComponentMetadata 

#[non_exhaustive]
pub struct CompilationUnitComponentMetadata {
    pub package: PackageId,
    pub name: String,
    pub source_path: Utf8PathBuf,
    pub cfg: Option<Vec<Cfg>>,
    pub id: Option<CompilationUnitComponentId>,
    pub discriminator: Option<String>,
    pub dependencies: Option<Vec<CompilationUnitComponentDependencyMetadata>>,
    pub extra: HashMap<String, Value>,
}

Information to pass to the Cairo compiler about a package that is a component of a compilation unit.

List of components can be used to construct the [crate_roots] section of cairo_project.toml.

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.

package: PackageId

Package ID.

name: String

Name of the package to pass to the Cairo compiler.

This may not be equal to Scarb package name in the future.

source_path: Utf8PathBuf

Path to the root Cairo source file.

cfg: Option<Vec<Cfg>>

Items for the Cairo’s #[cfg(...)] attribute to be enabled in this component.

If not specified, the one from CompilationUnit will be used.

id: Option<CompilationUnitComponentId>

Identifier of this component. It is unique in its compilation unit.

discriminator: Option<String>

Identifier of this component as a dependency. This directly translates to a discriminator field in Cairo compiler terminology. If [CompilationUnitComponentMetadata.id] is Some then this field is None for core crate only.

dependencies: Option<Vec<CompilationUnitComponentDependencyMetadata>>

Dependencies of this component. Contains libraries and plugins, represented uniquely in the scope of the compilation unit.

extra: HashMap<String, Value>

Additional data not captured by deserializer.

Implementations

impl CompilationUnitComponentMetadata

pub fn source_root(&self) -> &Utf8Path

Path to the source directory of the component.

Trait Implementations

impl Clone for CompilationUnitComponentMetadata

fn clone(&self) -> CompilationUnitComponentMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompilationUnitComponentMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompilationUnitComponentMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CompilationUnitComponentMetadata

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

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 CompilationUnitComponentMetadata

impl StructuralPartialEq for CompilationUnitComponentMetadata