docs/plug/Plug.Exception.html at gh-pages · ericmj/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
<!DOCTYPE html>
<html>
  <head>
    <title>Plug.Exception</title>
    <meta charset="utf-8">
    <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />

    <script type="text/javascript" charset="utf-8">
      relpath = '';
      if (relpath != '') relpath += '/';
    </script>

    <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
    <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
  </head>

  <body>
    <script type="text/javascript" charset="utf-8">
      if (window.top.frames.main) document.body.className = 'frames';
    </script>

    <div id="content">
      <div class="breadcrumbs">plug v0.5.1 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="Plug.html">Plug</a> &rarr; <a href="Plug.Exception.html">Exception</a></div>

      <h1>
        Plug.Exception

          <small>protocol</small>

      </h1>

      <ul class="summary_links">

          <li><a href="#summary">Summary</a></li>


          <li><a href="#functions_details">Functions</a></li>


          <li><a href="#types_details">Types</a></li>

      </ul>


        <div id="moduledoc" class="docstring">
          <p>A protocol that extends exceptions to be status code aware.</p>

        </div>


        <h2 id="summary">Summary<div class="detail_header_links"><a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></div></h2>
        <table class="summary">
          <tr>
  <td class="summary_signature"><a href="#status/1">status(exception)</a></td>

    <td class="summary_synopsis"><p>Receives an exception and returns its status code</p>
</td>

</tr>

        </table>


        <div id="types_details" class="details_list">
          <h2>Types <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></h2>
          <div class="type_detail">
  <p class="typespec" id="t:t/0">
    <a href="#t:t/0">t</a> :: term
  </p>

</div>

        </div>


        <div id="functions_details" class="details_list">
          <h2>Functions</h2>
          <div class="detail">
  <div class="detail_header" id="status/1">
    <span class="signature"><strong>status(exception)</strong></span>
    <div class="detail_header_links">
      <span class="detail_type">(function)</span>
      <a href="#status/1" class="detail_link" title="Link to this function">#</a>
      <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
    </div>
  </div>

    <p>Specs:</p>
    <ul class="spec">

        <li>status(<a href="#t:t/0">t</a>) :: <a href="Plug.Conn.html#t:status/0">Plug.Conn.status</a></li>

    </ul>

  <div class="docstring"><p>Receives an exception and returns its status code.</p>
</div>

</div>

        </div>


    </div>
  </body>
</html>