Class: Toys::Utils::Exec::Result
- Inherits:
-
Object
- Object
- Toys::Utils::Exec::Result
- Defined in:
- lib/toys/utils/exec.rb
Overview
The result returned from a subcommand execution. This includes the identifying name of the execution (if any), the result status of the execution, and any captured stream output.
Possible result statuses are:
- The process failed to start. #failed? will return true, and #exception will return an exception describing the failure (often an errno).
- The process executed and exited with a normal exit code. Either #success? or #error? will return true, and #exit_code will return the numeric exit code.
- The process executed but was terminated by an uncaught signal. #signaled? will return true, and #signal_code will return the numeric signal code.
Instance Attribute Summary collapse
-
#captured_err ⇒ String?
readonly
The captured error string.
-
#captured_out ⇒ String?
readonly
The captured output string.
-
#exception ⇒ Exception?
readonly
The exception raised if a process couldn't be started.
-
#name ⇒ Object
readonly
The subcommand's name.
-
#status ⇒ Process::Status?
readonly
The Ruby process status object, providing various information about the ending state of the process.
Instance Method Summary collapse
-
#error? ⇒ Boolean
Returns true if the subprocess terminated with a nonzero status, or false if the process failed to start, terminated due to a signal, or returned a zero status.
-
#exit_code ⇒ Integer?
The numeric status code for a process that exited normally,.
-
#failed? ⇒ Boolean
Returns true if the subprocess failed to start, or false if the process was able to execute.
-
#signal_code ⇒ Integer?
(also: #term_signal)
The numeric signal code that caused process termination.
-
#signaled? ⇒ Boolean
Returns true if the subprocess terminated due to an unhandled signal, or false if the process failed to start or exited normally.
-
#success? ⇒ Boolean
Returns true if the subprocess terminated with a zero status, or false if the process failed to start, terminated due to a signal, or returned a nonzero status.
Instance Attribute Details
#captured_err ⇒ String? (readonly)
The captured error string.
832 833 834 |
# File 'lib/toys/utils/exec.rb', line 832 def captured_err @captured_err end |
#captured_out ⇒ String? (readonly)
The captured output string.
824 825 826 |
# File 'lib/toys/utils/exec.rb', line 824 def captured_out @captured_out end |
#exception ⇒ Exception? (readonly)
The exception raised if a process couldn't be started.
Exactly one of #exception and #status will be non-nil. Exactly one of #exception, #exit_code, or #signal_code will be non-nil.
856 857 858 |
# File 'lib/toys/utils/exec.rb', line 856 def exception @exception end |
#name ⇒ Object (readonly)
The subcommand's name.
816 817 818 |
# File 'lib/toys/utils/exec.rb', line 816 def name @name end |
#status ⇒ Process::Status? (readonly)
The Ruby process status object, providing various information about the ending state of the process.
Exactly one of #exception and #status will be non-nil.
844 845 846 |
# File 'lib/toys/utils/exec.rb', line 844 def status @status end |
Instance Method Details
#error? ⇒ Boolean
Returns true if the subprocess terminated with a nonzero status, or false if the process failed to start, terminated due to a signal, or returned a zero status.
927 928 929 930 |
# File 'lib/toys/utils/exec.rb', line 927 def error? code = exit_code !code.nil? && !code.zero? end |
#exit_code ⇒ Integer?
The numeric status code for a process that exited normally,
Exactly one of #exception, #exit_code, or #signal_code will be non-nil.
869 870 871 |
# File 'lib/toys/utils/exec.rb', line 869 def exit_code status&.exitstatus end |
#failed? ⇒ Boolean
Returns true if the subprocess failed to start, or false if the process was able to execute.
894 895 896 |
# File 'lib/toys/utils/exec.rb', line 894 def failed? status.nil? end |
#signal_code ⇒ Integer? Also known as: term_signal
The numeric signal code that caused process termination.
Exactly one of #exception, #exit_code, or #signal_code will be non-nil.
883 884 885 |
# File 'lib/toys/utils/exec.rb', line 883 def signal_code status&.termsig end |
#signaled? ⇒ Boolean
Returns true if the subprocess terminated due to an unhandled signal, or false if the process failed to start or exited normally.
904 905 906 |
# File 'lib/toys/utils/exec.rb', line 904 def signaled? !signal_code.nil? end |
#success? ⇒ Boolean
Returns true if the subprocess terminated with a zero status, or false if the process failed to start, terminated due to a signal, or returned a nonzero status.
915 916 917 918 |
# File 'lib/toys/utils/exec.rb', line 915 def success? code = exit_code !code.nil? && code.zero? end |