Class: Cuprum::Result

Parent Namespace

Cuprum

Defined In

lib/cuprum/result.rb

Table Of Contents

• Overview
• Constants
  • STATUSES
• Constructor
• Instance Attributes
  • error
  • status
  • value
• Instance Methods
  • ==
  • failure?
  • initialize
  • properties
  • success?
  • to_cuprum_result

Overview

Data object that encapsulates the result of calling a Cuprum command.

Back To Top

Constants

STATUSES

= %i[success failure].freeze

Enumerates the default permitted values for a Result#status.

Back To Top

Constructor

#initialize(value: nil, error: nil, status: nil) => Result

Parameters

• value (Object) — the value returned by calling the command.
• error (Object) — the error (if any) generated when the command was called. Can be a Cuprum::Error, a model errors object, etc.
• status (String, Symbol) — the status of the result. Must be :success, :failure, or nil.

Returns

• (Result) — a new instance of Result

Back To Top

Instance Attributes

#error => Object (readonly)

Returns

• (Object) — the error (if any) generated when the command was called.

#status => Symbol (readonly)

Returns

• (Symbol) — the status of the result, either :success or :failure.

#value => Object (readonly)

Returns

• (Object) — the value returned by calling the command.

Back To Top

Instance Methods

#==(other) => Boolean

Compares the other object to the result.

In order to match the result, the object must respond to the #to_h method, and the value of object.to_h must be equal to the value of result.properties.

Parameters

• other (#to_h) — the result or object to compare.

Returns

• (Boolean) — true if all values match the result, otherwise false.

#failure? => Boolean

Returns

• (Boolean) — true if the result status is :failure, otherwise false.

#properties => Hash{Symbol => Object}

Also known as: to_h

Returns

• (Hash{Symbol => Object}) — a Hash representation of the result.

#success? => Boolean

Returns

• (Boolean) — true if the result status is :success, otherwise false.

#to_cuprum_result => Cuprum::Result

Returns

• (Cuprum::Result) — The result.

Back To Top

---

Back to Documentation | Versions | 1.3 | Reference | Cuprum