Result

Utilities for working with the Result data type.

The Result type is an enum that represents the possibility of a success case (with the Ok variant), or an error case (with the Err variant). Use a Result as the return type of a function that may return an error.

1

from "result" include Result

1

let success = Ok((x) => 1 + x) // Creates a successful Result containing (x) => 1 + x

1

let failure = Err("Something bad happened") // Creates an unsuccessful Result containing "Something bad happened"

Values

Functions and constants included in the Result module.

Result.isOk

1

isOk : (result: Result<a, b>) => Bool

Checks if the Result is the Ok variant.

Parameters:

Returns:

Result.isErr

1

isErr : (result: Result<a, b>) => Bool

Checks if the Result is the Err variant.

Parameters:

Returns:

Result.toOption

1

toOption : (result: Result<a, b>) => Option<a>

Converts the Result to an Option. An error value is discarded and replaced with None.

Parameters:

Returns:

Result.flatMap

1

flatMap : (fn: (a => Result<b, c>), result: Result<a, c>) => Result<b, c>

If the Result is Ok(value), applies the given function to the value to produce a new Result.

Parameters:

Returns:

Result.flatMapErr

1

flatMapErr : (fn: (a => Result<b, c>), result: Result<b, a>) => Result<b, c>

If the Result is an Err(value), applies the given function to the value to produce a new Result.

Parameters:

Returns:

Result.map

1

map : (fn: (a => b), result: Result<a, c>) => Result<b, c>

If the Result is Ok(value), applies the given function to the value and wraps the new value in an Ok variant.

Parameters:

Returns:

Result.mapErr

1

mapErr : (fn: (a => b), result: Result<c, a>) => Result<c, b>

If the Result is Err(value), applies the given function to the value and wraps the new value in an Err variant.

Parameters:

Returns:

Result.mapWithDefault

1

mapWithDefault : (fn: (a => b), def: b, result: Result<a, c>) => b

If the Result is Ok(value), applies the given function to the value to produce a new value, otherwise uses the default value. Useful for unwrapping a successful Result while providing a fallback for any errors that can occur.

Parameters:

Returns:

Result.mapWithDefaultFn

1
2

mapWithDefaultFn :
  (fnOk: (a => b), fnErr: (c => b), result: Result<a, c>) => b

If the Result is Ok(value), applies the fnOk function to the value to produce a new value. If the Result is Err(value), applies the fnErr function to the value to produce a new value. Useful for unwrapping a Result into a value, whether it is successful or unsuccessful.

Parameters:

Returns:

Result.(||)

1

(||) : (result1: Result<a, b>, result2: Result<a, b>) => Result<a, b>

Behaves like a logical OR (||) where the first Result is only returned if it is the Ok variant and falling back to the second Result in all other cases.

Parameters:

Returns:

Result.(&&)

1

(&&) : (result1: Result<a, b>, result2: Result<a, b>) => Result<a, b>

Behaves like a logical AND (&&) where the first Result is only returned if it is the Err variant and falling back to the second Result in all other cases.

Parameters:

Returns:

Result.peek

1

peek : (fnOk: (a => b), fnErr: (c => d), result: Result<a, c>) => Void

If the Result is Ok(value), applies the fnOk function to the value without producing a new value. If the Result is Err(value), applies the fnErr function to the value without producing a new value. Useful for inspecting Results without changing anything.

Parameters:

Result.peekOk

1

peekOk : (fn: (a => b), result: Result<a, c>) => Void

If the Result is Ok(value), applies the given function to the value without producing a new value.

Parameters:

Result.peekErr

1

peekErr : (fn: (a => b), result: Result<c, a>) => Void

If the Result is Err(value), applies the given function to the value without producing a new value.

Parameters:

Result.expect

1

expect : (msg: String, result: Result<a, b>) => a

Extracts the value inside an Ok result, otherwise throw an exception containing the message and contents of the Err.

Parameters:

Returns:

Throws:

Failure(String)

• When the result is Err

Examples:

1

Result.expect("Unexpected error", Ok(1234)) + 42

Result.unwrap

1

unwrap : (result: Result<a, b>) => a

Extracts the value inside an Ok result, otherwise throw an exception containing a default message and contents of the Err.

Parameters:

Returns:

Throws:

Failure(String)

• When the result is Err

Examples:

1

Result.unwrap(Err("This will throw"))