class ShellStrike::Result

Public Class Methods

new(success_value, message = '', error_type = nil) click to toggle source

Initialises a new Result object, used to represent whether a task was successful. @param success_value [Boolean] whether the action was successful. @param message [String] a message explaining the result. @param error_type [Symbol, nil] a symbol representing the type of failure.

# File lib/shell_strike/result.rb, line 6
def initialize(success_value, message = '', error_type = nil)
  @success_value = success_value
  @message = message
  @error_type = error_type
end

Public Instance Methods

error_type() click to toggle source

@return [Symbol, nil] a symbol representing the type of error that occurred; or `nil` if success? is true

# File lib/shell_strike/result.rb, line 27
def error_type
  return nil if success?

  @error_type
end
message() click to toggle source

@return [String] a message explaining the result.

# File lib/shell_strike/result.rb, line 22
def message
  @message
end
success?() click to toggle source

Whether the success_value is set to true

# File lib/shell_strike/result.rb, line 13
def success?
  @success_value
end
valid?() click to toggle source
# File lib/shell_strike/result.rb, line 17
def valid?
  success?
end