nu-command 0.112.2

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

use nu_engine::{
    command_prelude::*,
    exit::{cleanup, cleanup_exit},
};

#[derive(Clone)]
pub struct Exit;

impl Command for Exit {
    fn name(&self) -> &str {
        "exit"
    }

    fn signature(&self) -> Signature {
        Signature::build("exit")
            .input_output_types(vec![(Type::Nothing, Type::Nothing)])
            .optional(
                "exit_code",
                SyntaxShape::Int,
                "Exit code to return immediately with.",
            )
            .switch("abort", "Exit by abort.", None)
            .category(Category::Shells)
    }

    fn description(&self) -> &str {
        "Exit Nu."
    }

    fn search_terms(&self) -> Vec<&str> {
        vec!["quit", "close", "exit_code", "error_code", "logout"]
    }

    fn run(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        call: &Call,
        _input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        let exit_code: Option<i64> = call.opt(engine_state, stack, 0)?;

        let abort = call.has_flag(engine_state, stack, "abort")?;
        let exit_code = exit_code.map_or(0, |it| it as i32);

        if abort {
            cleanup_exit((), engine_state, exit_code);
            Ok(Value::nothing(call.head).into_pipeline_data())
        } else if cleanup((), engine_state).is_some() {
            Ok(Value::nothing(call.head).into_pipeline_data())
        } else {
            Err(ShellError::Exit { code: exit_code })
        }
    }

    fn examples(&self) -> Vec<Example<'_>> {
        vec![Example {
            description: "Exit the current shell",
            example: "exit",
            result: None,
        }]
    }
}