struct Ok(T)

• Ok(T)
• Result(T)
• Struct
• Value
• Object

Overview

Result Ok.

Defined in:

Constructors

• .[](value) : Ok

  Syntax sugar for Ok.done(value).

• .created(value) : Ok

  Creates a new Ok instance with the status :created.

• .destroyed(value) : Ok

  Creates a new Ok instance with the status :destroyed.

• .done(value) : Ok

  Creates a new Ok instance with the status :done.

• .new(status : Symbol, value : T)

  Creates a new Ok instance with a custom #status.

• .new(value : T)
• .pending(value) : Ok

  Creates a new Ok instance with the status :pending.

• .updated(value) : Ok

  Creates a new Ok instance with the status :updated.

Class Method Summary

• .type : Symbol

  Result type as a Symbol.

Instance Method Summary

• #status : Symbol

  Result status as a Symbol (:done or :fail, etc).

• #type : Symbol

  Result type as a Symbol.

• #unwrap

  Unwrap the result #value (like Result::unwrap in Rust).

• #value : T

  Returns the result value.

Constructor Detail

Ok["hello"] # => same as Ok.done("hello")

res = Ok.created(value)
res.status # => :created

pp res.unwrap
# or
pp res.value

res = Ok.destroyed(value)
res.status # => :destroyed

pp res.unwrap
# or
pp res.value

res = Ok.done(value)
res.status # => :done

pp res.unwrap
# or
pp res.value

res = Ok.pending(value)
res.status # => :pending

pp res.unwrap
# or
pp res.value

res = Ok.updated(value)
res.status # => :updated

pp res.unwrap
# or
pp res.value

Class Method Detail

Ok.type # => :ok

Instance Method Detail

res.type # => :ok