nu-command 0.114.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

use calamine::{Ods, Reader, Sheets};

use super::sheets::{collect_binary, common_sheets_signature, from_sheets};
use nu_engine::command_prelude::*;

#[derive(Clone)]
pub struct FromOds;

impl Command for FromOds {
    fn name(&self) -> &str {
        "from ods"
    }

    fn signature(&self) -> Signature {
        common_sheets_signature("from ods")
    }

    fn description(&self) -> &str {
        "Parse OpenDocument Spreadsheet(.ods) data and create table."
    }

    fn run(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        call: &Call,
        mut input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        let head = call.head;
        let metadata = input.take_metadata().map(|md| md.with_content_type(None));

        let input_span = input.span().unwrap_or(head);
        let reader = collect_binary(input, head)?;
        let ods = Ods::new(reader).map_err(|_| ShellError::UnsupportedInput {
            msg: "Could not load ODS file".to_string(),
            input: "value originates from here".into(),
            msg_span: head,
            input_span,
        })?;
        let sheets = Sheets::Ods(ods);

        from_sheets(sheets, input_span, engine_state, stack, call)
            .map(|pd| pd.set_metadata(metadata))
    }

    fn examples(&self) -> Vec<Example<'_>> {
        vec![
            Example {
                description: "Convert binary .ods data to a table.",
                example: "open --raw test.ods | from ods",
                result: None,
            },
            Example {
                description: "Convert binary .ods data to a table, specifying the tables.",
                example: "open --raw test.ods | from ods --sheets [Spreadsheet1]",
                result: None,
            },
            Example {
                description: "Convert binary .ods data to a table, specifying the tables and specifying no header row.",
                example: "open --raw test.ods | from ods --sheets [Spreadsheet1] --noheaders",
                result: None,
            },
        ]
    }
}

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

    #[test]
    fn test_examples() -> nu_test_support::Result {
        nu_test_support::test().examples(FromOds)
    }
}