Class Ok<T, ErrObj>

a class indicating that the result is Ok (Succeeded).

Type Parameters

T
ErrObj

Hierarchy

Result<T, ErrObj>
- Ok

Implements

IResult<T, ErrObj>

Index

Constructors

constructor

Properties

val

Methods

Constructors

constructor

new Ok<T, ErrObj>(val?: T): Ok<T, ErrObj>

Overrides Result<T, ErrObj>.constructor
- Defined in foundation/misc/Result.ts:59
Type Parameters
- T
- ErrObj
Parameters
- Optional val: T
Returns Ok<T, ErrObj>

Properties

Protected Optional val

val?: T | RnError<ErrObj>

Methods

get

get(): T

- Defined in foundation/misc/Result.ts:93
Returns T

isErr

isErr(): false

Implementation of IResult.isErr
- Defined in foundation/misc/Result.ts:89
Returns false

isOk

isOk(): this is Ok<T, ErrObj>

Implementation of IResult.isOk
- Defined in foundation/misc/Result.ts:85
Returns this is Ok<T, ErrObj>

match

match(obj: { Err: any; Finally?: any; Ok: any }): void

Implementation of IResult.match
Inherited from Result.match
- Defined in foundation/misc/Result.ts:33
Parameters
- obj: { Err: any; Finally?: any; Ok: any }
  - Err:function
    - Err(value: RnError<ErrObj>): void
    - Defined in foundation/misc/Result.ts:35
      Parameters
      - value: RnError<ErrObj>
      Returns void
  - Finally?:function
    - Finally(): void
    - Defined in foundation/misc/Result.ts:36
      Returns void
  - Ok:function
    - Ok(value: T): void
    - Defined in foundation/misc/Result.ts:34
      Parameters
      - value: T
      Returns void
Returns void

name

name(): string

Implementation of IResult.name
Inherited from Result.name
- Defined in foundation/misc/Result.ts:47
Returns string

true

true(): this is Ok<T, ErrObj>

- Defined in foundation/misc/Result.ts:81
Returns this is Ok<T, ErrObj>

unwrap

unwrap(catchFn: ((err: RnError<ErrObj>) => void)): T

Implementation of IResult.unwrap
- Defined in foundation/misc/Result.ts:71
This method is essentially same to the Ok::and_then() in Rust language

Parameters
- catchFn: ((err: RnError<ErrObj>) => void)
  - - (err: RnError<ErrObj>): void
    - Parameters
      - err: RnError<ErrObj>
      Returns void
Returns T

unwrapForce

unwrapForce(): T

Implementation of IResult.unwrapForce
- Defined in foundation/misc/Result.ts:75
Returns T

Generated using TypeDoc