https://github.com/disruptek/badresults

a less fascist fork of nim-result
https://github.com/disruptek/badresults

nim result results return type

Last synced: about 1 month ago
JSON representation

a less fascist fork of nim-result

• Host: GitHub
• URL: https://github.com/disruptek/badresults
• Owner: disruptek
• License: mit
• Created: 2020-02-16T20:35:54.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-02-12T16:10:30.000Z (12 months ago)
• Last Synced: 2024-05-02T04:32:40.993Z (9 months ago)
• Topics: nim, result, results, return, type
• Language: Nim
• Homepage:
• Size: 88.9 KB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# badresults

[![Test Matrix](https://github.com/disruptek/badresults/workflows/CI/badge.svg)](https://github.com/disruptek/badresults/actions?query=workflow%3ACI)

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/disruptek/badresults?style=flat)](https://github.com/disruptek/badresults/releases/latest)

![Minimum supported Nim version](https://img.shields.io/badge/nim-2.0.0%2B-informational?style=flat&logo=nim)

[![License](https://img.shields.io/github/license/disruptek/badresults?style=flat)](#license)

_see 2.1.x releases if you need support for an earlier Nim compiler_

This is _mostly_ a copy of an early version of [the Status nim-result

package](https://github.com/arnetheduck/nim-result) that differs in that you

do not need to provide a side-effect-free (`func`) implementation of `$` for

all types used in your `Result`.

Also, it makes fewer uses of templates and has a narrower API to make it

simpler and prevent C-codegen issues experienced with `nim-result`.

Also, it supports `toException` and `$` overrides for error types which are

implemented in nested scopes.

Also, it might not work in Windows because I have no way to test it there.

If you care more for performance and features, use `nim-result` or ask nicely

and maybe we add a symbol or two back in.  I personally consider compilation

a non-negotiable feature.

## Documentation

See [the documentation for the badresults module](https://disruptek.github.io/badresults/badresults.html) as generated directly from the source.

Here's the type we provide:

```nim

Result[T; E] = object

  case o: bool

  of false:

      e: E

  of true:

      v: T

```

## Usage

This example is from the documentation:

```nim

# It's convenient to create an alias - most likely, you'll do just fine

# with strings as error!

type R = Result[int, string]

# Once you have a type, use `ok` and `err`:

func works(): R =

  # ok says it went... ok!

  R.ok 42

func fails(): R =

  # or type it like this, to not repeat the type!

  result.err "bad luck"

# If you provide this exception converter, this exception will be raised

# on dereference

func toException(v: Error): ref CatchableException = (ref CatchableException)(msg: $v)

try:

  get RE[int].err(a)

except CatchableException:

  echo "in here!"

```

## Installation

```

$ nimph clone badresults

```

or if you're still using Nimble like it's 2012,

```

$ nimble install https://github.com/disruptek/badresults

```

## License

MIT