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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

use nu_engine::command_prelude::*;

use super::query::query_string_to_table;

#[derive(Clone)]
pub struct UrlSplitQuery;

impl Command for UrlSplitQuery {
    fn name(&self) -> &str {
        "url split-query"
    }

    fn signature(&self) -> Signature {
        Signature::build("url split-query")
            .input_output_types(vec![(
                Type::String,
                Type::Table([("key".into(), Type::String), ("value".into(), Type::String)].into()),
            )])
            .category(Category::Network)
    }

    fn description(&self) -> &str {
        "Converts query string into table applying percent-decoding."
    }

    fn search_terms(&self) -> Vec<&str> {
        vec!["convert", "record", "table"]
    }

    fn examples(&self) -> Vec<Example> {
        vec![
            Example {
                description: "Outputs a table representing the contents of this query string",
                example: r#""mode=normal&userid=31415" | url split-query"#,
                result: Some(Value::test_list(vec![
                    Value::test_record(record! {
                        "key" => Value::test_string("mode"),
                        "value" => Value::test_string("normal"),
                    }),
                    Value::test_record(record! {
                        "key" => Value::test_string("userid"),
                        "value" => Value::test_string("31415"),
                    }),
                ])),
            },
            Example {
                description: "Outputs a table representing the contents of this query string, url-decoding the values",
                example: r#""a=AT%26T&b=AT+T" | url split-query"#,
                result: Some(Value::test_list(vec![
                    Value::test_record(record! {
                        "key" => Value::test_string("a"),
                        "value" => Value::test_string("AT&T"),
                    }),
                    Value::test_record(record! {
                        "key" => Value::test_string("b"),
                        "value" => Value::test_string("AT T"),
                    }),
                ])),
            },
            Example {
                description: "Outputs a table representing the contents of this query string",
                example: r#""a=one&a=two&b=three" | url split-query"#,
                result: Some(Value::test_list(vec![
                    Value::test_record(record! {
                        "key" => Value::test_string("a"),
                        "value" => Value::test_string("one"),
                    }),
                    Value::test_record(record! {
                        "key" => Value::test_string("a"),
                        "value" => Value::test_string("two"),
                    }),
                    Value::test_record(record! {
                        "key" => Value::test_string("b"),
                        "value" => Value::test_string("three"),
                    }),
                ])),
            },
        ]
    }

    fn run(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        call: &Call,
        input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        let value = input.into_value(call.head)?;
        let span = value.span();
        let query = value.to_expanded_string("", &stack.get_config(engine_state));
        let table = query_string_to_table(&query, call.head, span)?;
        Ok(PipelineData::Value(table, None))
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn test_examples() {
        use crate::test_examples;

        test_examples(UrlSplitQuery {})
    }
}