qrcode-rust/qrcode/types/index.html

154 lines
6.3 KiB
HTML
Raw Permalink Normal View History

<!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 `types` mod in crate `qrcode`.">
<meta name="keywords" content="rust, rustlang, rust-lang, types">
<title>qrcode::types - Rust</title>
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'><a href='../index.html'>qrcode</a></p><script>window.sidebarCurrent = {name: 'types', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
</nav>
<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 mod">
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>qrcode</a>::<wbr><a class='mod' href=''>types</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 id='src-7' class='srclink' href='../../src/qrcode/src/types.rs.html#1-278' title='goto source code'>[src]</a></span></h1>
<h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class='enum' href='enum.EcLevel.html'
title='qrcode::types::EcLevel'>EcLevel</a></td>
<td class='docblock short'>
<p>The error correction level. It allows the original information be recovered
even if parts of the code is damaged.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='enum' href='enum.Mode.html'
title='qrcode::types::Mode'>Mode</a></td>
<td class='docblock short'>
<p>The mode indicator, which specifies the character set of the encoded data.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='enum' href='enum.QrError.html'
title='qrcode::types::QrError'>QrError</a></td>
<td class='docblock short'>
<p><code>QrError</code> encodes the error encountered when generating a QR code.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='enum' href='enum.Version.html'
title='qrcode::types::Version'>Version</a></td>
<td class='docblock short'>
<p>In QR code terminology, <code>Version</code> means the size of the generated image.
Larger version means the size of code is larger, and therefore can carry
more information.</p>
</td>
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table>
<tr class=' module-item'>
<td><a class='type' href='type.QrResult.html'
title='qrcode::types::QrResult'>QrResult</a></td>
<td class='docblock short'>
<p><code>QrResult</code> is a convenient alias for a QR code generation result.</p>
</td>
</tr></table></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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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 = "qrcode";
window.playgroundUrl = "";
</script>
<script src="../../jquery.js"></script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>