writefreely-swift/docs/WFError/index.html

238 lines
10 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>WriteFreely - WFError</title>
<link rel="stylesheet" type="text/css" href="/all.css" media="all" />
</head>
<body>
<header>
<a href="/">
<strong>
WriteFreely
</strong>
<span>Documentation</span>
</a>
<sup>Beta</sup>
</header>
<!--
<form class="search">
<input type="search" placeholder="Search" />
</form>
-->
<nav>
<div class="wrapper">
<h2>On This Page</h2>
<ol><li><a href="#relationships">Relationships</a><ul><li><a href="#relationships">Conforms To</a></li></ul></li><li><a href="#enumeration cases">Enumeration Cases</a><ul><li class="case"><a href="#wferror.badrequest">badRequest</a></li><li class="case"><a href="#wferror.unauthorized">unauthorized</a></li><li class="case"><a href="#wferror.forbidden">forbidden</a></li><li class="case"><a href="#wferror.notfound">notFound</a></li><li class="case"><a href="#wferror.methodnotallowed">methodNotAllowed</a></li><li class="case"><a href="#wferror.gone">gone</a></li><li class="case"><a href="#wferror.preconditionfailed">preconditionFailed</a></li><li class="case"><a href="#wferror.toomanyrequests">tooManyRequests</a></li><li class="case"><a href="#wferror.internalservererror">internalServerError</a></li><li class="case"><a href="#wferror.badgateway">badGateway</a></li><li class="case"><a href="#wferror.serviceunavailable">serviceUnavailable</a></li><li class="case"><a href="#wferror.unknownerror">unknownError</a></li><li class="case"><a href="#wferror.couldnotcomplete">couldNotComplete</a></li><li class="case"><a href="#wferror.invalidresponse">invalidResponse</a></li><li class="case"><a href="#wferror.invaliddata">invalidData</a></li></ul></li></ol>
</div>
</nav>
<main>
<article>
<h1>
<small>Enumeration</small>
<code class="name">WFError</code>
</h1>
<div class="declaration">
<pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">enum</span> <span class="type">WFError</span>: <span class="type">Int</span>, <span class="type">Error</span> </code></pre>
</div>
<section id="relationships">
<h2 hidden>Relationships</h2>
<figure>
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 2.47.1 (20210417.1919)
-->
<!-- Pages: 1 -->
<svg width="872pt" height="116pt"
viewBox="0.00 0.00 872.00 116.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 112)">
<polygon fill="white" stroke="transparent" points="-4,4 -4,-112 868,-112 868,4 -4,4"/>
<!-- WFError -->
<g id="node1" class="node enumeration current">
<title>WFError</title>
<g id="a_node1"><a xlink:href="/WFError" xlink:title="WFError">
<path fill="none" stroke="black" stroke-width="3" d="M528,-108C528,-108 336,-108 336,-108 330,-108 324,-102 324,-96 324,-96 324,-84 324,-84 324,-78 330,-72 336,-72 336,-72 528,-72 528,-72 534,-72 540,-78 540,-84 540,-84 540,-96 540,-96 540,-102 534,-108 528,-108"/>
<text text-anchor="middle" x="432" y="-86.3" font-family="Menlo" font-size="14.00">WFError</text>
</a>
</g>
</g>
<!-- Error -->
<g id="node2" class="node unknown">
<title>Error</title>
<path fill="none" stroke="black" d="M303,-36C303,-36 111,-36 111,-36 105,-36 99,-30 99,-24 99,-24 99,-12 99,-12 99,-6 105,0 111,0 111,0 303,0 303,0 309,0 315,-6 315,-12 315,-12 315,-24 315,-24 315,-30 309,-36 303,-36"/>
<text text-anchor="middle" x="207" y="-14.3" font-family="Menlo" font-size="14.00">Error</text>
</g>
<!-- WFError&#45;&gt;Error -->
<g id="edge1" class="edge conformsTo">
<title>WFError&#45;&gt;Error</title>
<path fill="none" stroke="black" d="M377.25,-71.97C345.4,-62.06 305.08,-49.51 271.67,-39.12"/>
<polygon fill="black" stroke="black" points="272.59,-35.74 262,-36.11 270.51,-42.42 272.59,-35.74"/>
</g>
<!-- Int -->
<g id="node3" class="node unknown">
<title>Int</title>
<path fill="none" stroke="black" d="M753,-36C753,-36 561,-36 561,-36 555,-36 549,-30 549,-24 549,-24 549,-12 549,-12 549,-6 555,0 561,0 561,0 753,0 753,0 759,0 765,-6 765,-12 765,-12 765,-24 765,-24 765,-30 759,-36 753,-36"/>
<text text-anchor="middle" x="657" y="-14.3" font-family="Menlo" font-size="14.00">Int</text>
</g>
<!-- WFError&#45;&gt;Int -->
<g id="edge2" class="edge conformsTo">
<title>WFError&#45;&gt;Int</title>
<path fill="none" stroke="black" d="M486.75,-71.97C518.6,-62.06 558.92,-49.51 592.33,-39.12"/>
<polygon fill="black" stroke="black" points="593.49,-42.42 602,-36.11 591.41,-35.74 593.49,-42.42"/>
</g>
</g>
</svg>
<figcaption hidden>Inheritance graph for WFError.</figcaption>
</figure>
<h3>Conforms To</h3>
<dl>
<dt class="unknown"><code>Error</code></dt>
<dt class="unknown"><code>Int</code></dt>
</dl>
</section>
<section id="enumeration cases">
<h2>Enumeration Cases</h2>
<div role="article" class="case" id="wferror.badrequest">
<h3>
<code>badRequest</code>
</h3>
<div class="declaration">
<pre class="highlight"><code><span class="keyword">case</span> <span class="variable">badRequest</span> = <span class="number literal">400</span></code></pre>
</div>
</div>
<div role="article" class="case" id="wferror.unauthorized">
<h3>
<code>unauthorized</code>
</h3>
<div class="declaration">
<pre class="highlight"><code><span class="keyword">case</span> <span class="variable">unauthorized</span> = <span class="number literal">401</span></code></pre>
</div>
</div>
<div role="article" class="case" id="wferror.forbidden">
<h3>
<code>forbidden</code>
</h3>
<div class="declaration">
<pre class="highlight"><code><span class="keyword">case</span> <span class="variable">forbidden</span> = <span class="number literal">403</span></code></pre>
</div>
</div>
<div role="article" class="case" id="wferror.notfound">
<h3>
<code>notFound</code>
</h3>
<div class="declaration">
<pre class="highlight"><code><span class="keyword">case</span> <span class="variable">notFound</span> = <span class="number literal">404</span></code></pre>
</div>
</div>
<div role="article" class="case" id="wferror.methodnotallowed">
<h3>
<code>methodNotAllowed</code>
</h3>
<div class="declaration">
<pre class="highlight"><code><span class="keyword">case</span> <span class="variable">methodNotAllowed</span> = <span class="number literal">405</span></code></pre>
</div>
</div>
<div role="article" class="case" id="wferror.gone">
<h3>
<code>gone</code>
</h3>
<div class="declaration">
<pre class="highlight"><code><span class="keyword">case</span> <span class="variable">gone</span> = <span class="number literal">410</span></code></pre>
</div>
</div>
<div role="article" class="case" id="wferror.preconditionfailed">
<h3>
<code>preconditionFailed</code>
</h3>
<div class="declaration">
<pre class="highlight"><code><span class="keyword">case</span> <span class="variable">preconditionFailed</span> = <span class="number literal">412</span></code></pre>
</div>
</div>
<div role="article" class="case" id="wferror.toomanyrequests">
<h3>
<code>tooManyRequests</code>
</h3>
<div class="declaration">
<pre class="highlight"><code><span class="keyword">case</span> <span class="variable">tooManyRequests</span> = <span class="number literal">429</span></code></pre>
</div>
</div>
<div role="article" class="case" id="wferror.internalservererror">
<h3>
<code>internalServerError</code>
</h3>
<div class="declaration">
<pre class="highlight"><code><span class="keyword">case</span> <span class="variable">internalServerError</span> = <span class="number literal">500</span></code></pre>
</div>
</div>
<div role="article" class="case" id="wferror.badgateway">
<h3>
<code>badGateway</code>
</h3>
<div class="declaration">
<pre class="highlight"><code><span class="keyword">case</span> <span class="variable">badGateway</span> = <span class="number literal">502</span></code></pre>
</div>
</div>
<div role="article" class="case" id="wferror.serviceunavailable">
<h3>
<code>serviceUnavailable</code>
</h3>
<div class="declaration">
<pre class="highlight"><code><span class="keyword">case</span> <span class="variable">serviceUnavailable</span> = <span class="number literal">503</span></code></pre>
</div>
</div>
<div role="article" class="case" id="wferror.unknownerror">
<h3>
<code>unknownError</code>
</h3>
<div class="declaration">
<pre class="highlight"><code><span class="keyword">case</span> <span class="variable">unknownError</span> = -<span class="number literal">1</span></code></pre>
</div>
</div>
<div role="article" class="case" id="wferror.couldnotcomplete">
<h3>
<code>couldNotComplete</code>
</h3>
<div class="declaration">
<pre class="highlight"><code><span class="keyword">case</span> <span class="variable">couldNotComplete</span> = -<span class="number literal">2</span></code></pre>
</div>
</div>
<div role="article" class="case" id="wferror.invalidresponse">
<h3>
<code>invalidResponse</code>
</h3>
<div class="declaration">
<pre class="highlight"><code><span class="keyword">case</span> <span class="variable">invalidResponse</span> = -<span class="number literal">3</span></code></pre>
</div>
</div>
<div role="article" class="case" id="wferror.invaliddata">
<h3>
<code>invalidData</code>
</h3>
<div class="declaration">
<pre class="highlight"><code><span class="keyword">case</span> <span class="variable">invalidData</span> = -<span class="number literal">4</span></code></pre>
</div>
</div>
</section>
</article>
</main>
<footer>
<p>
Generated on <time datetime="2021-05-27T16:32:52-0400">May 27, 2021</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a> <span class="version">1.0.0-beta.6</span>.
</p>
</footer>
</body>
</html>