mirror of https://github.com/zcash/halo2.git
66 lines
19 KiB
HTML
66 lines
19 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="The set of circuit instructions required to use the `Sha256` gadget."><title>Sha256Instructions in halo2_gadgets::sha256 - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-fa3bb1812debf86c.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="halo2_gadgets" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0-nightly (2bbb61989 2023-10-04)" data-channel="nightly" data-search-js="search-8be46b629f5f14a8.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-c5bd66d33317d69f.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"><link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/katex.min.css" integrity="sha384-9eLZqc9ds8eNjO3TmqPeYcDj8n+Qfa4nuSiGYa6DjLNcv9BtN69ZIulL9+8CqC9Y" crossorigin="anonymous">
|
||
<script src="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/katex.min.js" integrity="sha384-K3vbOmF2BtaVai+Qk37uypf7VrgBubhQreNQe9aGsz9lB63dIFiQVlJbr92dw2Lx" crossorigin="anonymous"></script>
|
||
<script src="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/contrib/auto-render.min.js" integrity="sha384-kmZOZB5ObwgQnS/DuDg6TScgOiWWBiVt0plIRkZCmE6rDZGrEOQeHM5PcHi+nyqe" crossorigin="anonymous"></script>
|
||
<script>
|
||
document.addEventListener("DOMContentLoaded", function() {
|
||
renderMathInElement(document.body, {
|
||
delimiters: [
|
||
{left: "$$", right: "$$", display: true},
|
||
{left: "\\(", right: "\\)", display: false},
|
||
{left: "$", right: "$", display: false},
|
||
{left: "\\[", right: "\\]", display: true}
|
||
]
|
||
});
|
||
});
|
||
</script>
|
||
</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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="logo-container" href="../../halo2_gadgets/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a></nav><nav class="sidebar"><a class="logo-container" href="../../halo2_gadgets/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Sha256Instructions</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.BlockWord">BlockWord</a></li><li><a href="#associatedtype.State">State</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.compress">compress</a></li><li><a href="#tymethod.digest">digest</a></li><li><a href="#tymethod.initialization">initialization</a></li><li><a href="#tymethod.initialization_vector">initialization_vector</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In halo2_gadgets::sha256</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../index.html">halo2_gadgets</a>::<wbr><a href="index.html">sha256</a>::<wbr><a class="trait" href="#">Sha256Instructions</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/halo2_gadgets/sha256.rs.html#25-57">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Sha256Instructions<F: Field>: <a class="trait" href="../../halo2_proofs/circuit/trait.Chip.html" title="trait halo2_proofs::circuit::Chip">Chip</a><F> {
|
||
type <a href="#associatedtype.State" class="associatedtype">State</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>;
|
||
type <a href="#associatedtype.BlockWord" class="associatedtype">BlockWord</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/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>;
|
||
|
||
// Required methods
|
||
fn <a href="#tymethod.initialization_vector" class="fn">initialization_vector</a>(
|
||
&self,
|
||
layouter: &mut impl <a class="trait" href="../../halo2_proofs/circuit/trait.Layouter.html" title="trait halo2_proofs::circuit::Layouter">Layouter</a><F>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.Sha256Instructions.html#associatedtype.State" title="type halo2_gadgets::sha256::Sha256Instructions::State">State</a>, <a class="enum" href="../../halo2_proofs/plonk/error/enum.Error.html" title="enum halo2_proofs::plonk::error::Error">Error</a>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.initialization" class="fn">initialization</a>(
|
||
&self,
|
||
layouter: &mut impl <a class="trait" href="../../halo2_proofs/circuit/trait.Layouter.html" title="trait halo2_proofs::circuit::Layouter">Layouter</a><F>,
|
||
init_state: &Self::<a class="associatedtype" href="trait.Sha256Instructions.html#associatedtype.State" title="type halo2_gadgets::sha256::Sha256Instructions::State">State</a>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.Sha256Instructions.html#associatedtype.State" title="type halo2_gadgets::sha256::Sha256Instructions::State">State</a>, <a class="enum" href="../../halo2_proofs/plonk/error/enum.Error.html" title="enum halo2_proofs::plonk::error::Error">Error</a>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.compress" class="fn">compress</a>(
|
||
&self,
|
||
layouter: &mut impl <a class="trait" href="../../halo2_proofs/circuit/trait.Layouter.html" title="trait halo2_proofs::circuit::Layouter">Layouter</a><F>,
|
||
initialized_state: &Self::<a class="associatedtype" href="trait.Sha256Instructions.html#associatedtype.State" title="type halo2_gadgets::sha256::Sha256Instructions::State">State</a>,
|
||
input: [Self::<a class="associatedtype" href="trait.Sha256Instructions.html#associatedtype.BlockWord" title="type halo2_gadgets::sha256::Sha256Instructions::BlockWord">BlockWord</a>; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">16</a>]
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.Sha256Instructions.html#associatedtype.State" title="type halo2_gadgets::sha256::Sha256Instructions::State">State</a>, <a class="enum" href="../../halo2_proofs/plonk/error/enum.Error.html" title="enum halo2_proofs::plonk::error::Error">Error</a>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.digest" class="fn">digest</a>(
|
||
&self,
|
||
layouter: &mut impl <a class="trait" href="../../halo2_proofs/circuit/trait.Layouter.html" title="trait halo2_proofs::circuit::Layouter">Layouter</a><F>,
|
||
state: &Self::<a class="associatedtype" href="trait.Sha256Instructions.html#associatedtype.State" title="type halo2_gadgets::sha256::Sha256Instructions::State">State</a>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><[Self::<a class="associatedtype" href="trait.Sha256Instructions.html#associatedtype.BlockWord" title="type halo2_gadgets::sha256::Sha256Instructions::BlockWord">BlockWord</a>; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">8</a>], <a class="enum" href="../../halo2_proofs/plonk/error/enum.Error.html" title="enum halo2_proofs::plonk::error::Error">Error</a>>;
|
||
}</code></pre><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>unstable-sha256-gadget</code></strong> only.</div></span><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The set of circuit instructions required to use the <a href="struct.Sha256.html" title="struct halo2_gadgets::sha256::Sha256"><code>Sha256</code></a> gadget.</p>
|
||
</div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.State" class="method"><a class="src rightside" href="../../src/halo2_gadgets/sha256.rs.html#27">source</a><h4 class="code-header">type <a href="#associatedtype.State" class="associatedtype">State</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a></h4></section></summary><div class="docblock"><p>Variable representing the SHA-256 internal state.</p>
|
||
</div></details><details class="toggle" open><summary><section id="associatedtype.BlockWord" class="method"><a class="src rightside" href="../../src/halo2_gadgets/sha256.rs.html#30">source</a><h4 class="code-header">type <a href="#associatedtype.BlockWord" class="associatedtype">BlockWord</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/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a></h4></section></summary><div class="docblock"><p>Variable representing a 32-bit word of the input block to the SHA-256 compression
|
||
function.</p>
|
||
</div></details></div><h2 id="required-methods" class="small-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.initialization_vector" class="method"><a class="src rightside" href="../../src/halo2_gadgets/sha256.rs.html#33">source</a><h4 class="code-header">fn <a href="#tymethod.initialization_vector" class="fn">initialization_vector</a>(
|
||
&self,
|
||
layouter: &mut impl <a class="trait" href="../../halo2_proofs/circuit/trait.Layouter.html" title="trait halo2_proofs::circuit::Layouter">Layouter</a><F>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.Sha256Instructions.html#associatedtype.State" title="type halo2_gadgets::sha256::Sha256Instructions::State">State</a>, <a class="enum" href="../../halo2_proofs/plonk/error/enum.Error.html" title="enum halo2_proofs::plonk::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>Places the SHA-256 IV in the circuit, returning the initial state variable.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.initialization" class="method"><a class="src rightside" href="../../src/halo2_gadgets/sha256.rs.html#36-40">source</a><h4 class="code-header">fn <a href="#tymethod.initialization" class="fn">initialization</a>(
|
||
&self,
|
||
layouter: &mut impl <a class="trait" href="../../halo2_proofs/circuit/trait.Layouter.html" title="trait halo2_proofs::circuit::Layouter">Layouter</a><F>,
|
||
init_state: &Self::<a class="associatedtype" href="trait.Sha256Instructions.html#associatedtype.State" title="type halo2_gadgets::sha256::Sha256Instructions::State">State</a>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.Sha256Instructions.html#associatedtype.State" title="type halo2_gadgets::sha256::Sha256Instructions::State">State</a>, <a class="enum" href="../../halo2_proofs/plonk/error/enum.Error.html" title="enum halo2_proofs::plonk::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>Creates an initial state from the output state of a previous block</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.compress" class="method"><a class="src rightside" href="../../src/halo2_gadgets/sha256.rs.html#44-49">source</a><h4 class="code-header">fn <a href="#tymethod.compress" class="fn">compress</a>(
|
||
&self,
|
||
layouter: &mut impl <a class="trait" href="../../halo2_proofs/circuit/trait.Layouter.html" title="trait halo2_proofs::circuit::Layouter">Layouter</a><F>,
|
||
initialized_state: &Self::<a class="associatedtype" href="trait.Sha256Instructions.html#associatedtype.State" title="type halo2_gadgets::sha256::Sha256Instructions::State">State</a>,
|
||
input: [Self::<a class="associatedtype" href="trait.Sha256Instructions.html#associatedtype.BlockWord" title="type halo2_gadgets::sha256::Sha256Instructions::BlockWord">BlockWord</a>; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">16</a>]
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.Sha256Instructions.html#associatedtype.State" title="type halo2_gadgets::sha256::Sha256Instructions::State">State</a>, <a class="enum" href="../../halo2_proofs/plonk/error/enum.Error.html" title="enum halo2_proofs::plonk::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>Starting from the given initialized state, processes a block of input and returns the
|
||
final state.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.digest" class="method"><a class="src rightside" href="../../src/halo2_gadgets/sha256.rs.html#52-56">source</a><h4 class="code-header">fn <a href="#tymethod.digest" class="fn">digest</a>(
|
||
&self,
|
||
layouter: &mut impl <a class="trait" href="../../halo2_proofs/circuit/trait.Layouter.html" title="trait halo2_proofs::circuit::Layouter">Layouter</a><F>,
|
||
state: &Self::<a class="associatedtype" href="trait.Sha256Instructions.html#associatedtype.State" title="type halo2_gadgets::sha256::Sha256Instructions::State">State</a>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><[Self::<a class="associatedtype" href="trait.Sha256Instructions.html#associatedtype.BlockWord" title="type halo2_gadgets::sha256::Sha256Instructions::BlockWord">BlockWord</a>; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">8</a>], <a class="enum" href="../../halo2_proofs/plonk/error/enum.Error.html" title="enum halo2_proofs::plonk::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>Converts the given state into a message digest.</p>
|
||
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-Sha256Instructions%3CFp%3E-for-Table16Chip" class="impl"><a class="src rightside" href="../../src/halo2_gadgets/sha256/table16.rs.html#329-374">source</a><a href="#impl-Sha256Instructions%3CFp%3E-for-Table16Chip" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Sha256Instructions.html" title="trait halo2_gadgets::sha256::Sha256Instructions">Sha256Instructions</a><Fp> for <a class="struct" href="struct.Table16Chip.html" title="struct halo2_gadgets::sha256::Table16Chip">Table16Chip</a></h3></section></summary><div class="impl-items"><section id="associatedtype.State-1" class="associatedtype trait-impl"><a href="#associatedtype.State-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.State" class="associatedtype">State</a> = State</h4></section><section id="associatedtype.BlockWord-1" class="associatedtype trait-impl"><a href="#associatedtype.BlockWord-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.BlockWord" class="associatedtype">BlockWord</a> = <a class="struct" href="struct.BlockWord.html" title="struct halo2_gadgets::sha256::BlockWord">BlockWord</a></h4></section></div></details></div><script src="../../implementors/halo2_gadgets/sha256/trait.Sha256Instructions.js" async></script></section></div></main></body></html> |