diff options
| author | 2017-02-01 11:18:05 +0000 | |
|---|---|---|
| committer | 2017-02-01 11:18:05 +0000 | |
| commit | b1ac8db3f8c3d8f393701a2f644a85cb44e7c24d (patch) | |
| tree | 5ebcaba65a09d2047bc0126fe68dd633b345158c /plist/enum.Error.html | |
| download | rust-plist-gh-pages.tar.bz2 | |
Documentation for ebarnard/rust-plist@bf6b567gh-pages
Diffstat (limited to 'plist/enum.Error.html')
| -rw-r--r-- | plist/enum.Error.html | 168 |
1 files changed, 168 insertions, 0 deletions
diff --git a/plist/enum.Error.html b/plist/enum.Error.html new file mode 100644 index 0000000..ca7ab87 --- /dev/null +++ b/plist/enum.Error.html @@ -0,0 +1,168 @@ +<!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 `Error` enum in crate `plist`."> + <meta name="keywords" content="rust, rustlang, rust-lang, Error"> + + <title>plist::Error - 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'>plist</a></p><script>window.sidebarCurrent = {name: 'Error', ty: 'enum', 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 enum"> +<h1 class='fqn'><span class='in-band'>Enum <a href='index.html'>plist</a>::<wbr><a class='enum' href=''>Error</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'>−</span>] + </a> + </span><a id='src-1214' class='srclink' href='../src/plist/src/lib.rs.html#409-414' title='goto source code'>[src]</a></span></h1> +<pre class='rust enum'>pub enum Error { + InvalidData, + UnexpectedEof, + Io(<a class='struct' href='https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html' title='std::io::error::Error'>IoError</a>), + Serde(<a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>), +}</pre><h2 class='variants'>Variants</h2> +<span id='variant.InvalidData' class='variant'><span id='InvalidData.v' class='invisible'><code>InvalidData</code></span></span><span id='variant.UnexpectedEof' class='variant'><span id='UnexpectedEof.v' class='invisible'><code>UnexpectedEof</code></span></span><span id='variant.Io' class='variant'><span id='Io.v' class='invisible'><code>Io(<a class='struct' href='https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html' title='std::io::error::Error'>IoError</a>)</code></span></span><span id='variant.Serde' class='variant'><span id='Serde.v' class='invisible'><code>Serde(<a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>)</code></span></span><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html' title='core::convert::From'>From</a><<a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.FromUtf8Error.html' title='collections::string::FromUtf8Error'>FromUtf8Error</a>> for <a class='enum' href='../plist/enum.Error.html' title='plist::Error'>Error</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-16' class='srclink' href='../src/plist/src/binary/reader.rs.html#8-12' title='goto source code'>[src]</a></span></h3> +<div class='impl-items'><h4 id='method.from' class='method'><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(_: <a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.FromUtf8Error.html' title='collections::string::FromUtf8Error'>FromUtf8Error</a>) -> <a class='enum' href='../plist/enum.Error.html' title='plist::Error'>Error</a></code></span></h4> +<div class='docblock'><p>Performs the conversion.</p> +</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html' title='core::convert::From'>From</a><<a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.FromUtf16Error.html' title='collections::string::FromUtf16Error'>FromUtf16Error</a>> for <a class='enum' href='../plist/enum.Error.html' title='plist::Error'>Error</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-18' class='srclink' href='../src/plist/src/binary/reader.rs.html#14-18' title='goto source code'>[src]</a></span></h3> +<div class='impl-items'><h4 id='method.from-1' class='method'><span id='from.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(_: <a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.FromUtf16Error.html' title='collections::string::FromUtf16Error'>FromUtf16Error</a>) -> <a class='enum' href='../plist/enum.Error.html' title='plist::Error'>Error</a></code></span></h4> +<div class='docblock'><p>Performs the conversion.</p> +</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html' title='core::convert::From'>From</a><<a class='struct' href='https://lifthrasiir.github.io/rust-chrono/chrono/format/struct.ParseError.html' title='chrono::format::ParseError'>ChronoParseError</a>> for <a class='enum' href='../plist/enum.Error.html' title='plist::Error'>Error</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-132' class='srclink' href='../src/plist/src/xml/reader.rs.html#10-14' title='goto source code'>[src]</a></span></h3> +<div class='impl-items'><h4 id='method.from-2' class='method'><span id='from.v-2' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(_: <a class='struct' href='https://lifthrasiir.github.io/rust-chrono/chrono/format/struct.ParseError.html' title='chrono::format::ParseError'>ChronoParseError</a>) -> <a class='enum' href='../plist/enum.Error.html' title='plist::Error'>Error</a></code></span></h4> +<div class='docblock'><p>Performs the conversion.</p> +</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html' title='core::convert::From'>From</a><XmlWriterError> for <a class='enum' href='../plist/enum.Error.html' title='plist::Error'>Error</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-197' class='srclink' href='../src/plist/src/xml/writer.rs.html#12-19' title='goto source code'>[src]</a></span></h3> +<div class='impl-items'><h4 id='method.from-3' class='method'><span id='from.v-3' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(err: XmlWriterError) -> <a class='enum' href='../plist/enum.Error.html' title='plist::Error'>Error</a></code></span></h4> +<div class='docblock'><p>Performs the conversion.</p> +</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://serde-rs.github.io/serde/serde/serde/de/trait.Error.html' title='serde::de::Error'>SerdeError</a> for <a class='enum' href='../plist/enum.Error.html' title='plist::Error'>Error</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-304' class='srclink' href='../src/plist/src/de.rs.html#41-49' title='goto source code'>[src]</a></span></h3> +<div class='impl-items'><h4 id='method.custom' class='method'><span id='custom.v' class='invisible'><code>fn <a href='https://serde-rs.github.io/serde/serde/serde/de/trait.Error.html#tymethod.custom' class='fnname'>custom</a><T: <a class='trait' href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html' title='core::convert::Into'>Into</a><<a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>>>(msg: T) -> Self</code></span></h4> +<div class='docblock'><p>Raised when there is general error when deserializing a type.</p> +</div><h4 id='method.end_of_stream' class='method'><span id='end_of_stream.v' class='invisible'><code>fn <a href='https://serde-rs.github.io/serde/serde/serde/de/trait.Error.html#tymethod.end_of_stream' class='fnname'>end_of_stream</a>() -> Self</code></span></h4> +<div class='docblock'><p>Raised when a <code>Deserialize</code> type unexpectedly hit the end of the stream.</p> +</div><h4 id='method.invalid_type' class='method'><span id='invalid_type.v' class='invisible'><code>fn <a href='https://serde-rs.github.io/serde/serde/serde/de/trait.Error.html#method.invalid_type' class='fnname'>invalid_type</a>(ty: <a class='enum' href='https://serde-rs.github.io/serde/serde/serde/de/enum.Type.html' title='serde::de::Type'>Type</a>) -> Self</code></span></h4> +<div class='docblock'><p>Raised when a <code>Deserialize</code> was passed an incorrect type.</p> +</div><h4 id='method.invalid_value' class='method'><span id='invalid_value.v' class='invisible'><code>fn <a href='https://serde-rs.github.io/serde/serde/serde/de/trait.Error.html#method.invalid_value' class='fnname'>invalid_value</a>(msg: &<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -> Self</code></span></h4> +<div class='docblock'><p>Raised when a <code>Deserialize</code> was passed an incorrect value.</p> +</div><h4 id='method.invalid_length' class='method'><span id='invalid_length.v' class='invisible'><code>fn <a href='https://serde-rs.github.io/serde/serde/serde/de/trait.Error.html#method.invalid_length' class='fnname'>invalid_length</a>(len: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.usize.html'>usize</a>) -> Self</code></span></h4> +<div class='docblock'><p>Raised when a fixed sized sequence or map was passed in the wrong amount of arguments. <a href="https://serde-rs.github.io/serde/serde/serde/de/trait.Error.html#method.invalid_length">Read more</a></p> +</div><h4 id='method.unknown_variant' class='method'><span id='unknown_variant.v' class='invisible'><code>fn <a href='https://serde-rs.github.io/serde/serde/serde/de/trait.Error.html#method.unknown_variant' class='fnname'>unknown_variant</a>(field: &<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -> Self</code></span></h4> +<div class='docblock'><p>Raised when a <code>Deserialize</code> enum type received an unexpected variant.</p> +</div><h4 id='method.unknown_field' class='method'><span id='unknown_field.v' class='invisible'><code>fn <a href='https://serde-rs.github.io/serde/serde/serde/de/trait.Error.html#method.unknown_field' class='fnname'>unknown_field</a>(field: &<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -> Self</code></span></h4> +<div class='docblock'><p>Raised when a <code>Deserialize</code> struct type received an unexpected struct field.</p> +</div><h4 id='method.missing_field' class='method'><span id='missing_field.v' class='invisible'><code>fn <a href='https://serde-rs.github.io/serde/serde/serde/de/trait.Error.html#method.missing_field' class='fnname'>missing_field</a>(field: &'static <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -> Self</code></span></h4> +<div class='docblock'><p>raised when a <code>deserialize</code> struct type did not receive a field.</p> +</div><h4 id='method.duplicate_field' class='method'><span id='duplicate_field.v' class='invisible'><code>fn <a href='https://serde-rs.github.io/serde/serde/serde/de/trait.Error.html#method.duplicate_field' class='fnname'>duplicate_field</a>(field: &'static <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -> Self</code></span></h4> +<div class='docblock'><p>Raised when a <code>Deserialize</code> struct type received more than one of the same struct field. <a href="https://serde-rs.github.io/serde/serde/serde/de/trait.Error.html#method.duplicate_field">Read more</a></p> +</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://serde-rs.github.io/serde/serde/serde/ser/trait.Error.html' title='serde::ser::Error'>SerdeError</a> for <a class='enum' href='../plist/enum.Error.html' title='plist::Error'>Error</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-428' class='srclink' href='../src/plist/src/ser.rs.html#8-16' title='goto source code'>[src]</a></span></h3> +<div class='impl-items'><h4 id='method.custom-1' class='method'><span id='custom.v-1' class='invisible'><code>fn <a href='https://serde-rs.github.io/serde/serde/serde/ser/trait.Error.html#tymethod.custom' class='fnname'>custom</a><T: <a class='trait' href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html' title='core::convert::Into'>Into</a><<a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>>>(msg: T) -> Self</code></span></h4> +<div class='docblock'><p>Raised when there is general error when deserializing a type.</p> +</div><h4 id='method.invalid_value-1' class='method'><span id='invalid_value.v-1' class='invisible'><code>fn <a href='https://serde-rs.github.io/serde/serde/serde/ser/trait.Error.html#method.invalid_value' class='fnname'>invalid_value</a>(_: &<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -> Self</code></span></h4> +<div class='docblock'><p>Raised when a <code>Serialize</code> was passed an incorrect value.</p> +</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html' title='core::fmt::Debug'>Debug</a> for <a class='enum' href='../plist/enum.Error.html' title='plist::Error'>Error</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-1221' class='srclink' href='../src/plist/src/lib.rs.html#408' title='goto source code'>[src]</a></span></h3> +<div class='impl-items'><h4 id='method.fmt' class='method'><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title='core::fmt::Formatter'>Formatter</a>) -> <a class='type' href='https://doc.rust-lang.org/nightly/core/fmt/type.Result.html' title='core::fmt::Result'>Result</a></code></span></h4> +<div class='docblock'><p>Formats the value using the given formatter.</p> +</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/std/error/trait.Error.html' title='std::error::Error'>Error</a> for <a class='enum' href='../plist/enum.Error.html' title='plist::Error'>Error</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-742' class='srclink' href='../src/plist/src/lib.rs.html#416-432' title='goto source code'>[src]</a></span></h3> +<div class='impl-items'><h4 id='method.description' class='method'><span id='description.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/std/error/trait.Error.html#tymethod.description' class='fnname'>description</a>(&self) -> &<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a></code></span></h4> +<div class='docblock'><p>A short description of the error. <a href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html#tymethod.description">Read more</a></p> +</div><h4 id='method.cause' class='method'><span id='cause.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.cause' class='fnname'>cause</a>(&self) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a><&<a class='trait' href='https://doc.rust-lang.org/nightly/std/error/trait.Error.html' title='std::error::Error'>Error</a>></code></span></h4> +<div class='docblock'><p>The lower-level cause of this error, if any. <a href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.cause">Read more</a></p> +</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html' title='core::fmt::Display'>Display</a> for <a class='enum' href='../plist/enum.Error.html' title='plist::Error'>Error</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-750' class='srclink' href='../src/plist/src/lib.rs.html#434-441' title='goto source code'>[src]</a></span></h3> +<div class='impl-items'><h4 id='method.fmt-1' class='method'><span id='fmt.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, fmt: &mut <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title='core::fmt::Formatter'>Formatter</a>) -> <a class='type' href='https://doc.rust-lang.org/nightly/core/fmt/type.Result.html' title='core::fmt::Result'>Result</a></code></span></h4> +<div class='docblock'><p>Formats the value using the given formatter.</p> +</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html' title='core::convert::From'>From</a><<a class='struct' href='https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html' title='std::io::error::Error'>IoError</a>> for <a class='enum' href='../plist/enum.Error.html' title='plist::Error'>Error</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-755' class='srclink' href='../src/plist/src/lib.rs.html#443-447' title='goto source code'>[src]</a></span></h3> +<div class='impl-items'><h4 id='method.from-4' class='method'><span id='from.v-4' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(err: <a class='struct' href='https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html' title='std::io::error::Error'>IoError</a>) -> <a class='enum' href='../plist/enum.Error.html' title='plist::Error'>Error</a></code></span></h4> +<div class='docblock'><p>Performs the conversion.</p> +</div></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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</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 |