# Ark
<!-- rdmx :badges
hexpm : "ark?color=4e2a8e"
github_action : "lud/ark/elixir.yaml?label=CI&branch=main"
license : ark
-->
[](https://hex.pm/packages/ark)
[](https://github.com/lud/ark/actions/workflows/elixir.yaml?query=branch%3Amain)
[](https://hex.pm/packages/ark)
<!-- rdmx /:badges -->
Ark is a collection of small utilities for common Elixir patterns: things you
find yourself rewriting across projects, too small to warrant a dedicated
package but absent from the standard library.
The implementations are intentionally simple. They cover the common case well,
but your project's needs may outgrow them, at which point reaching for a
dedicated library or a custom solution is the right call.
## Installation
<!-- rdmx :app_dep vsn:$app_vsn -->
```elixir
def deps do
[
{:ark, "~> 0.13"},
]
end
```
<!-- rdmx /:app_dep -->
## Plugins
<!-- rdmx ark:plugins -->
### `Ark.Error`
This module provides function to work errors as data.
### `Ark.Ok`
This module provides base functions to work with ok/error tuples.
### `Ark.Paginator`
This module provides a helper to build streams from paginated sources.
A user-supplied callback is called with an initial state and is expected to
return the items for the current page along with the next state, until it
signals that pagination is over.
```elixir
pages = %{1 => [1, 2, 3], 2 => [4, 5, 6]}
{:ok, stream} =
Ark.Paginator.stream(1, fn page ->
case Map.get(pages, page, []) do
[] -> {:halt, []}
items -> {:cont, items, page + 1}
end
end)
Enum.to_list(stream)
# => [1, 2, 3, 4, 5, 6]
```
### `Ark.Retry`
This module provides base functions to retry operations.
### `Ark.StructAccess`
This module provides a simple way to implement the Access behaviour for any struct.
#### Example
```elixir
defmodule MyStruct do
defstruct [:k]
use Ark.StructAccess
end
s = %MyStruct{k: 1}
put_in(s.k, 2)
# => %MyStruct{k: 2}
```
### `Ark.Timeout`
Helpers to work with numerical timeout values
<!-- rdmx /ark:plugins -->
## Documentation
The docs can be found at [hexdocs](https://hexdocs.pm/ark).
