Class: Loqate::Result

Inherits:
Object
  • Object
show all
Defined in:
lib/loqate/result.rb

Overview

Generic return value of an operation. Provides a consistent way to determine if an operation has succeeded or failed.

Direct Known Subclasses

Failure, Success

Defined Under Namespace

Modules: Mixin Classes: Failure, Success

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value:, code: nil) ⇒ Result

Creates a new Result

Examples:

Creating a new Result

Result.new(value: person.errors, code: :not_updated)

Parameters:

  • value (Object) —

    The original return value of an operation.

  • code (Symbol) (defaults to: nil) —

    A code to describe the kind of result.



13
14
15
16
 
# File 'lib/loqate/result.rb', line 13

def initialize(value:, code: nil)
  @value = value
  @code  = code
end

Instance Attribute Details

#code ⇒ Symbol (readonly)

A code to describe the kind of result.

Returns:

  • (Symbol) 


22
23
24
 
# File 'lib/loqate/result.rb', line 22

def code
  @code
end

#value ⇒ Object (readonly)

The original return value of an operation.

Returns:

  • (Object) 


28
29
30
 
# File 'lib/loqate/result.rb', line 28

def value
  @value
end