Class: TTY::Option::Result

Inherits:

Object

• Object
• TTY::Option::Result

Defined in:

lib/tty/option/result.rb

Overview

A monad that respresents success and failure conditions

Direct Known Subclasses

Failure, Success

Defined Under Namespace

Classes: Failure, Success

Instance Attribute Summary

• #error ⇒ Object readonly

  Reason for failure.

• #value ⇒ Object readonly

  Wrapped value.

Class Method Summary

• .failure(value) ⇒ Object

  Wrap a value in a failure monad.

• .success(value) ⇒ Object

  Wrap a value in a success monad.

Instance Method Summary

• #failure? ⇒ Boolean

  Check whether or not a result is a failure class.

• #success? ⇒ Boolean

  Check whether or not a result is a success monad.

Instance Attribute Details

#error ⇒ Object (readonly)

Reason for failure

# File 'lib/tty/option/result.rb', line 29

def error
  @error
end

#value ⇒ Object (readonly)

Wrapped value

# File 'lib/tty/option/result.rb', line 24

def value
  @value
end

Class Method Details

.failure(value) ⇒ Object

Wrap a value in a failure monad

# File 'lib/tty/option/result.rb', line 17

def self.failure(value)
  Failure.new(value)
end

.success(value) ⇒ Object

Wrap a value in a success monad

# File 'lib/tty/option/result.rb', line 10

def self.success(value)
  Success.new(value)
end

Instance Method Details

#failure? ⇒ Boolean

Check whether or not a result is a failure class

Returns:

• (Boolean)

# File 'lib/tty/option/result.rb', line 45

def failure?
  is_a?(Failure)
end

#success? ⇒ Boolean

Check whether or not a result is a success monad

Returns:

• (Boolean)

# File 'lib/tty/option/result.rb', line 36

def success?
  is_a?(Success)
end