Class: Wasmtime::Component::Result

Inherits:
Object
  • Object
show all
Defined in:
lib/wasmtime/component.rb

Overview

Represents a component model’s result<O, E> type.

Defined Under Namespace

Classes: UncheckedResult

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.error(error) ⇒ Result

Construct an error result.

Parameters:

  • error (Object) —

    the error value

Returns:

[View source]

19
20
21
 
# File 'lib/wasmtime/component.rb', line 19

def error(error)
  new(false, error)
end

.ok(ok) ⇒ Result

Construct an ok result.

Parameters:

  • ok (Object) —

    the ok value

Returns:

[View source]

12
13
14
 
# File 'lib/wasmtime/component.rb', line 12

def ok(ok)
  new(true, ok)
end

Instance Method Details

#==(other) ⇒ Object

[View source]

54
55
56
 
# File 'lib/wasmtime/component.rb', line 54

def ==(other)
  eql?(other)
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean)
[View source]

58
59
60
61
62
63
64
65
66
67
 
# File 'lib/wasmtime/component.rb', line 58

def eql?(other)
  return false unless self.class == other.class
  return false unless ok? == other.ok?

  if ok?
    ok == other.ok
  else
    error == other.error
  end
end

#error ⇒ Object

Returns the error value of this Result if it is #error?, otherwise raises.

Returns:

  • (Object)

Raises:

[View source]

38
39
40
41
42
 
# File 'lib/wasmtime/component.rb', line 38

def error
  raise UncheckedResult, "expected error, was ok" unless error?

  @value
end

#error? ⇒ Boolean

Returns Whether the result is an error.

Returns:

  • (Boolean) —

    Whether the result is an error

[View source]

50
51
52
 
# File 'lib/wasmtime/component.rb', line 50

def error?
  !@ok
end

#hash ⇒ Object

[View source]

69
70
71
 
# File 'lib/wasmtime/component.rb', line 69

def hash
  [self.class, @ok, @value].hash
end

#ok ⇒ Object

Returns the ok value of this Result if it is #ok?, otherwise raises.

Returns:

  • (Object)

Raises:

[View source]

29
30
31
32
33
 
# File 'lib/wasmtime/component.rb', line 29

def ok
  raise UncheckedResult, "expected ok, was error" unless ok?

  @value
end

#ok? ⇒ Boolean

Returns Whether the result is ok.

Returns:

  • (Boolean) —

    Whether the result is ok

[View source]

45
46
47
 
# File 'lib/wasmtime/component.rb', line 45

def ok?
  @ok
end