termination.rs.html -- source
Description: Source to the Rust file `libstd/termination.rs`.
Keywords: rust, rustlang, rust-lang

     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

    // Copyright 2017 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    use error::Error;
    #[cfg(target_arch = "wasm32")]
    mod exit {
        pub const SUCCESS: i32 = 0;
        pub const FAILURE: i32 = 1;
    }
    #[cfg(not(target_arch = "wasm32"))]
    mod exit {
        use libc;
        pub const SUCCESS: i32 = libc::EXIT_SUCCESS;
        pub const FAILURE: i32 = libc::EXIT_FAILURE;
    }

    /// A trait for implementing arbitrary return types in the `main` function.
    ///
    /// The c-main function only supports to return integers as return type.
    /// So, every type implementing the `Termination` trait has to be converted
    /// to an integer.
    ///
    /// The default implementations are returning `libc::EXIT_SUCCESS` to indicate
    /// a successful execution. In case of a failure, `libc::EXIT_FAILURE` is returned.
    #[cfg_attr(not(any(stage0, test)), lang = "termination")]
    #[unstable(feature = "termination_trait", issue = "43301")]
    #[rustc_on_unimplemented =
      "`main` can only return types that implement {Termination}, not `{Self}`"]
    pub trait Termination {
        /// Is called to get the representation of the value as status code.
        /// This status code is returned to the operating system.
        fn report(self) -> i32;
    }

    #[unstable(feature = "termination_trait", issue = "43301")]
    impl Termination for () {
        fn report(self) -> i32 { exit::SUCCESS }
    }

    #[unstable(feature = "termination_trait", issue = "43301")]
    impl<T: Termination, E: Error> Termination for Result<T, E> {
        fn report(self) -> i32 {
            match self {
                Ok(val) => val.report(),
                Err(err) => {
                    print_error(err);
                    exit::FAILURE
                }
            }
        }
    }

    #[unstable(feature = "termination_trait", issue = "43301")]
    fn print_error<E: Error>(err: E) {
        eprintln!("Error: {}", err.description());

        if let Some(ref err) = err.cause() {
            eprintln!("Caused by: {}", err.description());
        }
    }

    #[unstable(feature = "termination_trait", issue = "43301")]
    impl Termination for ! {
        fn report(self) -> i32 { unreachable!(); }
    }

    #[unstable(feature = "termination_trait", issue = "43301")]
    impl Termination for bool {
        fn report(self) -> i32 {
            if self { exit::SUCCESS } else { exit::FAILURE }
        }
    }

    #[unstable(feature = "termination_trait", issue = "43301")]
    impl Termination for i32 {
        fn report(self) -> i32 {
            self
        }
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
↑
  Move up in search results
↓
  Move down in search results
↹
  Switch tab
⏎
  Go to active search result
+ / -
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)