mentat/serde_cbor/error/enum.Category.html

139 lines
6.3 KiB
HTML
Raw Normal View History

2018-08-22 17:04:13 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="API documentation for the Rust `Category` enum in crate `serde_cbor`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Category">
<title>serde_cbor::error::Category - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../dark.css">
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
<script src="../../storage.js"></script>
</head>
<body class="rustdoc enum">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">&#9776;</div>
<p class='location'>Enum Category</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Io">Io</a><a href="#variant.Syntax">Syntax</a><a href="#variant.Data">Data</a><a href="#variant.Eof">Eof</a></div></div><p class='location'><a href='../index.html'>serde_cbor</a>::<wbr><a href='index.html'>error</a></p><script>window.sidebarCurrent = {name: 'Category', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Enum <a href='../index.html'>serde_cbor</a>::<wbr><a href='index.html'>error</a>::<wbr><a class="enum" href=''>Category</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/serde_cbor/error.rs.html#17-26' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum Category {
Io,
Syntax,
Data,
Eof,
}</pre><div class='docblock'><p>Categorizes the cause of a <code>serde_cbor::Error</code>.</p>
</div><h2 id='variants' class='variants small-section-header'>
Variants<a href='#variants' class='anchor'></a></h2>
<span id="variant.Io" class="variant small-section-header"><a href="#variant.Io" class="anchor field"></a><span id='Io.v' class='invisible'><code>Io</code></span></span><div class='docblock'><p>The error was caused by a failure to read or write bytes on an IO stream.</p>
</div><span id="variant.Syntax" class="variant small-section-header"><a href="#variant.Syntax" class="anchor field"></a><span id='Syntax.v' class='invisible'><code>Syntax</code></span></span><div class='docblock'><p>The error was caused by input that was not syntactically valid CBOR.</p>
</div><span id="variant.Data" class="variant small-section-header"><a href="#variant.Data" class="anchor field"></a><span id='Data.v' class='invisible'><code>Data</code></span></span><div class='docblock'><p>The error was caused by input data that was semantically correct.</p>
</div><span id="variant.Eof" class="variant small-section-header"><a href="#variant.Eof" class="anchor field"></a><span id='Eof.v' class='invisible'><code>Eof</code></span></span><div class='docblock'><p>The error was causeed by prematurely reaching the end of the input data.</p>
</div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd></kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd></kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd></kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "serde_cbor";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>