Struct CompileConfig 

pub struct CompileConfig {
    pub program: String,
    pub args: Vec<String>,
    pub version_args: Vec<String>,
    pub workspace: PathBuf,
    pub timeout: Duration,
}

A tool to compile or type-check with.

The three constructors cover what US-0804 names. Anything else is CompileConfig::new.

Fields

program: String

The program to run.

args: Vec<String>

The arguments that perform the check.

version_args: Vec<String>

The arguments that make it print its version, e.g. --version.

workspace: PathBuf

The directory to run in, and the only one the checker may read.

timeout: Duration

How long the check may run before it is killed.

Implementations

impl CompileConfig

pub fn new( program: impl Into<String>, args: impl IntoIterator<Item = impl Into<String>>, workspace: impl Into<PathBuf>, ) -> Self

A tool invocation, with the default timeout and --version as the version command.

pub fn cargo(workspace: impl Into<PathBuf>) -> Self

cargo check --all-targets.

check rather than build: it type-checks without linking, which is several times faster and is the whole of what this checker claims.

pub fn tsc(workspace: impl Into<PathBuf>) -> Self

tsc --noEmit.

--noEmit because a checker may not write to the workspace, and tsc writes JavaScript unless told not to.

pub fn mypy(workspace: impl Into<PathBuf>) -> Self

mypy ..

pub fn versioned_by( self, args: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Ask for the version some other way than --version.

pub fn within(self, timeout: Duration) -> Self

Kill the check after timeout.

pub fn grant(&self) -> GrantSet

The grant this configuration needs: read the workspace, execute the tool, nothing else.

Trait Implementations

impl Clone for CompileConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompileConfig

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

Formats the value using the given formatter.

impl Eq for CompileConfig

impl PartialEq for CompileConfig

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CompileConfig