Class: Aux::Carriers::Success

Inherits:

Object

Object
Aux::Carriers::Success

Defined in:: lib/aux/carriers/success.rb

Instance Attribute Summary collapse

#code ⇒ Symbol readonly
#payload ⇒ Object readonly

Returns the value of attribute payload.

Instance Method Summary collapse

#failed? ⇒ FalseClass (also: #failure?)
#initialize(code, payload = nil) ⇒ Success constructor

A new instance of Success.
#succeeded? ⇒ TrueClass (also: #successful?, #success?)

Constructor Details

#initialize(code, payload = nil) ⇒ `Success`

Returns a new instance of Success.

Parameters:

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

# File 'lib/aux/carriers/success.rb', line 14

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

Instance Attribute Details

#code ⇒ `Symbol` (readonly)

Returns:

(Symbol)



10
11
12

# File 'lib/aux/carriers/success.rb', line 10

def code
  @code
end

#payload ⇒ `Object` (readonly)

Returns the value of attribute payload.

10	# File 'lib/aux/carriers/success.rb', line 10 attr_reader :code, :payload

Instance Method Details

#failed? ⇒ `FalseClass` Also known as: failure?

Returns:

(FalseClass)



33
34
35

# File 'lib/aux/carriers/success.rb', line 33

def failed?
  false
end

#succeeded? ⇒ `TrueClass` Also known as: successful?, success?

Returns:

(TrueClass)



20
21
22

# File 'lib/aux/carriers/success.rb', line 20

def succeeded?
  true
end