Class: Cuprum::Result

Inherits:

Object

• Object
• Cuprum::Result

Defined in:

lib/cuprum/result.rb

Overview

Data object that encapsulates the result of calling a Cuprum function or operation.

Instance Attribute Summary

• #errors ⇒ Array

  The errors (if any) generated when the function was called.

• #value ⇒ Object

  The value returned by calling the function.

Instance Method Summary

• #failure? ⇒ Boolean

  False if the function did not generate any errors, otherwise true.

• #success? ⇒ Boolean

  True if the function did not generate any errors, otherwise false.

Instance Attribute Details

#errors ⇒ Array

Returns the errors (if any) generated when the function was called.

Returns:

• (Array) —

  the errors (if any) generated when the function was called.

# File 'lib/cuprum/result.rb', line 14

def errors
  @errors ||= []
end

#value ⇒ Object

Returns the value returned by calling the function.

Returns:

• (Object) —

  the value returned by calling the function.

# File 'lib/cuprum/result.rb', line 8

def value
  @value
end

Instance Method Details

#failure? ⇒ Boolean

Returns false if the function did not generate any errors, otherwise true.

Returns:

• (Boolean) —

  false if the function did not generate any errors, otherwise true.

# File 'lib/cuprum/result.rb', line 20

def failure?
  !errors.empty?
end

#success? ⇒ Boolean

Returns true if the function did not generate any errors, otherwise false.

Returns:

• (Boolean) —

  true if the function did not generate any errors, otherwise false.

# File 'lib/cuprum/result.rb', line 26

def success?
  errors.empty?
end