mirror of
https://github.com/roc-lang/roc.git
synced 2025-09-27 13:59:08 +00:00
67 lines
2.2 KiB
Text
67 lines
2.2 KiB
Text
interface Result
|
|
exposes
|
|
[
|
|
Result,
|
|
after,
|
|
isOk,
|
|
isErr,
|
|
map,
|
|
mapErr,
|
|
withDefault
|
|
]
|
|
imports []
|
|
|
|
## The result of an operation that could fail: either the operation went
|
|
## okay, or else there was an error of some sort.
|
|
Result ok err : [ Ok ok, Err err ]
|
|
|
|
## Return True if the result indicates a success, else return False
|
|
##
|
|
## >>> Result.isOk (Ok 5)
|
|
isOk : Result * * -> bool
|
|
|
|
## Return True if the result indicates a failure, else return False
|
|
##
|
|
## >>> Result.isErr (Err "uh oh")
|
|
isErr : Result * * -> bool
|
|
|
|
## If the result is `Ok`, return the value it holds. Otherwise, return
|
|
## the given default value.
|
|
##
|
|
## >>> Result.withDefault (Ok 7) 42
|
|
##
|
|
## >>> Result.withDefault (Err "uh oh") 42
|
|
withDefault : Result ok err, ok -> ok
|
|
|
|
## If the result is `Ok`, transform the entire result by running a conversion
|
|
## function on the value the `Ok` holds. Then return that new result.
|
|
##
|
|
## (If the result is `Err`, this has no effect. Use `afterErr` to transform an `Err`.)
|
|
##
|
|
## >>> Result.after (Ok -1) \num -> if num < 0 then Err "negative!" else Ok -num
|
|
##
|
|
## >>> Result.after (Err "yipes!") \num -> if num < 0 then Err "negative!" else Ok -num
|
|
after : Result before err, (before -> Result after err) -> Result after err
|
|
|
|
## If the result is `Ok`, transform the value it holds by running a conversion
|
|
## function on it. Then return a new `Ok` holding the transformed value.
|
|
##
|
|
## (If the result is `Err`, this has no effect. Use [mapErr] to transform an `Err`.)
|
|
##
|
|
## >>> Result.map (Ok 12) Num.negate
|
|
##
|
|
## >>> Result.map (Err "yipes!") Num.negate
|
|
##
|
|
## `map` functions like this are common in Roc, and they all work similarly.
|
|
## See for example [List.map], `Set.map`, and `Dict.map`.
|
|
map : Result before err, (before -> after) -> Result after err
|
|
|
|
## If the result is `Err`, transform the value it holds by running a conversion
|
|
## function on it. Then return a new `Err` holding the transformed value.
|
|
##
|
|
## (If the result is `Ok`, this has no effect. Use [map] to transform an `Ok`.)
|
|
##
|
|
## >>> Result.mapErr (Err "yipes!") Str.isEmpty
|
|
##
|
|
## >>> Result.mapErr (Ok 12) Str.isEmpty
|
|
mapErr : Result ok before, (before -> after) -> Result ok after
|