Struct ProjectFile 

pub struct ProjectFile {
    pub source_file: Option<Arc<SourceFile>>,
    pub package: PackageTable,
    pub config: PackageConfig,
    pub lib: Option<Span<LibTarget>>,
    pub bins: Vec<Span<BinTarget>>,
    pub profiles: Vec<Profile>,
}

Represents the miden-project.toml structure of an individual package

Fields

source_file: Option<Arc<SourceFile>>

The original source file this was parsed from, if applicable/known

package: PackageTable

Contents of the [package] table

config: PackageConfig

Contents of tables shared with workspace-level miden-project.toml, e.g. [dependencies] and [lints]

lib: Option<Span<LibTarget>>

The library target of this project, if applicable

bins: Vec<Span<BinTarget>>

The binary targets of this project, if applicable

profiles: Vec<Profile>

The set of build profiles defined in this file

Implementations

impl ProjectFile

Parsing

pub fn parse(source: Arc<SourceFile>) -> Result<Self, Report>

Parse a ProjectFile from the provided TOML source file, generally miden-project.toml

If successful, the contents of the manifest are semantically valid, with the following caveats:

• Inherited properties from the workspace-level are assumed to exist and be correct. It is up to the caller to compute the concrete property values and validate them at that point.

pub fn get_or_inherit_version( &self, source: Arc<SourceFile>, workspace: Option<&WorkspaceFile>, ) -> Result<Span<SemVer>, Report>

pub fn get_or_inherit_description( &self, source: Arc<SourceFile>, workspace: Option<&WorkspaceFile>, ) -> Result<Option<Arc<str>>, Report>

pub fn extract_dependencies( &self, source: Arc<SourceFile>, workspace: Option<&WorkspaceFile>, ) -> Result<Vec<Dependency>, Report>

pub fn extract_library_target(&self) -> Result<Option<Span<Target>>, Report>

pub fn extract_executable_targets(&self) -> Vec<Span<Target>>

Trait Implementations

impl Clone for ProjectFile

fn clone(&self) -> ProjectFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProjectFile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProjectFile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.