API Reference hike v0.1.0

modules

Modules

Hike is a library that provides elevated data types, namely Option, Either, and MayFail, in the Elixir programming language. These elevated data types offer additional functionality and safety compared to the basic data types provided by Elixir.

Hike.Either represents a value that can be one of two possibilities: either a Left state or a Right state. It is commonly used in error handling or when a function can return different types of results.

Hike.MayFail represents a value that may either succeed with a value or fail with an error. It combines the functionality of Hike.Option and Hike.Either, making it suitable for scenarios where a value can be optional and can also potentially fail.

The Hike.Option module provides an implementation of the Optional data type. It defines a struct Option with a single field value which can either be @none nil or any other value of type <T>. This implementation provides functions to work with Optional data including