10 lines
6.2 KiB
HTML
Raw Permalink Normal View History

2019-09-06 15:57:44 -07:00
<!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 `metering` mod in crate `wasmer_middleware_common`."><meta name="keywords" content="rust, rustlang, rust-lang, metering"><title>wasmer_middleware_common::metering - 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="https://wasmer.io/static/icons/favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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">&#9776;</div><a href='../../wasmer_middleware_common/index.html'><div class='logo-container'><img src='https://avatars3.githubusercontent.com/u/44205449?s=200&v=4' alt='logo'></div></a><p class='location'>Module metering</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>wasmer_middleware_common</a></p><script>window.sidebarCurrent = {name: 'metering', ty: 'mod', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/wasmer_middleware_common/metering.rs.html#1-130' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>wasmer_middleware_common</a>::<wbr><a class="mod" href=''>metering</a></span></h1><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.ExecutionLimitExceededError.html" title='wasmer_middleware_common::metering::ExecutionLimitExceededError struct'>ExecutionLimitExceededError</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Metering.html" title='wasmer_middleware_common::metering::Metering struct'>Metering</a></td><td class='docblock-short'><p>Metering is a compiler middleware that calculates the cost of WebAssembly instructions at compile
time and will count the cost of executed instructions at runtime. Within the Metering functionality,
this instruction cost is called <code>points</code>.</p>
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table><tr class='module-item'><td><a class="fn" href="fn.get_points_used.html" title='wasmer_middleware_common::metering::get_points_used fn'>get_points_used</a></td><td class='docblock-short'><p>Returns the number of points used by an Instance.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_points_used_ctx.html" title='wasmer_middleware_common::metering::get_points_used_ctx fn'>get_points_used_ctx</a></td><td class='docblock-short'><p>Returns the number of points used in a Ctx.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.set_points_used.html" title='wasmer_middleware_common::metering::set_points_used fn'>set_points_used</a></td><td class='docblock-short'><p>Sets the number of points used by an Instance.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.set_points_used_ctx.html" title='wasmer_middleware_common::metering::set_points_used_ctx fn'>set_points_used_ctx</a></td><td class='docblock-short'><p>Sets the number of points used in a Ctx.</p>
</td></tr></table></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>&#9166;</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 = "wasmer_middleware_common";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>