17 lines
7.7 KiB
HTML
17 lines
7.7 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="Trait for reader types which are used to extract extendable output from a XOF (extendable-output function) result."><title>XofReader in digest - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="digest" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="icon" href="https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">XofReader</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../digest/index.html"><img src="https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg" alt="logo"></a><h2><a href="../digest/index.html">digest</a><span class="version">0.10.7</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">XofReader</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.read" title="read">read</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.read_boxed" title="read_boxed">read_boxed</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate digest</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">digest</a></div><h1>Trait <span class="trait">XofReader</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/digest/lib.rs.html#122-139">Source</a> </span></div><pre class="rust item-decl"><code>pub trait XofReader {
|
|
// Required method
|
|
fn <a href="#tymethod.read" class="fn">read</a>(&mut self, buffer: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]);
|
|
|
|
// Provided method
|
|
fn <a href="#method.read_boxed" class="fn">read_boxed</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for reader types which are used to extract extendable output
|
|
from a XOF (extendable-output function) result.</p>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.read" class="method"><a class="src rightside" href="../src/digest/lib.rs.html#124">Source</a><h4 class="code-header">fn <a href="#tymethod.read" class="fn">read</a>(&mut self, buffer: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>])</h4></section></summary><div class="docblock"><p>Read output into the <code>buffer</code>. Can be called an unlimited number of times.</p>
|
|
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.read_boxed" class="method"><a class="src rightside" href="../src/digest/lib.rs.html#134-138">Source</a><h4 class="code-header">fn <a href="#method.read_boxed" class="fn">read_boxed</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]></h4></section></summary><div class="docblock"><p>Read output into a boxed slice of the specified size.</p>
|
|
<p>Can be called an unlimited number of times in combination with <code>read</code>.</p>
|
|
<p><code>Box<[u8]></code> is used instead of <code>Vec<u8></code> to save stack space, since
|
|
they have size of 2 and 3 words respectively.</p>
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-XofReader-for-XofReaderCoreWrapper%3CT%3E" class="impl"><a class="src rightside" href="../src/digest/core_api/xof_reader.rs.html#33-48">Source</a><a href="#impl-XofReader-for-XofReaderCoreWrapper%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="trait.XofReader.html" title="trait digest::XofReader">XofReader</a> for <a class="struct" href="core_api/struct.XofReaderCoreWrapper.html" title="struct digest::core_api::XofReaderCoreWrapper">XofReaderCoreWrapper</a><T><div class="where">where
|
|
T: <a class="trait" href="core_api/trait.XofReaderCore.html" title="trait digest::core_api::XofReaderCore">XofReaderCore</a>,
|
|
T::<a class="associatedtype" href="core_api/trait.BlockSizeUser.html#associatedtype.BlockSize" title="type digest::core_api::BlockSizeUser::BlockSize">BlockSize</a>: <a class="trait" href="../typenum/type_operators/trait.IsLess.html" title="trait typenum::type_operators::IsLess">IsLess</a><<a class="type" href="consts/type.U256.html" title="type digest::consts::U256">U256</a>>,
|
|
<a class="type" href="../typenum/operator_aliases/type.Le.html" title="type typenum::operator_aliases::Le">Le</a><T::<a class="associatedtype" href="core_api/trait.BlockSizeUser.html#associatedtype.BlockSize" title="type digest::core_api::BlockSizeUser::BlockSize">BlockSize</a>, <a class="type" href="consts/type.U256.html" title="type digest::consts::U256">U256</a>>: <a class="trait" href="../typenum/marker_traits/trait.NonZero.html" title="trait typenum::marker_traits::NonZero">NonZero</a>,</div></h3></section></div><script src="../trait.impl/digest/trait.XofReader.js" async></script></section></div></main></body></html> |