Skip to content

Commit

Permalink
Deploy rust API reference Merge pull request #2127 from oasisprotocol…
Browse files Browse the repository at this point in the history 
…/rube/docs-refactor-build

docs: dapp to build refactor 0563c97
  • Loading branch information
@github-actions
github-actions[bot] committed Jan 17, 2025
1 parent 1f15799 commit 53f994f
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions rust/oasis_contract_sdk_storage/cell/struct.ConfidentialCell.html
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!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="A storage cell identifies a storage key of a specific type."><title>ConfidentialCell in oasis_contract_sdk_storage::cell - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="oasis_contract_sdk_storage" data-themes="" data-resource-suffix="" data-rustdoc-version="1.81.0-nightly (35b658fb1 2024-07-08)" data-channel="nightly" data-search-js="search-d234aafac6c221dd.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><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"></head><body class="rustdoc struct"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../oasis_contract_sdk_storage/index.html">oasis_contract_sdk_storage</a><span class="version">0.3.0</span></h2></div><h2 class="location"><a href="#">ConfidentialCell</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.clear">clear</a></li><li><a href="#method.get">get</a></li><li><a href="#method.new">new</a></li><li><a href="#method.set">set</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-ConfidentialCell%3C'key,+T%3E">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-ConfidentialCell%3C'key,+T%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ConfidentialCell%3C'key,+T%3E">Send</a></li><li><a href="#impl-Sync-for-ConfidentialCell%3C'key,+T%3E">Sync</a></li><li><a href="#impl-Unpin-for-ConfidentialCell%3C'key,+T%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ConfidentialCell%3C'key,+T%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-AsTaggedExplicit%3C'a,+E%3E-for-T">AsTaggedExplicit&lt;&#x27;a, E&gt;</a></li><li><a href="#impl-AsTaggedImplicit%3C'a,+E%3E-for-T">AsTaggedImplicit&lt;&#x27;a, E&gt;</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-ErasedDestructor-for-T">ErasedDestructor</a></li><li><a href="#impl-From%3CT%3E-for-T">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-T">Into&lt;U&gt;</a></li><li><a href="#impl-MaybeSendSync-for-T">MaybeSendSync</a></li><li><a href="#impl-Pointable-for-T">Pointable</a></li><li><a href="#impl-Same-for-T">Same</a></li><li><a href="#impl-SendSyncUnwindSafe-for-T">SendSyncUnwindSafe</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto&lt;U&gt;</a></li><li><a href="#impl-VZip%3CV%3E-for-T">VZip&lt;V&gt;</a></li></ul></section><h2><a href="index.html">In oasis_contract_sdk_storage::cell</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="../index.html">oasis_contract_sdk_storage</a>::<wbr><a href="index.html">cell</a>::<wbr><a class="struct" href="#">ConfidentialCell</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/oasis_contract_sdk_storage/cell.rs.html#59">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub struct ConfidentialCell&lt;'key, T&gt; { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A storage cell identifies a storage key of a specific type.</p>
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-ConfidentialCell%3C'key,+T%3E" class="impl"><a class="src rightside" href="../../src/oasis_contract_sdk_storage/cell.rs.html#59">source</a><a href="#impl-ConfidentialCell%3C'key,+T%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'key, T&gt; <a class="struct" href="struct.ConfidentialCell.html" title="struct oasis_contract_sdk_storage::cell::ConfidentialCell">ConfidentialCell</a>&lt;'key, T&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../../src/oasis_contract_sdk_storage/cell.rs.html#59">source</a><h4 class="code-header">pub const fn <a href="#method.new" class="fn">new</a>(key: &amp;'key [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]) -&gt; Self</h4></section></summary><div class="docblock"><p>Create a new storage cell with the specified key and type.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.clear" class="method"><a class="src rightside" href="../../src/oasis_contract_sdk_storage/cell.rs.html#59">source</a><h4 class="code-header">pub fn <a href="#method.clear" class="fn">clear</a>(&amp;self, store: &amp;mut dyn <a class="trait" href="../../oasis_contract_sdk/storage/trait.ConfidentialStore.html" title="trait oasis_contract_sdk::storage::ConfidentialStore">ConfidentialStore</a>)</h4></section></summary><div class="docblock"><p>Clear the value in the storage cell.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.clear" class="method"><a class="src rightside" href="../../src/oasis_contract_sdk_storage/cell.rs.html#59">source</a><h4 class="code-header">pub fn <a href="#method.clear" class="fn">clear</a>(&amp;self, store: &amp;mut dyn ConfidentialStore)</h4></section></summary><div class="docblock"><p>Clear the value in the storage cell.</p>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-ConfidentialCell%3C'key,+T%3E-1" class="impl"><a class="src rightside" href="../../src/oasis_contract_sdk_storage/cell.rs.html#59">source</a><a href="#impl-ConfidentialCell%3C'key,+T%3E-1" class="anchor">§</a><h3 class="code-header">impl&lt;'key, T&gt; <a class="struct" href="struct.ConfidentialCell.html" title="struct oasis_contract_sdk_storage::cell::ConfidentialCell">ConfidentialCell</a>&lt;'key, T&gt;<div class="where">where
T: Decode,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.get" class="method"><a class="src rightside" href="../../src/oasis_contract_sdk_storage/cell.rs.html#59">source</a><h4 class="code-header">pub fn <a href="#method.get" class="fn">get</a>(&amp;self, store: &amp;dyn <a class="trait" href="../../oasis_contract_sdk/storage/trait.ConfidentialStore.html" title="trait oasis_contract_sdk::storage::ConfidentialStore">ConfidentialStore</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;T&gt;</h4></section></summary><div class="docblock"><p>Return the current value of the storage cell.</p>
T: Decode,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.get" class="method"><a class="src rightside" href="../../src/oasis_contract_sdk_storage/cell.rs.html#59">source</a><h4 class="code-header">pub fn <a href="#method.get" class="fn">get</a>(&amp;self, store: &amp;dyn ConfidentialStore) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;T&gt;</h4></section></summary><div class="docblock"><p>Return the current value of the storage cell.</p>
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
<p>The method will panic in case the raw cell value cannot be deserialized.</p>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-ConfidentialCell%3C'key,+T%3E-2" class="impl"><a class="src rightside" href="../../src/oasis_contract_sdk_storage/cell.rs.html#59">source</a><a href="#impl-ConfidentialCell%3C'key,+T%3E-2" class="anchor">§</a><h3 class="code-header">impl&lt;'key, T&gt; <a class="struct" href="struct.ConfidentialCell.html" title="struct oasis_contract_sdk_storage::cell::ConfidentialCell">ConfidentialCell</a>&lt;'key, T&gt;<div class="where">where
T: Encode,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.set" class="method"><a class="src rightside" href="../../src/oasis_contract_sdk_storage/cell.rs.html#59">source</a><h4 class="code-header">pub fn <a href="#method.set" class="fn">set</a>(&amp;self, store: &amp;mut dyn <a class="trait" href="../../oasis_contract_sdk/storage/trait.ConfidentialStore.html" title="trait oasis_contract_sdk::storage::ConfidentialStore">ConfidentialStore</a>, value: T)</h4></section></summary><div class="docblock"><p>Set the value of the storage cell.</p>
T: Encode,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.set" class="method"><a class="src rightside" href="../../src/oasis_contract_sdk_storage/cell.rs.html#59">source</a><h4 class="code-header">pub fn <a href="#method.set" class="fn">set</a>(&amp;self, store: &amp;mut dyn ConfidentialStore, value: T)</h4></section></summary><div class="docblock"><p>Set the value of the storage cell.</p>
</div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-ConfidentialCell%3C'key,+T%3E" class="impl"><a href="#impl-Freeze-for-ConfidentialCell%3C'key,+T%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'key, T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.ConfidentialCell.html" title="struct oasis_contract_sdk_storage::cell::ConfidentialCell">ConfidentialCell</a>&lt;'key, T&gt;</h3></section><section id="impl-RefUnwindSafe-for-ConfidentialCell%3C'key,+T%3E" class="impl"><a href="#impl-RefUnwindSafe-for-ConfidentialCell%3C'key,+T%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'key, T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.ConfidentialCell.html" title="struct oasis_contract_sdk_storage::cell::ConfidentialCell">ConfidentialCell</a>&lt;'key, T&gt;<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</div></h3></section><section id="impl-Send-for-ConfidentialCell%3C'key,+T%3E" class="impl"><a href="#impl-Send-for-ConfidentialCell%3C'key,+T%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'key, T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.ConfidentialCell.html" title="struct oasis_contract_sdk_storage::cell::ConfidentialCell">ConfidentialCell</a>&lt;'key, T&gt;<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-ConfidentialCell%3C'key,+T%3E" class="impl"><a href="#impl-Sync-for-ConfidentialCell%3C'key,+T%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'key, T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.ConfidentialCell.html" title="struct oasis_contract_sdk_storage::cell::ConfidentialCell">ConfidentialCell</a>&lt;'key, T&gt;<div class="where">where
Expand Down
Loading

0 comments on commit 53f994f

Please sign in to comment.