types.rs - source
Description: Source of the Rust file `src/types.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
    87
    88
    89
    90
    91
    92
    93
    94
    95

    //! # types
    //!
    //! Defines the various types and aliases.
    //!

    #[cfg(test)]
    #[path = "./types_test.rs"]
    mod types_test;

    use fsio::error::FsIOError;
    use std::error::Error;
    use std::fmt;
    use std::fmt::Display;
    use std::io;
    use std::path::PathBuf;

    /// Alias for result with script error
    pub type ScriptResult<T> = Result<T, ScriptError>;

    #[derive(Debug)]
    /// Holds the error information
    pub enum ScriptError {
        /// Root error
        IOError(io::Error),
        /// Root error
        FsIOError(FsIOError),
        /// Description text of the error reason
        Description(&'static str),
    }

    impl Display for ScriptError {
        /// Formats the value using the given formatter.
        fn fmt(&self, format: &mut fmt::Formatter) -> Result<(), fmt::Error> {
            match self {
                Self::IOError(ref cause) => cause.fmt(format),
                Self::FsIOError(ref cause) => cause.fmt(format),
                Self::Description(description) => description.fmt(format),
            }
        }
    }

    impl Error for ScriptError {
        fn source(&self) -> Option<&(dyn Error + 'static)> {
            match self {
                Self::Description(_) => None,
                Self::IOError(error) => Some(error),
                Self::FsIOError(error) => Some(error),
            }
        }
    }

    #[derive(Debug, Clone, PartialEq)]
    /// Options available for invoking the script
    pub struct ScriptOptions {
        /// Defines the requested runner (defaults to cmd in windows and sh for other platforms)
        pub runner: Option<String>,
        /// The working directory of the invocation
        pub working_directory: Option<PathBuf>,
        /// Default is IoOptions::Inherit
        pub input_redirection: IoOptions,
        /// Default is IoOptions::Pipe (only pipe enables to capture the output)
        pub output_redirection: IoOptions,
        /// Sets -e flag. Will exit on any error while running the script (not available for windows)
        pub exit_on_error: bool,
        /// Sets -x flag for printing each script command before invocation (not available for windows)
        pub print_commands: bool,
        /// Environment environment variables to add before invocation
        pub env_vars: Option<std::collections::HashMap<String, String>>,
    }

    #[derive(Debug, Copy, Clone, PartialEq)]
    /// Options available for IO
    pub enum IoOptions {
        /// Corresponds to Stdio::null()
        Null,
        /// Corresponds to Stdio::pipe()
        Pipe,
        /// Corresponds to Stdio::inherit()
        Inherit,
    }

    impl ScriptOptions {
        /// Returns new instance
        pub fn new() -> ScriptOptions {
            ScriptOptions {
                runner: None,
                working_directory: None,
                input_redirection: IoOptions::Inherit,
                output_redirection: IoOptions::Pipe,
                exit_on_error: false,
                print_commands: false,
                env_vars: None,
            }
        }
    }