Packages

Errors is an Elixir package that adds debugging context to error reasons. It is meant to be used in the tagged tuple style of error handling, where a function may return `{:ok, result}` or `{:error, reason}`.

Current section

Files

Jump to
errors doc api-reference.html
Raw

doc/api-reference.html

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.16.4">
<title>API Reference – errors v0.1.0</title>
<link rel="stylesheet" href="dist/app-5b9e160cec.css" />
<link rel="canonical" href="https://hexdocs.pm/errors/api-reference.html" />
<script src="dist/sidebar_items-68c2fa3a8c.js"></script>
</head>
<body data-type="extras">
<script>try { if(localStorage.getItem('night-mode')) document.body.className += ' night-mode'; } catch (e) { }</script>
<div class="main">
<button class="sidebar-toggle">
<span class="icon-menu" aria-hidden="true"></span>
<span class="sr-only">Toggle Sidebar</span>
</button>
<section class="sidebar">
<a href="api-reference.html" class="sidebar-projectLink">
<div class="sidebar-projectDetails">
<h1 class="sidebar-projectName">
errors
</h1>
<h2 class="sidebar-projectVersion">
v0.1.0
</h2>
</div>
</a>
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button">
<span class="icon-search" aria-hidden="true"></span>
</button>
<input name="q" type="text" id="search-list" class="search-input" placeholder="search" aria-label="Search" autocomplete="off" />
</form>
<ul class="sidebar-listNav">
<li><a id="extras-list" href="#full-list">Pages</a></li>
<li><a id="modules-list" href="#full-list">Modules</a></li>
<li><a id="exceptions-list" href="#full-list">Exceptions</a></li>
<li><a id="protocols-list" href="#full-list">Protocols</a></li>
</ul>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<small class="visible-xs">errors v0.1.0</small>
API Reference
</h1>
<section class="details-list">
<h2 id="modules" class="section-heading">
<a href="#modules" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Modules
</h2>
<div class="summary">
<div class="summary-row">
<div class="summary-signature"><a href="Errors.html">Errors</a></div>
</div>
</div>
</section>
<section class="details-list">
<h2 id="exceptions" class="section-heading">
<a href="#exceptions" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Exceptions
</h2>
<div class="summary">
<div class="summary-row">
<div class="summary-signature"><a href="Errors.WrappedError.html">Errors.WrappedError</a></div>
</div>
</div>
</section>
<section class="details-list">
<h2 id="protocols" class="section-heading">
<a href="#protocols" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Protocols
</h2>
<div class="summary">
<div class="summary-row">
<div class="summary-signature"><a href="Errors.Cause.html">Errors.Cause</a></div>
</div>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.16.4),
</span>
<span class="line">
designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>.
</span>
</p>
<button class="night-mode-toggle"><span class="sr-only">Switch theme</span></button>
</footer>
</div>
</div>
</section>
</div>
<script src="dist/app-da04b39d0c.js"></script>
</body>
</html>