Struct OutputFiles 

pub struct OutputFiles {
    pub cwd: PathBuf,
    pub tmp_dir: PathBuf,
    pub out_dir: PathBuf,
    pub out_file: Option<OutputFile>,
    pub outputs: OutputTypes,
    /* private fields */
}

Fields

cwd: PathBuf

The compiler working directory

tmp_dir: PathBuf

The directory in which to place temporaries or intermediate artifacts

out_dir: PathBuf

The directory in which to place objects produced by the current compiler operation

This directory is intended for non-intermediate artifacts, though it may be used to derive tmp_dir elsewhere. You should prefer to use tmp_dir for files which are internal details of the compiler.

out_file: Option<OutputFile>

If specified, the specific path at which to write the compiler output.

This only applies to the final output, i.e. the .masl library or executable.

outputs: OutputTypes

The raw output types requested by the user on the command line

Implementations

impl OutputFiles

pub fn new( stem: String, cwd: PathBuf, out_dir: PathBuf, out_file: Option<OutputFile>, tmp_dir: PathBuf, outputs: OutputTypes, ) -> Self

pub fn output_file(&self, ty: OutputType, name: Option<&str>) -> OutputFile

Return the OutputFile representing where an output of ty type should be written, with an optional name, which overrides the file stem of the resulting path.

pub fn output_path(&self, ty: OutputType) -> PathBuf

Return the most appropriate file path for an output of ty type.

The returned path may be precise, if a specific file path was chosen by the user for the given output type, but in general the returned path will be derived from the current self.stem, and is thus an appropriate default path for the given output.

pub fn temp_path(&self, ty: OutputType, name: Option<&str>) -> PathBuf

Constructs a file path for a temporary file of the given output type, with an optional name, falling back to self.stem if no name is provided.

The file path is always a child of self.tmp_dir

pub fn with_extension(&self, extension: &str) -> PathBuf

Build a file path which is either:

• If self.out_file is set to a real path, returns it with extension set to extension
• Otherwise, calls [with_directory_and_extension] with self.out_dir and extension

Trait Implementations

impl Debug for OutputFiles

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

Formats the value using the given formatter.