<!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 `UtilError` enum in crate `ocl_core`.">
<meta name="keywords" content="rust, rustlang, rust-lang, UtilError">
<title>ocl_core::util::UtilError - 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">☰</div>
<p class='location'>Enum UtilError</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.BytesTo">BytesTo</a><a href="#variant.BytesInto">BytesInto</a><a href="#variant.BytesIntoVec">BytesIntoVec</a><a href="#variant.BytesToVec">BytesToVec</a><a href="#variant.BytesIntoString">BytesIntoString</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-From%3CUtilError%3E">From<UtilError></a><a href="#impl-Debug">Debug</a><a href="#impl-Fail">Fail</a><a href="#impl-Display">Display</a></div></div><p class='location'><a href='../index.html'>ocl_core</a>::<wbr><a href='index.html'>util</a></p><script>window.sidebarCurrent = {name: 'UtilError', 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'>ocl_core</a>::<wbr><a href='index.html'>util</a>::<wbr><a class="enum" href=''>UtilError</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 class='srclink' href='../../src/ocl_core/util.rs.html#73-88' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum UtilError {
BytesTo {
src: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,
dst: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,
},
BytesInto {
src: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,
dst: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,
},
BytesIntoVec {
src: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,
dst: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,
},
BytesToVec {
src: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,
dst: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,
},
BytesIntoString(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.FromUtf8Error.html" title="struct alloc::string::FromUtf8Error">FromUtf8Error</a>),
}</pre><div class='docblock'><p>An error caused by a utility function.</p>
</div><h2 id='variants' class='variants small-section-header'>
Variants<a href='#variants' class='anchor'></a></h2>
<span id="variant.BytesTo" class="variant small-section-header"><a href="#variant.BytesTo" class="anchor field"></a><span id='BytesTo.v' class='invisible'><code>BytesTo</code></span></span><span class='docblock autohide sub-variant' id='variant.BytesTo.fields'><h3 class='fields'>Fields of <code>BytesTo</code></h3>
<table><tr><td id='variant.BytesTo.field.src'><span id='BytesTo.v.src.v' class='invisible'><code>src: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td></td></tr><tr><td id='variant.BytesTo.field.dst'><span id='BytesTo.v.dst.v' class='invisible'><code>dst: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td></td></tr></table></span><span id="variant.BytesInto" class="variant small-section-header"><a href="#variant.BytesInto" class="anchor field"></a><span id='BytesInto.v' class='invisible'><code>BytesInto</code></span></span><span class='docblock autohide sub-variant' id='variant.BytesInto.fields'><h3 class='fields'>Fields of <code>BytesInto</code></h3>
<table><tr><td id='variant.BytesInto.field.src'><span id='BytesInto.v.src.v' class='invisible'><code>src: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td></td></tr><tr><td id='variant.BytesInto.field.dst'><span id='BytesInto.v.dst.v' class='invisible'><code>dst: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td></td></tr></table></span><span id="variant.BytesIntoVec" class="variant small-section-header"><a href="#variant.BytesIntoVec" class="anchor field"></a><span id='BytesIntoVec.v' class='invisible'><code>BytesIntoVec</code></span></span><span class='docblock autohide sub-variant' id='variant.BytesIntoVec.fields'><h3 class='fields'>Fields of <code>BytesIntoVec</code></h3>
<table><tr><td id='variant.BytesIntoVec.field.src'><span id='BytesIntoVec.v.src.v' class='invisible'><code>src: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td></td></tr><tr><td id='variant.BytesIntoVec.field.dst'><span id='BytesIntoVec.v.dst.v' class='invisible'><code>dst: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td></td></tr></table></span><span id="variant.BytesToVec" class="variant small-section-header"><a href="#variant.BytesToVec" class="anchor field"></a><span id='BytesToVec.v' class='invisible'><code>BytesToVec</code></span></span><span class='docblock autohide sub-variant' id='variant.BytesToVec.fields'><h3 class='fields'>Fields of <code>BytesToVec</code></h3>
<table><tr><td id='variant.BytesToVec.field.src'><span id='BytesToVec.v.src.v' class='invisible'><code>src: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td></td></tr><tr><td id='variant.BytesToVec.field.dst'><span id='BytesToVec.v.dst.v' class='invisible'><code>dst: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td></td></tr></table></span><span id="variant.BytesIntoString" class="variant small-section-header"><a href="#variant.BytesIntoString" class="anchor field"></a><span id='BytesIntoString.v' class='invisible'><code>BytesIntoString(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.FromUtf8Error.html" title="struct alloc::string::FromUtf8Error">FromUtf8Error</a>)</code></span></span>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-From%3CUtilError%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="enum" href="../../ocl_core/util/enum.UtilError.html" title="enum ocl_core::util::UtilError">UtilError</a>> for <a class="struct" href="../../ocl_core/error/struct.Error.html" title="struct ocl_core::error::Error">Error</a></code><a href='#impl-From%3CUtilError%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/error.rs.html#163-167' 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>(err: <a class="enum" href="../../ocl_core/util/enum.UtilError.html" title="enum ocl_core::util::UtilError">UtilError</a>) -> Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/error.rs.html#164-166' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../../ocl_core/util/enum.UtilError.html" title="enum ocl_core::util::UtilError">UtilError</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/util.rs.html#72' 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="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/util.rs.html#72' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Fail' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../failure/trait.Fail.html" title="trait failure::Fail">Fail</a> for <a class="enum" href="../../ocl_core/util/enum.UtilError.html" title="enum ocl_core::util::UtilError">UtilError</a></code><a href='#impl-Fail' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/util.rs.html#72' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.cause' class="method"><span id='cause.v' class='invisible'><code>fn <a href='../../failure/trait.Fail.html#method.cause' class='fnname'>cause</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="trait" href="../../failure/trait.Fail.html" title="trait failure::Fail">Fail</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/util.rs.html#72' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a reference to the underlying cause of this failure, if it is an error that wraps other errors. <a href="../../failure/trait.Fail.html#method.cause">Read more</a></p>
</div><h4 id='method.backtrace' class="method"><span id='backtrace.v' class='invisible'><code>fn <a href='../../failure/trait.Fail.html#method.backtrace' class='fnname'>backtrace</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../../failure/backtrace/struct.Backtrace.html" title="struct failure::backtrace::Backtrace">Backtrace</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/util.rs.html#72' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a reference to the <code>Backtrace</code> carried by this failure, if it carries one. <a href="../../failure/trait.Fail.html#method.backtrace">Read more</a></p>
</div><h4 id='method.context' class="method"><span id='context.v' class='invisible'><code>fn <a href='../../failure/trait.Fail.html#method.context' class='fnname'>context</a><D>(self, context: D) -> <a class="struct" href="../../failure/context/struct.Context.html" title="struct failure::context::Context">Context</a><D> <span class="where fmt-newline">where<br> D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/failure/lib.rs.html#123-128' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Provides context for this failure. <a href="../../failure/trait.Fail.html#method.context">Read more</a></p>
</div><h4 id='method.compat' class="method"><span id='compat.v' class='invisible'><code>fn <a href='../../failure/trait.Fail.html#method.compat' class='fnname'>compat</a>(self) -> <a class="struct" href="../../failure/compat/struct.Compat.html" title="struct failure::compat::Compat">Compat</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/failure/lib.rs.html#135-139' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Wraps this failure in a compatibility wrapper that implements <code>std::error::Error</code>. <a href="../../failure/trait.Fail.html#method.compat">Read more</a></p>
</div><h4 id='method.causes' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../../failure/struct.Causes.html" title="struct failure::Causes">Causes</a><'f></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../../failure/struct.Causes.html" title="struct failure::Causes">Causes</a><'f></h3><code class="content"><span class="where fmt-newline">impl<'f> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../../failure/struct.Causes.html" title="struct failure::Causes">Causes</a><'f></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = &'f (<a class="trait" href="../../failure/trait.Fail.html" title="trait failure::Fail">Fail</a> + 'static);</span></code></div></div><span id='causes.v' class='invisible'><code>fn <a href='../../failure/trait.Fail.html#method.causes' class='fnname'>causes</a>(&self) -> <a class="struct" href="../../failure/struct.Causes.html" title="struct failure::Causes">Causes</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/failure/lib.rs.html#143-145' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a iterator over the causes of this <code>Fail</code> with itself as the first item and the <code>root_cause</code> as the final item. <a href="../../failure/trait.Fail.html#method.causes">Read more</a></p>
</div><h4 id='method.root_cause' class="method"><span id='root_cause.v' class='invisible'><code>fn <a href='../../failure/trait.Fail.html#method.root_cause' class='fnname'>root_cause</a>(&self) -> &(<a class="trait" href="../../failure/trait.Fail.html" title="trait failure::Fail">Fail</a> + 'static)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/failure/lib.rs.html#152-156' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the "root cause" of this <code>Fail</code> - the last value in the cause chain which does not return an underlying <code>cause</code>. <a href="../../failure/trait.Fail.html#method.root_cause">Read more</a></p>
</div></div><h3 id='impl-Display' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="enum" href="../../ocl_core/util/enum.UtilError.html" title="enum ocl_core::util::UtilError">UtilError</a></code><a href='#impl-Display' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/util.rs.html#72' 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, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/util.rs.html#72' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></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><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>⏎</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 = "ocl_core";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>