Module: R

Extended by:

T::Sig

Defined in:

lib/r/version.rb,
lib/r.rb,
lib/r/result.rb,
lib/r/unwrap_failed_error.rb

Overview

typed: strict frozen_string_literal: true

Defined Under Namespace

Modules: Result Classes: Err, Ok, UnwrapFailedError

Constant Summary

VERSION =

Version number.

"0.0.1"

Class Method Summary

• .err(value) ⇒ Err[T.type_parameter(:E)]

  Creates a new instance of Err.

• .ok(value) ⇒ Ok[T.type_parameter(:T)]

  Creates a new instance of Ok.

Class Method Details

.err(value) ⇒ Err[T.type_parameter(:E)]

Creates a new instance of Err.

This is a shorthand for R::Err.new(...).

Examples:

x = T.let(R.err("sadface"), R::Result[Integer, String])
x.is_a?(R::Err) # => true

Parameters:

• value (T.type_parameter(:E))

Returns:

• (Err[T.type_parameter(:E)])

See Also:

• R::Err#initialize
• R::Err.new

# File 'lib/r/result.rb', line 1152

def self.err(value)
  Err.new(value)
end

.ok(value) ⇒ Ok[T.type_parameter(:T)]

Creates a new instance of Ok.

This is a shorthand for R::Ok.new(...).

Examples:

x = T.let(R.ok(2), R::Result[Integer, String])
x.is_a?(R::Ok) # => true

Parameters:

• value (T.type_parameter(:T))

Returns:

• (Ok[T.type_parameter(:T)])

See Also:

• R::Ok#initialize
• R::Ok.new

# File 'lib/r/result.rb', line 596

def self.ok(value)
  Ok.new(value)
end