Class: Toys::Utils::Exec::Result

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Instance Attribute Details

#captured_errString? (readonly)

The captured error string.

Returns:

  • (String)

    The string captured from stderr.

  • (nil)

    if the command was not configured to capture stderr.



740
741
742
# File 'lib/toys/utils/exec.rb', line 740

def captured_err
  @captured_err
end

#captured_outString? (readonly)

The captured output string.

Returns:

  • (String)

    The string captured from stdout.

  • (nil)

    if the command was not configured to capture stdout.



732
733
734
# File 'lib/toys/utils/exec.rb', line 732

def captured_out
  @captured_out
end

#exceptionException? (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.

Returns:

  • (Exception)

    The exception raised from process start.

  • (nil)

    if the process started successfully.



764
765
766
# File 'lib/toys/utils/exec.rb', line 764

def exception
  @exception
end

#nameObject (readonly)

The subcommand's name.

Returns:

  • (Object)


724
725
726
# File 'lib/toys/utils/exec.rb', line 724

def name
  @name
end

#statusProcess::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.

Returns:

  • (Process::Status)

    The status, if the process was successfully spanwed and terminated.

  • (nil)

    if the process could not be started.



752
753
754
# File 'lib/toys/utils/exec.rb', line 752

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.

Returns:

  • (Boolean)


835
836
837
838
# File 'lib/toys/utils/exec.rb', line 835

def error?
  code = exit_code
  !code.nil? && !code.zero?
end

#exit_codeInteger?

The numeric status code for a process that exited normally,

Exactly one of #exception, #exit_code, or #signal_code will be non-nil.

Returns:

  • (Integer)

    the numeric status code, if the process started successfully and exited normally.

  • (nil)

    if the process did not start successfully, or was terminated by an uncaught signal.



777
778
779
# File 'lib/toys/utils/exec.rb', line 777

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.

Returns:

  • (Boolean)


802
803
804
# File 'lib/toys/utils/exec.rb', line 802

def failed?
  status.nil?
end

#signal_codeInteger? 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.

Returns:

  • (Integer)

    The signal that caused the process to terminate.

  • (nil)

    if the process did not start successfully, or executed and exited with a normal exit code.



791
792
793
# File 'lib/toys/utils/exec.rb', line 791

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.

Returns:

  • (Boolean)


812
813
814
# File 'lib/toys/utils/exec.rb', line 812

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.

Returns:

  • (Boolean)


823
824
825
826
# File 'lib/toys/utils/exec.rb', line 823

def success?
  code = exit_code
  !code.nil? && code.zero?
end