Skip to content

Commit

Permalink
Updated docs for master} and pushed to gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
paritytech-ci committed Mar 8, 2024
1 parent 5649880 commit cc07725
Show file tree
Hide file tree
Showing 30 changed files with 401 additions and 121 deletions.
6 changes: 3 additions & 3 deletions ink/attr.event.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!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="Implements the necessary traits for a `struct` to be emitted as an event from a contract."><title>event in ink - 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/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-9ee3a5e31a2afa3e.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="ink" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0 (82e1608df 2023-12-21)" data-channel="1.75.0" data-search-js="search-8fbf244ebcf71464.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-9dd44ab47b99a0fb.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="icon" href="https://use.ink/crate-docs/favicon.png"></head><body class="rustdoc attr"><!--[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">&#9776;</button><a class="logo-container" href="../ink/index.html"><img src="https://use.ink/img/crate-docs/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../ink/index.html"><img src="https://use.ink/img/crate-docs/logo.png" alt="logo"></a><h2><a href="../ink/index.html">ink</a><span class="version">5.0.0-rc.2</span></h2></div><div class="sidebar-elems"></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>Attribute Macro <a href="index.html">ink</a>::<wbr><a class="attr" href="#">event</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"><button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>#[event]</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Implements the necessary traits for a <code>struct</code> to be emitted as an event from a
contract.</p>
<p>By default, a signature topic will be generated for the event. This allows consumers
to filter and identify events of this type. Marking an event with <code>anonymous = true</code>
to filter and identify events of this type. Marking an event with <code>anonymous</code>
means no signature topic will be generated or emitted.
Custom signature topic can be specified with <code>signature_topic = &lt;32 byte hex string&gt;</code>.</p>
<p><code>signature_topic</code> and <code>anonymous</code> are conflicting arguments.</p>
Expand All @@ -13,8 +13,8 @@ <h2 id="examples"><a href="#examples">Examples</a></h2>
</span><span class="kw">pub </span>topic: [u8; <span class="number">32</span>],
}

<span class="comment">// Setting `anonymous = true` means no signature topic will be emitted for the event.
</span><span class="attr">#[ink::event(anonymous = <span class="bool-val">true</span>)]
<span class="comment">// Setting `anonymous` means no signature topic will be emitted for the event.
</span><span class="attr">#[ink::event(anonymous)]
</span><span class="kw">pub struct </span>MyAnonEvent {
<span class="kw">pub </span>field: u32,
<span class="attr">#[ink(topic)]
Expand Down
13 changes: 8 additions & 5 deletions ink_ir/ast/enum.Meta.html

Large diffs are not rendered by default.

Loading

0 comments on commit cc07725

Please sign in to comment.