Class: RailLine::BaseResult

Inherits:
Object
  • Object
show all
Defined in:
lib/rail_line/base_result.rb

Direct Known Subclasses

Failure, Success

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(payload: {}, message: nil) ⇒ BaseResult

Returns a new instance of BaseResult.

Parameters:

  • payload (Hash) (defaults to: {}) —

    The payload of the result

  • message (String) (defaults to: nil) —

    The message of the result



9
10
11
12
13
14
 
# File 'lib/rail_line/base_result.rb', line 9

def initialize(payload: {}, message: nil)
  @payload = payload
  @message = message

  handle_failure
end

Instance Attribute Details

#message ⇒ Object (readonly)

Returns the value of attribute message.



5
6
7
 
# File 'lib/rail_line/base_result.rb', line 5

def message
  @message
end

#payload ⇒ Object (readonly)

Returns the value of attribute payload.



5
6
7
 
# File 'lib/rail_line/base_result.rb', line 5

def payload
  @payload
end

Instance Method Details

#failure? ⇒ Boolean

Returns true if the result is a failure

Returns:

  • (Boolean) —

    Returns true if the result is a failure



17
18
19
 
# File 'lib/rail_line/base_result.rb', line 17

def failure?
  !success?
end