Struct Emitter

pub struct Emitter {
    pub out: Box<dyn Write>,
    pub config_data: Figment,
    pub workdir: Utf8PathBuf,
}

Fields

out: Box<dyn Write>

config_data: Figment

workdir: Utf8PathBuf

Implementations

impl Emitter

pub fn config_val(&self, key: &str) -> Result<String, EmitError>

Fetch a configuration value, or panic if it’s missing.

pub fn config_or(&self, key: &str, default: &str) -> String

Fetch a configuration value, using a default if it’s missing.

pub fn config_var(&mut self, name: &str, key: &str) -> EmitResult

Emit a Ninja variable declaration for name based on the configured value for key.

pub fn config_var_or( &mut self, name: &str, key: &str, default: &str, ) -> Result<()>

Emit a Ninja variable declaration for name based on the configured value for key, or a default value if it’s missing.

pub fn var(&mut self, name: &str, value: &str) -> Result<()>

Emit a Ninja variable declaration.

pub fn rule(&mut self, name: &str, command: &str) -> Result<()>

Emit a Ninja rule definition.

pub fn build(&mut self, rule: &str, input: &str, output: &str) -> Result<()>

Emit a simple Ninja build command with one dependency.

pub fn build_cmd( &mut self, targets: &[&str], rule: &str, deps: &[&str], implicit_deps: &[&str], ) -> Result<()>

Emit a Ninja build command.

pub fn comment(&mut self, text: &str) -> Result<()>

Emit a Ninja comment.

pub fn add_file(&self, name: &str, contents: &[u8]) -> Result<()>

Add a file to the build directory.

pub fn external_path(&self, path: &Utf8Path) -> Utf8PathBuf

Get a path to an external file. The input path may be relative to our original invocation; we make it relative to the build directory so it can safely be used in the Ninja file.

pub fn arg(&mut self, name: &str, value: &str) -> Result<()>

Add a variable parameter to a rule or build command.