Class: ParamParam::Failure

Inherits:

Result

• Object
• Result
• ParamParam::Failure

Defined in:

lib/param_param/result.rb

Overview

Describes failed result.

Instance Attribute Summary

• #error ⇒ Object readonly

  An error related to the failure.

Instance Method Summary

• #failure? ⇒ Boolean

  Returns true.

• #initialize(error) ⇒ Failure constructor

  A new instance of Failure.

Methods inherited from Result

#success?

Constructor Details

#initialize(error) ⇒ Failure

Returns a new instance of Failure.

# File 'lib/param_param/result.rb', line 38

def initialize(error)
  @error = error
end

Instance Attribute Details

#error ⇒ Object (readonly)

An error related to the failure.

# File 'lib/param_param/result.rb', line 36

def error
  @error
end

Instance Method Details

#failure? ⇒ Boolean

Returns true.

Returns:

• (Boolean)

# File 'lib/param_param/result.rb', line 43

def failure?
  true
end