status-im
/
nim-stew
mirror of https://github.com/status-im/nim-stew.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

results: document experimental error shortcut, and its gotchas (#168)

This commit is contained in:
Jacek Sieka 2023-01-20 15:32:34 +01:00 committed by GitHub
parent 609edbb5db
commit 19a6aea53b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
stew/results.nim
View File

@ -854,7 +854,18 @@ template valueOr*[T: not void, E](self: Result[T, E], def: untyped): T =
## v = Result[int, string].err("hello")
## x = v.valueOr: 42 # x == 42 now
## y = v.valueOr: raise (ref ValueError)(msg: "v is an error, gasp!")
## # experimental: direct error access using an unqualified `error` symbol
## z = v.valueOr: raise (ref ValueError)(msg: error)
## ```
##
## `error` access:
##
## TODO experimental, might change in the future
##
## The template contains a shortcut for accessing the error of the result,
## without specifying the error - it can only be used outside of generic code,
## see https://github.com/status-im/nim-stew/issues/161#issuecomment-1397121386
##
let s = (self) # TODO avoid copy
if s.o: s.v
else: