Packages

errors

0.1.0
0.1.0

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}`.

HexDocs

Current section

Files

Jump to
Readme
1 Version
0 Dependencies
Dependants
Files
Activity
errors doc Errors.Cause.html
Raw

doc/Errors.Cause.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>Errors.Cause – errors v0.1.0</title>

    <link rel="stylesheet" href="dist/app-5b9e160cec.css" />

    

      <link rel="canonical" href="https://hexdocs.pm/errors/Errors.Cause.html" />

    

    

    <script src="dist/sidebar_items-68c2fa3a8c.js"></script>

    

  </head>

  <body data-type="protocols">

    <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>

        Errors.Cause <small>protocol</small>

        

          <a href="https://github.com/nucleartide/errors/blob/master/errors/cause.ex#L1" title="View Source" class="view-source" rel="help">

            <span class="icon-code" aria-hidden="true"></span>

            <span class="sr-only">View Source</span>

          </a>

        

      </h1>



      



      

        <section id="summary" class="details-list">

          <h1 class="section-heading">

            <a class="hover-link" href="#summary">

              <span class="icon-link" aria-hidden="true"></span>

              <span class="sr-only">Link to this section</span>

            </a>

            Summary

          </h1>

          

  <div class="summary-types summary">

    <h2>

      <a href="#types">Types</a>

    </h2>

    <div class="summary-row">

  <div class="summary-signature">

    <a href="#t:t/0">t()</a>

  </div>

  

</div>



  </div>





          

  <div class="summary-functions summary">

    <h2>

      <a href="#functions">Functions</a>

    </h2>

    <div class="summary-row">

  <div class="summary-signature">

    <a href="#cause/1">cause(error)</a>

  </div>

  

    <div class="summary-synopsis"><p>Return the underlying cause of an Exception</p>

</div>

  

</div>



  </div>





          



        </section>

      



      

        <section id="types" class="details-list">

          <h1 class="section-heading">

            <a class="hover-link" href="#types">

              <span class="icon-link" aria-hidden="true"></span>

              <span class="sr-only">Link to this section</span>

            </a>

            Types

          </h1>

          <div class="types-list">

            <div class="detail" id="t:t/0">

  

  

  <div class="detail-header">

    <a href="#t:t/0" class="detail-link" title="Link to this type">

      <span class="icon-link" aria-hidden="true"></span>

      <span class="sr-only">Link to this type</span>

    </a>

    <span class="signature">t()</span>

    

      <a href="https://github.com/nucleartide/errors/blob/master/errors/cause.ex#L1" class="view-source" rel="help" title="View Source">

       <span class="icon-code" aria-hidden="true"></span>

       <span class="sr-only">View Source</span>

     </a>

    

    

    

      <div class="specs">

        

          <pre>t() :: term</pre>

        

      </div>

    

  </div>

  <section class="docstring">

    

  </section>

</div>



          </div>

        </section>

      



      

        <section id="functions" class="details-list">

          <h1 class="section-heading">

            <a class="hover-link" href="#functions">

              <span class="icon-link" aria-hidden="true"></span>

              <span class="sr-only">Link to this section</span>

            </a>

            Functions

          </h1>

          <div class="detail" id="cause/1">

  

  

  <div class="detail-header">

    <a href="#cause/1" class="detail-link" title="Link to this function">

      <span class="icon-link" aria-hidden="true"></span>

      <span class="sr-only">Link to this function</span>

    </a>

    <span class="signature">cause(error)</span>

    

      <a href="https://github.com/nucleartide/errors/blob/master/errors/cause.ex#L9" class="view-source" rel="help" title="View Source">

       <span class="icon-code" aria-hidden="true"></span>

       <span class="sr-only">View Source</span>

     </a>

    

    

    

      <div class="specs">

        

          <pre>cause(error :: <a href="Errors.Cause.html#t:t/0">Errors.Cause.t</a>) :: <a href="https://hexdocs.pm/elixir/Exception.html#t:t/0">Exception.t</a></pre>

        

      </div>

    

  </div>

  <section class="docstring">

    <p>Return the underlying cause of an Exception.</p>

<p>See this link for info about Dialyzer warnings:

https://elixirforum.com/t/dialyzer-listed-not-implemented-protocols-as-unknown-functions/2099/9</p>



  </section>

</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>