# Rexult

[![CI](https://github.com/mdg/rexult/actions/workflows/elixir.yml/badge.svg)](https://github.com/mdg/rexult/actions/workflows/elixir.yml)
[![Module Version](https://img.shields.io/hexpm/v/rexult.svg)](https://hex.pm/packages/rexult)
[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/rexult/Exit.html)
[![Total Downloads](https://img.shields.io/hexpm/dt/rexult.svg)](https://hex.pm/packages/rexult)
[![License](https://img.shields.io/hexpm/l/rexult.svg)](https://github.com/mdg/rexult/blob/main/LICENSE)
[![Last Updated](https://img.shields.io/github/last-commit/mdg/rexult.svg)](https://github.com/mdg/rexult/commits/main)

A library for replicating some of the behavior of the [std::result
module from Rust](https://doc.rust-lang.org/stable/std/result/)

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `rexult` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:rexult, "~> 0.1"},
  ]
end
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at <https://hexdocs.pm/rexult>.

## See Also

Another good Result library can be found at
[github.com/iodevs/result](https://github.com/iodevs/result)