Class: Aux::Carriers::Failure

Inherits:
Object
  • Object
show all
Defined in:
lib/aux/carriers/failure.rb

Overview

Describes a service failure

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(code, details = nil, payload = nil) ⇒ Failure

Returns a new instance of Failure.

Parameters:

  • code (Symbol)
  • details (Object, nil) (defaults to: nil)
  • payload (Object, nil) (defaults to: nil) 


18
19
20
21
22
 
# File 'lib/aux/carriers/failure.rb', line 18

def initialize(code, details = nil, payload = nil)
  @code = code
  @details = details
  @payload = payload
end

Instance Attribute Details

#code ⇒ Symbol (readonly)

Returns:

  • (Symbol) 


13
14
15
 
# File 'lib/aux/carriers/failure.rb', line 13

def code
  @code
end

#details ⇒ Object? (readonly)

Returns:

  • (Object, nil) 


13
 
# File 'lib/aux/carriers/failure.rb', line 13

attr_reader :code, :details, :payload

#payload ⇒ Object (readonly)

Returns the value of attribute payload.



13
 
# File 'lib/aux/carriers/failure.rb', line 13

attr_reader :code, :details, :payload

Instance Method Details

#failed? ⇒ TrueClass Also known as: failure?

Returns:

  • (TrueClass) 


38
39
40
 
# File 'lib/aux/carriers/failure.rb', line 38

def failed?
  true
end

#succeeded? ⇒ FalseClass Also known as: successful?, success?

Returns:

  • (FalseClass) 


25
26
27
 
# File 'lib/aux/carriers/failure.rb', line 25

def succeeded?
  false
end