Struct Runnable

pub struct Runnable {
    pub program: String,
    pub args: Vec<String>,
    pub cwd: Utf8PathBuf,
    pub 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": "buck",
    "args": [
        "test",
         "{label}",
         "--",
         "{test_id}",
         "--print-passing-details"
    ],
    "cwd": "/home/user/repo-root/",
    "kind": "testOne"
}

Fields

program: String

The program invoked by the runnable.

For example, this might be cargo, buck, or bazel.

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 Clone for Runnable

fn clone(&self) -> Runnable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Runnable

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

Formats the value using the given formatter.

impl From<RunnableData> for Runnable

fn from(data: RunnableData) -> Self

Converts to this type from the input type.

impl PartialEq for Runnable

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Runnable

impl StructuralPartialEq for Runnable