nu-command 0.113.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
51
52
53

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

#[derive(Clone)]
pub struct IdxFiles;

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

    fn signature(&self) -> Signature {
        Signature::build(self.name())
            .optional(
                "path",
                SyntaxShape::String,
                "Optional path to lookup in index.",
            )
            .input_output_types(vec![(Type::Nothing, Type::List(Box::new(Type::record())))])
            .category(Category::FileSystem)
    }

    fn description(&self) -> &str {
        "List indexed files, or lookup a specific indexed path."
    }

    fn examples(&self) -> Vec<Example<'_>> {
        vec![
            Example {
                description: "List all indexed files",
                example: "idx files",
                result: None,
            },
            Example {
                description: "Lookup a specific file path in the index",
                example: "idx files src/main.rs",
                result: None,
            },
        ]
    }

    fn run(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        call: &Call,
        _input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        let path = call.opt::<String>(engine_state, stack, 0)?;
        let signals = engine_state.signals();
        stream_files(path, call.head, signals)
    }
}