Struct Runnable

pub struct Runnable {
    program: String,
    args: Vec<String>,
    cwd: Utf8PathBuf,
    kind: RunnableKind,
}

A template-like structure for describing runnables.

These are used for running and debugging binaries and tests without encoding build system-specific knowledge into rust-analyzer.

Example

Below is an example of a test runnable. {label} and {test_id} are explained in Runnable::args’s documentation.

{
    "program": "bazel",
    "args": [
        "test",
         "{label}",
         "--test_arg",
         "{test_id}",
    ],
    "cwd": "/home/user/repo-root/",
    "kind": "testOne"
}

Fields

program: String

The program invoked by the runnable.

For example, this might be cargo, bazel, etc.

args: Vec<String>

The arguments passed to Runnable::program.

The args can contain two template strings: {label} and {test_id}. rust-analyzer will find and replace {label} with Build::label and {test_id} with the test name.

cwd: Utf8PathBuf

The current working directory of the runnable.

kind: RunnableKind

Trait Implementations

impl Debug for Runnable

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

Formats the value using the given formatter.

impl Serialize for Runnable

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

where __S: Serializer,

Serialize this value into the given Serde serializer.