nu-command 0.106.0

Nushell's built-in commands
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

use nu_engine::command_prelude::*;

#[derive(Clone)]
pub struct JobId;

impl Command for JobId {
    fn name(&self) -> &str {
        "job id"
    }

    fn description(&self) -> &str {
        "Get id of current job."
    }

    fn extra_description(&self) -> &str {
        "This command returns the job id for the current background job. 
The special id 0 indicates that this command was not called from a background job thread, and 
was instead spawned by main nushell execution thread."
    }

    fn signature(&self) -> nu_protocol::Signature {
        Signature::build("job id")
            .category(Category::Experimental)
            .input_output_types(vec![(Type::Nothing, Type::Int)])
    }

    fn search_terms(&self) -> Vec<&str> {
        vec!["self", "this", "my-id", "this-id"]
    }

    fn run(
        &self,
        engine_state: &EngineState,
        _stack: &mut Stack,
        call: &Call,
        _input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        let head = call.head;

        Ok(Value::int(engine_state.current_job.id.get() as i64, head).into_pipeline_data())
    }

    fn examples(&self) -> Vec<Example> {
        vec![Example {
            example: "job id",
            description: "Get id of current job",
            result: None,
        }]
    }
}