nu_command/filesystem/idx/
files.rs1use super::state::stream_files;
2use nu_engine::command_prelude::*;
3
4#[derive(Clone)]
5pub struct IdxFiles;
6
7impl Command for IdxFiles {
8 fn name(&self) -> &str {
9 "idx files"
10 }
11
12 fn signature(&self) -> Signature {
13 Signature::build(self.name())
14 .optional(
15 "query",
16 SyntaxShape::String,
17 "Optional fuzzy query to filter indexed files.",
18 )
19 .input_output_types(vec![(Type::Nothing, Type::List(Box::new(Type::record())))])
20 .category(Category::FileSystem)
21 }
22
23 fn description(&self) -> &str {
24 "List indexed files, or fuzzy-match files by query."
25 }
26
27 fn examples(&self) -> Vec<Example<'_>> {
28 vec![
29 Example {
30 description: "List all indexed files.",
31 example: "idx files",
32 result: None,
33 },
34 Example {
35 description: "Fuzzy-match indexed files by query.",
36 example: "idx files main",
37 result: None,
38 },
39 ]
40 }
41
42 fn run(
43 &self,
44 engine_state: &EngineState,
45 stack: &mut Stack,
46 call: &Call,
47 _input: PipelineData,
48 ) -> Result<PipelineData, ShellError> {
49 stream_files(
50 call.opt::<String>(engine_state, stack, 0)?,
51 call.head,
52 engine_state.signals(),
53 )
54 }
55}