nu-command 0.113.1

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

use super::state::current_status;
use nu_engine::command_prelude::*;

#[derive(Clone)]
pub struct IdxStatus;

impl Command for IdxStatus {
    fn name(&self) -> &str {
        "idx status"
    }

    fn signature(&self) -> Signature {
        Signature::build(self.name())
            .input_output_types(vec![(Type::Nothing, Type::record())])
            .category(Category::FileSystem)
    }

    fn description(&self) -> &str {
        "Show status information for the global in-memory idx runtime."
    }

    fn examples(&self) -> Vec<Example<'_>> {
        vec![Example {
            description: "Show the current idx runtime status",
            example: "idx status",
            result: None,
        }]
    }

    fn run(
        &self,
        _engine_state: &EngineState,
        _stack: &mut Stack,
        call: &Call,
        _input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        Ok(PipelineData::value(
            current_status(None).to_value(call.head),
            None,
        ))
    }
}