aboutsummaryrefslogtreecommitdiffstats
path: root/plist/index.html
diff options
context:
space:
mode:
author2017-02-01 11:18:05 +0000
committer2017-02-01 11:18:05 +0000
commitb1ac8db3f8c3d8f393701a2f644a85cb44e7c24d (patch)
tree5ebcaba65a09d2047bc0126fe68dd633b345158c /plist/index.html
downloadrust-plist-gh-pages.tar.bz2
Documentation for ebarnard/rust-plist@bf6b567gh-pages
Diffstat (limited to 'plist/index.html')
-rw-r--r--plist/index.html231
1 files changed, 231 insertions, 0 deletions
diff --git a/plist/index.html b/plist/index.html
new file mode 100644
index 0000000..adedcb5
--- /dev/null
+++ b/plist/index.html
@@ -0,0 +1,231 @@
+<!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 `plist` crate.">
+ <meta name="keywords" content="rust, rustlang, rust-lang, plist">
+
+ <title>plist - 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'></p><script>window.sidebarCurrent = {name: 'plist', ty: 'mod', relpath: '../'};</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'>Crate <a class='mod' href=''>plist</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-0' class='srclink' href='../src/plist/src/lib.rs.html#1-554' title='goto source code'>[src]</a></span></h1>
+<div class='docblock'>
+<h1 id='plist' class='section-header'><a href='#plist'>Plist</a></h1>
+<p>A rusty plist parser.</p>
+
+<h2 id='usage' class='section-header'><a href='#usage'>Usage</a></h2>
+<p>Put this in your <code>Cargo.toml</code>:</p>
+
+<pre><code class="language-toml">[dependencies]
+plist = &quot;0.0.12&quot;
+</code></pre>
+
+<p>And put this in your crate root:</p>
+
+<pre class='rust rust-example-rendered'>
+<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>plist</span>;</pre>
+
+<h2 id='examples' class='section-header'><a href='#examples'>Examples</a></h2>
+<pre class='rust rust-example-rendered'>
+<span class='kw'>use</span> <span class='ident'>plist</span>::<span class='ident'>Plist</span>;
+<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>fs</span>::<span class='ident'>File</span>;
+
+<span class='kw'>let</span> <span class='ident'>file</span> <span class='op'>=</span> <span class='ident'>File</span>::<span class='ident'>open</span>(<span class='string'>&quot;tests/data/xml.plist&quot;</span>).<span class='ident'>unwrap</span>();
+<span class='kw'>let</span> <span class='ident'>plist</span> <span class='op'>=</span> <span class='ident'>Plist</span>::<span class='ident'>read</span>(<span class='ident'>file</span>).<span class='ident'>unwrap</span>();
+
+<span class='kw'>match</span> <span class='ident'>plist</span> {
+ <span class='ident'>Plist</span>::<span class='ident'>Array</span>(<span class='ident'>_array</span>) <span class='op'>=&gt;</span> (),
+ _ <span class='op'>=&gt;</span> ()
+}
+</pre>
+</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
+<table>
+ <tr class=' module-item'>
+ <td><a class='mod' href='binary/index.html'
+ title='plist::binary'>binary</a></td>
+ <td class='docblock-short'>
+
+ </td>
+ </tr>
+ <tr class=' module-item'>
+ <td><a class='mod' href='xml/index.html'
+ title='plist::xml'>xml</a></td>
+ <td class='docblock-short'>
+
+ </td>
+ </tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
+<table>
+ <tr class=' module-item'>
+ <td><a class='struct' href='struct.Deserializer.html'
+ title='plist::Deserializer'>Deserializer</a></td>
+ <td class='docblock-short'>
+
+ </td>
+ </tr>
+ <tr class=' module-item'>
+ <td><a class='struct' href='struct.EventReader.html'
+ title='plist::EventReader'>EventReader</a></td>
+ <td class='docblock-short'>
+
+ </td>
+ </tr>
+ <tr class=' module-item'>
+ <td><a class='struct' href='struct.Serializer.html'
+ title='plist::Serializer'>Serializer</a></td>
+ <td class='docblock-short'>
+
+ </td>
+ </tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
+<table>
+ <tr class=' module-item'>
+ <td><a class='enum' href='enum.Error.html'
+ title='plist::Error'>Error</a></td>
+ <td class='docblock-short'>
+
+ </td>
+ </tr>
+ <tr class=' module-item'>
+ <td><a class='enum' href='enum.Plist.html'
+ title='plist::Plist'>Plist</a></td>
+ <td class='docblock-short'>
+
+ </td>
+ </tr>
+ <tr class=' module-item'>
+ <td><a class='enum' href='enum.PlistEvent.html'
+ title='plist::PlistEvent'>PlistEvent</a></td>
+ <td class='docblock-short'>
+ <p>An encoding of a plist as a flat structure.</p>
+ </td>
+ </tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
+<table>
+ <tr class=' module-item'>
+ <td><a class='trait' href='trait.EventWriter.html'
+ title='plist::EventWriter'>EventWriter</a></td>
+ <td class='docblock-short'>
+
+ </td>
+ </tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
+<table>
+ <tr class=' module-item'>
+ <td><a class='fn' href='fn.deserialize.html'
+ title='plist::deserialize'>deserialize</a></td>
+ <td class='docblock-short'>
+
+ </td>
+ </tr>
+ <tr class=' module-item'>
+ <td><a class='fn' href='fn.serialize_to_xml.html'
+ title='plist::serialize_to_xml'>serialize_to_xml</a></td>
+ <td class='docblock-short'>
+
+ </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.Result.html'
+ title='plist::Result'>Result</a></td>
+ <td class='docblock-short'>
+
+ </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 = "plist";
+ </script>
+ <script src="../jquery.js"></script>
+ <script src="../main.js"></script>
+ <script defer src="../search-index.js"></script>
+</body>
+</html> \ No newline at end of file
generated by cgit v1.2.3 (git 2.25.1) at 2025-10-31 12:31:22 +0000