Class: NextStation::Result

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

Overview

Represents the result of an operation.

Direct Known Subclasses

Failure, Success

Defined Under Namespace

Classes: Error, Failure, Success

Instance Method Summary collapse

Instance Method Details

#error ⇒ NextStation::Result::Error?

Returns The error object if it’s a failure.

Examples:

result.error => #<NextStation::Result::Error: …>

Example methods inside of an NextStation::Result::Error

result.error.type
result.error.message
result.error.details

Returns:

See Also:



32
33
34
 
# File 'lib/next_station/result.rb', line 32

def error
  nil
end

#failure? ⇒ Boolean

Returns true if the result is a failure.

Examples:

result.failure? => true

result.failure? => false

Returns:

  • (Boolean) —

    true if the result is a failure.



16
17
18
 
# File 'lib/next_station/result.rb', line 16

def failure?
  false
end

#success? ⇒ Boolean

Returns true if the result is a success.

Examples:

result.success? => true

result.success? => false

Returns:

  • (Boolean) —

    true if the result is a success.



9
10
11
 
# File 'lib/next_station/result.rb', line 9

def success?
  false
end

#value ⇒ Object?

Returns The value of a successful result.

Returns:

  • (Object, nil) —

    The value of a successful result.



21
22
23
 
# File 'lib/next_station/result.rb', line 21

def value
  nil
end