nu-cmd-lang 0.112.2

Nushell's core language 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
54
55
56
57

use nu_engine::command_prelude::*;

#[derive(Clone)]
pub struct AttrSearchTerms;

impl Command for AttrSearchTerms {
    fn name(&self) -> &str {
        "attr search-terms"
    }

    fn signature(&self) -> Signature {
        Signature::build("attr search-terms")
            .input_output_type(Type::Nothing, Type::list(Type::String))
            .allow_variants_without_examples(true)
            .rest("terms", SyntaxShape::String, "Search terms.")
            .category(Category::Core)
    }

    fn description(&self) -> &str {
        "Attribute for adding search terms to custom commands."
    }

    fn run(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        call: &Call,
        _input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        let args = call.rest(engine_state, stack, 0)?;
        Ok(Value::list(args, call.head).into_pipeline_data())
    }

    fn run_const(
        &self,
        working_set: &StateWorkingSet,
        call: &Call,
        _input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        let args = call.rest_const(working_set, 0)?;
        Ok(Value::list(args, call.head).into_pipeline_data())
    }

    fn is_const(&self) -> bool {
        true
    }

    fn examples(&self) -> Vec<Example<'_>> {
        vec![Example {
            description: "Add search terms to a custom command.",
            example: "# Double numbers
    @search-terms multiply times
    def double []: [number -> number] { $in * 2 }",
            result: None,
        }]
    }
}