mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-25 10:22:19 +00:00
139 lines
45 KiB
HTML
139 lines
45 KiB
HTML
<!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 `Pread` trait in crate `scroll`."><meta name="keywords" content="rust, rustlang, rust-lang, Pread"><title>scroll::Pread - 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="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[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><a href='../scroll/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait Pread</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.gread">gread</a><a href="#method.gread_inout">gread_inout</a><a href="#method.gread_inout_with">gread_inout_with</a><a href="#method.gread_with">gread_with</a><a href="#method.pread">pread</a><a href="#method.pread_with">pread_with</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>scroll</a></p><script>window.sidebarCurrent = {name: 'Pread', ty: 'trait', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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/scroll/pread.rs.html#83-205' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>scroll</a>::<wbr><a class="trait" href=''>Pread</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Pread<Ctx, E, I = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html" title="trait core::ops::index::Index">Index</a><I> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html" title="trait core::ops::index::Index">Index</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/ops/range/struct.RangeFrom.html" title="struct core::ops::range::RangeFrom">RangeFrom</a><I>> + <a class="trait" href="../scroll/ctx/trait.MeasureWith.html" title="trait scroll::ctx::MeasureWith">MeasureWith</a><Ctx, Units = I> <span class="where fmt-newline">where<br> Ctx: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>,<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Add.html" title="trait core::ops::arith::Add">Add</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>,<br> E: <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="../scroll/enum.Error.html" title="enum scroll::Error">Error</a><I>>, </span>{
|
||
fn <a href='#method.pread' class='fnname'>pread</a><'a, N: <a class="trait" href="../scroll/ctx/trait.TryFromCtx.html" title="trait scroll::ctx::TryFromCtx">TryFromCtx</a><'a, Ctx, Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>, Error = E, Size = I>>(<br> &'a self, <br> offset: I<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><N, E><br> <span class="where">where<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>: 'a,<br> Ctx: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a></span>,
|
||
{ ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.pread_with' class='fnname'>pread_with</a><'a, N: <a class="trait" href="../scroll/ctx/trait.TryFromCtx.html" title="trait scroll::ctx::TryFromCtx">TryFromCtx</a><'a, Ctx, Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>, Error = E, Size = I>>(<br> &'a self, <br> offset: I, <br> ctx: Ctx<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><N, E><br> <span class="where">where<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>: 'a</span>,
|
||
{ ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.gread' class='fnname'>gread</a><'a, N: <a class="trait" href="../scroll/ctx/trait.TryFromCtx.html" title="trait scroll::ctx::TryFromCtx">TryFromCtx</a><'a, Ctx, Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>, Error = E, Size = I>>(<br> &'a self, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>I<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><N, E><br> <span class="where">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.AddAssign.html" title="trait core::ops::arith::AddAssign">AddAssign</a>,<br> Ctx: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>: 'a</span>,
|
||
{ ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.gread_with' class='fnname'>gread_with</a><'a, N: <a class="trait" href="../scroll/ctx/trait.TryFromCtx.html" title="trait scroll::ctx::TryFromCtx">TryFromCtx</a><'a, Ctx, Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>, Error = E, Size = I>>(<br> &'a self, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>I, <br> ctx: Ctx<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><N, E><br> <span class="where">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.AddAssign.html" title="trait core::ops::arith::AddAssign">AddAssign</a>,<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>: 'a</span>,
|
||
{ ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.gread_inout' class='fnname'>gread_inout</a><'a, N>(<br> &'a self, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>I, <br> inout: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [N]</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, E><br> <span class="where">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.AddAssign.html" title="trait core::ops::arith::AddAssign">AddAssign</a>,<br> N: <a class="trait" href="../scroll/ctx/trait.TryFromCtx.html" title="trait scroll::ctx::TryFromCtx">TryFromCtx</a><'a, Ctx, Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>, Error = E, Size = I>,<br> Ctx: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>: 'a</span>,
|
||
{ ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.gread_inout_with' class='fnname'>gread_inout_with</a><'a, N>(<br> &'a self, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>I, <br> inout: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [N]</a>, <br> ctx: Ctx<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, E><br> <span class="where">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.AddAssign.html" title="trait core::ops::arith::AddAssign">AddAssign</a>,<br> N: <a class="trait" href="../scroll/ctx/trait.TryFromCtx.html" title="trait scroll::ctx::TryFromCtx">TryFromCtx</a><'a, Ctx, Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>, Error = E, Size = I>,<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>: 'a</span>,
|
||
{ ... }
|
||
}</pre></div><div class='docblock'><p>A very generic, contextual pread interface in Rust. Allows completely parallelized reads, as <code>Self</code> is immutable</p>
|
||
<p>Don't be scared! The <code>Pread</code> definition <em>is</em> terrifying, but it is definitely tractable. Essentially, <code>E</code> is the error, <code>Ctx</code> the parsing context, <code>I</code> is the indexing type, <code>TryCtx</code> is the "offset + ctx" Context given to the <code>TryFromCtx</code> trait bounds, and <code>SliceCtx</code> is the "offset + size + ctx" context given to the <code>TryRefFromCtx</code> trait bound.</p>
|
||
<h1 id="implementing-your-own-reader" class="section-header"><a href="#implementing-your-own-reader">Implementing Your Own Reader</a></h1>
|
||
<p>If you want to implement your own reader for a type <code>Foo</code> from some kind of buffer (say <code>[u8]</code>), then you need to implement <a href="trait.TryFromCtx.html">TryFromCtx</a></p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">scroll</span>::{<span class="self">self</span>, <span class="ident">ctx</span>, <span class="ident">Pread</span>};
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Foo</span>(<span class="ident">u16</span>);
|
||
|
||
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">ctx</span>::<span class="ident">TryFromCtx</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">scroll</span>::<span class="ident">Endian</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Foo</span> {
|
||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">scroll</span>::<span class="ident">Error</span>;
|
||
<span class="kw">type</span> <span class="ident">Size</span> <span class="op">=</span> <span class="ident">usize</span>;
|
||
<span class="kw">fn</span> <span class="ident">try_from_ctx</span>(<span class="ident">this</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> [<span class="ident">u8</span>], <span class="ident">le</span>: <span class="ident">scroll</span>::<span class="ident">Endian</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>(<span class="self">Self</span>, <span class="self">Self</span>::<span class="ident">Size</span>), <span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span> {
|
||
<span class="kw">if</span> <span class="ident">this</span>.<span class="ident">len</span>() <span class="op"><</span> <span class="number">2</span> { <span class="kw">return</span> <span class="prelude-val">Err</span>((<span class="ident">scroll</span>::<span class="ident">Error</span>::<span class="ident">Custom</span>(<span class="string">"whatever"</span>.<span class="ident">to_string</span>())).<span class="ident">into</span>()) }
|
||
<span class="kw">let</span> <span class="ident">n</span> <span class="op">=</span> <span class="ident">this</span>.<span class="ident">pread_with</span>(<span class="number">0</span>, <span class="ident">le</span>)<span class="question-mark">?</span>;
|
||
<span class="prelude-val">Ok</span>((<span class="ident">Foo</span>(<span class="ident">n</span>), <span class="number">2</span>))
|
||
}
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">bytes</span>: [<span class="ident">u8</span>; <span class="number">4</span>] <span class="op">=</span> [<span class="number">0xde</span>, <span class="number">0xad</span>, <span class="number">0</span>, <span class="number">0</span>];
|
||
<span class="kw">let</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">bytes</span>.<span class="ident">pread_with</span>::<span class="op"><</span><span class="ident">Foo</span><span class="op">></span>(<span class="number">0</span>, <span class="ident">scroll</span>::<span class="ident">LE</span>).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">Foo</span>(<span class="number">0xadde</span>), <span class="ident">foo</span>);
|
||
|
||
<span class="kw">let</span> <span class="ident">foo2</span> <span class="op">=</span> <span class="ident">bytes</span>.<span class="ident">pread_with</span>::<span class="op"><</span><span class="ident">Foo</span><span class="op">></span>(<span class="number">0</span>, <span class="ident">scroll</span>::<span class="ident">BE</span>).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">Foo</span>(<span class="number">0xdeadu16</span>), <span class="ident">foo2</span>);</pre></div>
|
||
<h1 id="advanced-using-your-own-error-in-tryfromctx" class="section-header"><a href="#advanced-using-your-own-error-in-tryfromctx">Advanced: Using Your Own Error in <code>TryFromCtx</code></a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">scroll</span>::{<span class="self">self</span>, <span class="ident">ctx</span>, <span class="ident">Pread</span>};
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">error</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>::{<span class="self">self</span>, <span class="ident">Display</span>};
|
||
<span class="comment">// make some kind of normal error which also can transform a scroll error ideally (quick_error, error_chain allow this automatically nowadays)</span>
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ExternalError</span> {}
|
||
|
||
<span class="kw">impl</span> <span class="ident">Display</span> <span class="kw">for</span> <span class="ident">ExternalError</span> {
|
||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">fmt</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-</span><span class="op">></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
|
||
<span class="macro">write</span><span class="macro">!</span>(<span class="ident">fmt</span>, <span class="string">"ExternalError"</span>)
|
||
}
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">error</span>::<span class="ident">Error</span> <span class="kw">for</span> <span class="ident">ExternalError</span> {
|
||
<span class="kw">fn</span> <span class="ident">description</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">str</span> {
|
||
<span class="string">"ExternalError"</span>
|
||
}
|
||
<span class="kw">fn</span> <span class="ident">cause</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">error</span>::<span class="ident">Error</span><span class="op">></span> { <span class="prelude-val">None</span>}
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">scroll</span>::<span class="ident">Error</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ExternalError</span> {
|
||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">err</span>: <span class="ident">scroll</span>::<span class="ident">Error</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
|
||
<span class="kw">match</span> <span class="ident">err</span> {
|
||
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="ident">ExternalError</span>{},
|
||
}
|
||
}
|
||
}
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Foo</span>(<span class="ident">u16</span>);
|
||
|
||
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">ctx</span>::<span class="ident">TryFromCtx</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">scroll</span>::<span class="ident">Endian</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Foo</span> {
|
||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">ExternalError</span>;
|
||
<span class="kw">type</span> <span class="ident">Size</span> <span class="op">=</span> <span class="ident">usize</span>;
|
||
<span class="kw">fn</span> <span class="ident">try_from_ctx</span>(<span class="ident">this</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> [<span class="ident">u8</span>], <span class="ident">le</span>: <span class="ident">scroll</span>::<span class="ident">Endian</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>(<span class="self">Self</span>, <span class="self">Self</span>::<span class="ident">Size</span>), <span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span> {
|
||
<span class="kw">if</span> <span class="ident">this</span>.<span class="ident">len</span>() <span class="op"><</span><span class="op">=</span> <span class="number">2</span> { <span class="kw">return</span> <span class="prelude-val">Err</span>((<span class="ident">ExternalError</span> {}).<span class="ident">into</span>()) }
|
||
<span class="kw">let</span> <span class="ident">offset</span> <span class="op">=</span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="number">0</span>;
|
||
<span class="kw">let</span> <span class="ident">n</span> <span class="op">=</span> <span class="ident">this</span>.<span class="ident">gread_with</span>(<span class="ident">offset</span>, <span class="ident">le</span>)<span class="question-mark">?</span>;
|
||
<span class="prelude-val">Ok</span>((<span class="ident">Foo</span>(<span class="ident">n</span>), <span class="kw-2">*</span><span class="ident">offset</span>))
|
||
}
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">bytes</span>: [<span class="ident">u8</span>; <span class="number">4</span>] <span class="op">=</span> [<span class="number">0xde</span>, <span class="number">0xad</span>, <span class="number">0</span>, <span class="number">0</span>];
|
||
<span class="kw">let</span> <span class="ident">foo</span>: <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Foo</span>, <span class="ident">ExternalError</span><span class="op">></span> <span class="op">=</span> <span class="ident">bytes</span>.<span class="ident">pread</span>(<span class="number">0</span>);</pre></div>
|
||
</div>
|
||
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.pread' class='method'><code id='pread.v'>fn <a href='#method.pread' class='fnname'>pread</a><'a, N: <a class="trait" href="../scroll/ctx/trait.TryFromCtx.html" title="trait scroll::ctx::TryFromCtx">TryFromCtx</a><'a, Ctx, Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>, Error = E, Size = I>>(<br> &'a self, <br> offset: I<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><N, E> <span class="where fmt-newline">where<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>: 'a,<br> Ctx: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>, </span></code></h3><div class='docblock'><p>Reads a value from <code>self</code> at <code>offset</code> with a default <code>Ctx</code>. For the primitive numeric values, this will read at the machine's endianness.</p>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">scroll</span>::<span class="ident">Pread</span>;
|
||
<span class="kw">let</span> <span class="ident">bytes</span> <span class="op">=</span> [<span class="number">0x7fu8</span>; <span class="number">0x01</span>];
|
||
<span class="kw">let</span> <span class="ident">byte</span> <span class="op">=</span> <span class="ident">bytes</span>.<span class="ident">pread</span>::<span class="op"><</span><span class="ident">u8</span><span class="op">></span>(<span class="number">0</span>).<span class="ident">unwrap</span>();</pre></div>
|
||
</div><h3 id='method.pread_with' class='method'><code id='pread_with.v'>fn <a href='#method.pread_with' class='fnname'>pread_with</a><'a, N: <a class="trait" href="../scroll/ctx/trait.TryFromCtx.html" title="trait scroll::ctx::TryFromCtx">TryFromCtx</a><'a, Ctx, Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>, Error = E, Size = I>>(<br> &'a self, <br> offset: I, <br> ctx: Ctx<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><N, E> <span class="where fmt-newline">where<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>: 'a, </span></code></h3><div class='docblock'><p>Reads a value from <code>self</code> at <code>offset</code> with the given <code>ctx</code></p>
|
||
<h1 id="example-1" class="section-header"><a href="#example-1">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">scroll</span>::<span class="ident">Pread</span>;
|
||
<span class="kw">let</span> <span class="ident">bytes</span>: [<span class="ident">u8</span>; <span class="number">2</span>] <span class="op">=</span> [<span class="number">0xde</span>, <span class="number">0xad</span>];
|
||
<span class="kw">let</span> <span class="ident">dead</span>: <span class="ident">u16</span> <span class="op">=</span> <span class="ident">bytes</span>.<span class="ident">pread_with</span>(<span class="number">0</span>, <span class="ident">scroll</span>::<span class="ident">BE</span>).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">dead</span>, <span class="number">0xdeadu16</span>);</pre></div>
|
||
</div><h3 id='method.gread' class='method'><code id='gread.v'>fn <a href='#method.gread' class='fnname'>gread</a><'a, N: <a class="trait" href="../scroll/ctx/trait.TryFromCtx.html" title="trait scroll::ctx::TryFromCtx">TryFromCtx</a><'a, Ctx, Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>, Error = E, Size = I>>(<br> &'a self, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>I<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><N, E> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.AddAssign.html" title="trait core::ops::arith::AddAssign">AddAssign</a>,<br> Ctx: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>: 'a, </span></code></h3><div class='docblock'><p>Reads a value from <code>self</code> at <code>offset</code> with a default <code>Ctx</code>. For the primitive numeric values, this will read at the machine's endianness. Updates the offset</p>
|
||
<h1 id="example-2" class="section-header"><a href="#example-2">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">scroll</span>::<span class="ident">Pread</span>;
|
||
<span class="kw">let</span> <span class="ident">offset</span> <span class="op">=</span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="number">0</span>;
|
||
<span class="kw">let</span> <span class="ident">bytes</span> <span class="op">=</span> [<span class="number">0x7fu8</span>; <span class="number">0x01</span>];
|
||
<span class="kw">let</span> <span class="ident">byte</span> <span class="op">=</span> <span class="ident">bytes</span>.<span class="ident">gread</span>::<span class="op"><</span><span class="ident">u8</span><span class="op">></span>(<span class="ident">offset</span>).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">offset</span>, <span class="number">1</span>);</pre></div>
|
||
</div><h3 id='method.gread_with' class='method'><code id='gread_with.v'>fn <a href='#method.gread_with' class='fnname'>gread_with</a><'a, N: <a class="trait" href="../scroll/ctx/trait.TryFromCtx.html" title="trait scroll::ctx::TryFromCtx">TryFromCtx</a><'a, Ctx, Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>, Error = E, Size = I>>(<br> &'a self, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>I, <br> ctx: Ctx<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><N, E> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.AddAssign.html" title="trait core::ops::arith::AddAssign">AddAssign</a>,<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>: 'a, </span></code></h3><div class='docblock'><p>Reads a value from <code>self</code> at <code>offset</code> with the given <code>ctx</code>, and updates the offset.</p>
|
||
<h1 id="example-3" class="section-header"><a href="#example-3">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">scroll</span>::<span class="ident">Pread</span>;
|
||
<span class="kw">let</span> <span class="ident">offset</span> <span class="op">=</span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="number">0</span>;
|
||
<span class="kw">let</span> <span class="ident">bytes</span>: [<span class="ident">u8</span>; <span class="number">2</span>] <span class="op">=</span> [<span class="number">0xde</span>, <span class="number">0xad</span>];
|
||
<span class="kw">let</span> <span class="ident">dead</span>: <span class="ident">u16</span> <span class="op">=</span> <span class="ident">bytes</span>.<span class="ident">gread_with</span>(<span class="ident">offset</span>, <span class="ident">scroll</span>::<span class="ident">BE</span>).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">dead</span>, <span class="number">0xdeadu16</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">offset</span>, <span class="number">2</span>);</pre></div>
|
||
</div><h3 id='method.gread_inout' class='method'><code id='gread_inout.v'>fn <a href='#method.gread_inout' class='fnname'>gread_inout</a><'a, N>(<br> &'a self, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>I, <br> inout: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [N]</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, E> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.AddAssign.html" title="trait core::ops::arith::AddAssign">AddAssign</a>,<br> N: <a class="trait" href="../scroll/ctx/trait.TryFromCtx.html" title="trait scroll::ctx::TryFromCtx">TryFromCtx</a><'a, Ctx, Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>, Error = E, Size = I>,<br> Ctx: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>: 'a, </span></code></h3><div class='docblock'><p>Trys to write <code>inout.len()</code> <code>N</code>s into <code>inout</code> from <code>Self</code> starting at <code>offset</code>, using the default context for <code>N</code>, and updates the offset.</p>
|
||
<h1 id="example-4" class="section-header"><a href="#example-4">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">scroll</span>::<span class="ident">Pread</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">bytes</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">0</span>, <span class="number">0</span>];
|
||
<span class="kw">let</span> <span class="ident">offset</span> <span class="op">=</span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="number">0</span>;
|
||
<span class="kw">let</span> <span class="ident">bytes_from</span>: [<span class="ident">u8</span>; <span class="number">2</span>] <span class="op">=</span> [<span class="number">0x48</span>, <span class="number">0x49</span>];
|
||
<span class="ident">bytes_from</span>.<span class="ident">gread_inout</span>(<span class="ident">offset</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">bytes</span>).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="ident">bytes</span>, <span class="kw-2">&</span><span class="ident">bytes_from</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">offset</span>, <span class="number">2</span>);</pre></div>
|
||
</div><h3 id='method.gread_inout_with' class='method'><code id='gread_inout_with.v'>fn <a href='#method.gread_inout_with' class='fnname'>gread_inout_with</a><'a, N>(<br> &'a self, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>I, <br> inout: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [N]</a>, <br> ctx: Ctx<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, E> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.AddAssign.html" title="trait core::ops::arith::AddAssign">AddAssign</a>,<br> N: <a class="trait" href="../scroll/ctx/trait.TryFromCtx.html" title="trait scroll::ctx::TryFromCtx">TryFromCtx</a><'a, Ctx, Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>, Error = E, Size = I>,<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a>: 'a, </span></code></h3><div class='docblock'><p>Trys to write <code>inout.len()</code> <code>N</code>s into <code>inout</code> from <code>Self</code> starting at <code>offset</code>, using the context <code>ctx</code></p>
|
||
<h1 id="example-5" class="section-header"><a href="#example-5">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">scroll</span>::{<span class="ident">ctx</span>, <span class="ident">LE</span>, <span class="ident">Pread</span>};
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">bytes</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">0</span>, <span class="number">0</span>];
|
||
<span class="kw">let</span> <span class="ident">offset</span> <span class="op">=</span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="number">0</span>;
|
||
<span class="kw">let</span> <span class="ident">bytes_from</span>: [<span class="ident">u8</span>; <span class="number">2</span>] <span class="op">=</span> [<span class="number">0x48</span>, <span class="number">0x49</span>];
|
||
<span class="ident">bytes_from</span>.<span class="ident">gread_inout_with</span>(<span class="ident">offset</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">bytes</span>, <span class="ident">LE</span>).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="ident">bytes</span>, <span class="kw-2">&</span><span class="ident">bytes_from</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">offset</span>, <span class="number">2</span>);</pre></div>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-Pread%3CCtx%2C%20E%2C%20I%3E' class='impl'><code class='in-band'>impl<Ctx: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>, I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Add.html" title="trait core::ops::arith::Add">Add</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>, E: <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="../scroll/enum.Error.html" title="enum scroll::Error">Error</a><I>>, R: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html" title="trait core::ops::index::Index">Index</a><I> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html" title="trait core::ops::index::Index">Index</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/ops/range/struct.RangeFrom.html" title="struct core::ops::range::RangeFrom">RangeFrom</a><I>> + <a class="trait" href="../scroll/ctx/trait.MeasureWith.html" title="trait scroll::ctx::MeasureWith">MeasureWith</a><Ctx, Units = I>> Pread<Ctx, E, I> for R</code><a href='#impl-Pread%3CCtx%2C%20E%2C%20I%3E' class='anchor'></a><a class='srclink' href='../src/scroll/pread.rs.html#207-211' title='goto source code'>[src]</a></h3><div class='impl-items'></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../implementors/scroll/trait.Pread.js">
|
||
</script></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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "scroll";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |