Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Documentation Bot committed Aug 1, 2024
1 parent 82352ab commit 77d7ee3
Show file tree
Hide file tree
Showing 226 changed files with 33,108 additions and 1 deletion.
104 changes: 104 additions & 0 deletions annotated.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EVMC: Class List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">EVMC
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('annotated.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">Class List</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceevmc.html" target="_self">evmc</a></td><td class="desc">EVMC C++ API - wrappers and bindings for C++ </td></tr>
<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc_1_1address.html" target="_self">address</a></td><td class="desc">The big-endian 160-bit hash suitable for keeping an Ethereum address </td></tr>
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc_1_1byte__traits.html" target="_self">byte_traits</a></td><td class="desc">The char traits for byte-like types </td></tr>
<tr id="row_0_2_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc_1_1bytes32.html" target="_self">bytes32</a></td><td class="desc">The fixed size array of 32 bytes for storing 256-bit EVM values </td></tr>
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc_1_1filter__iterator.html" target="_self">filter_iterator</a></td><td class="desc">The filter iterator adaptor creates a view of an iterator range in which some elements of the range are skipped </td></tr>
<tr id="row_0_4_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classevmc_1_1Host.html" target="_self">Host</a></td><td class="desc">Abstract class to be used by <a class="el" href="classevmc_1_1Host.html" title="Abstract class to be used by Host implementations.">Host</a> implementations </td></tr>
<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classevmc_1_1HostContext.html" target="_self">HostContext</a></td><td class="desc">Wrapper around EVMC host context / host interface </td></tr>
<tr id="row_0_6_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classevmc_1_1HostInterface.html" target="_self">HostInterface</a></td><td class="desc">The EVMC <a class="el" href="classevmc_1_1Host.html" title="Abstract class to be used by Host implementations.">Host</a> interface </td></tr>
<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc_1_1MockedAccount.html" target="_self">MockedAccount</a></td><td class="desc">Mocked account </td></tr>
<tr id="row_0_8_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_8_" class="arrow" onclick="toggleFolder('0_8_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classevmc_1_1MockedHost.html" target="_self">MockedHost</a></td><td class="desc">Mocked EVMC <a class="el" href="classevmc_1_1Host.html" title="Abstract class to be used by Host implementations.">Host</a> implementation </td></tr>
<tr id="row_0_8_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc_1_1MockedHost_1_1log__record.html" target="_self">log_record</a></td><td class="desc">LOG record </td></tr>
<tr id="row_0_9_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classevmc_1_1Result.html" target="_self">Result</a></td><td class="desc">The EVM code execution result. </td></tr>
<tr id="row_0_10_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc_1_1skip__space__iterator.html" target="_self">skip_space_iterator</a></td><td class="desc">The input filter iterator which skips whitespace characters from the base input iterator </td></tr>
<tr id="row_0_11_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc_1_1StorageValue.html" target="_self">StorageValue</a></td><td class="desc">Extended value (with original value and access flag) for account storage </td></tr>
<tr id="row_0_12_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classevmc_1_1VM.html" target="_self">VM</a></td><td class="desc">The <a class="el" href="classevmc_1_1VM.html" title="The VM instance.">VM</a> instance. </td></tr>
<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc__address.html" target="_self">evmc_address</a></td><td class="desc">Big-endian 160-bit hash suitable for keeping an Ethereum address </td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc__bytes32.html" target="_self">evmc_bytes32</a></td><td class="desc">The fixed size array of 32 bytes </td></tr>
<tr id="row_3_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc__host__context.html" target="_self">evmc_host_context</a></td><td class="desc">The opaque data type representing the Host execution context </td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc__host__interface.html" target="_self">evmc_host_interface</a></td><td class="desc">The Host interface </td></tr>
<tr id="row_5_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc__instruction__metrics.html" target="_self">evmc_instruction_metrics</a></td><td class="desc">Metrics for an EVM 1 instruction </td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc__message.html" target="_self">evmc_message</a></td><td class="desc">The message describing an EVM call, including a zero-depth calls from a transaction origin </td></tr>
<tr id="row_7_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc__result.html" target="_self">evmc_result</a></td><td class="desc">The EVM code execution result </td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="unionevmc__result__optional__storage.html" target="_self">evmc_result_optional_storage</a></td><td class="desc">The union representing <a class="el" href="structevmc__result.html" title="The EVM code execution result.">evmc_result</a> "optional storage" </td></tr>
<tr id="row_9_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc__tx__context.html" target="_self">evmc_tx_context</a></td><td class="desc">The transaction and block data for execution </td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc__tx__initcode.html" target="_self">evmc_tx_initcode</a></td><td class="desc">The hashed initcode used for TXCREATE instruction </td></tr>
<tr id="row_11_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structevmc__vm.html" target="_self">evmc_vm</a></td><td class="desc">The VM instance </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Thu Aug 1 2024 17:35:31 for EVMC by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
</ul>
</div>
</body>
</html>
29 changes: 29 additions & 0 deletions annotated_dup.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
var annotated_dup =
[
[ "evmc", "namespaceevmc.html", [
[ "address", "structevmc_1_1address.html", "structevmc_1_1address" ],
[ "byte_traits", "structevmc_1_1byte__traits.html", "structevmc_1_1byte__traits" ],
[ "bytes32", "structevmc_1_1bytes32.html", "structevmc_1_1bytes32" ],
[ "filter_iterator", "structevmc_1_1filter__iterator.html", "structevmc_1_1filter__iterator" ],
[ "Host", "classevmc_1_1Host.html", "classevmc_1_1Host" ],
[ "HostContext", "classevmc_1_1HostContext.html", "classevmc_1_1HostContext" ],
[ "HostInterface", "classevmc_1_1HostInterface.html", "classevmc_1_1HostInterface" ],
[ "MockedAccount", "structevmc_1_1MockedAccount.html", "structevmc_1_1MockedAccount" ],
[ "MockedHost", "classevmc_1_1MockedHost.html", "classevmc_1_1MockedHost" ],
[ "Result", "classevmc_1_1Result.html", "classevmc_1_1Result" ],
[ "skip_space_iterator", "structevmc_1_1skip__space__iterator.html", null ],
[ "StorageValue", "structevmc_1_1StorageValue.html", "structevmc_1_1StorageValue" ],
[ "VM", "classevmc_1_1VM.html", "classevmc_1_1VM" ]
] ],
[ "evmc_address", "structevmc__address.html", "structevmc__address" ],
[ "evmc_bytes32", "structevmc__bytes32.html", "structevmc__bytes32" ],
[ "evmc_host_context", "structevmc__host__context.html", null ],
[ "evmc_host_interface", "structevmc__host__interface.html", "structevmc__host__interface" ],
[ "evmc_instruction_metrics", "structevmc__instruction__metrics.html", "structevmc__instruction__metrics" ],
[ "evmc_message", "structevmc__message.html", "structevmc__message" ],
[ "evmc_result", "structevmc__result.html", "structevmc__result" ],
[ "evmc_result_optional_storage", "unionevmc__result__optional__storage.html", "unionevmc__result__optional__storage" ],
[ "evmc_tx_context", "structevmc__tx__context.html", "structevmc__tx__context" ],
[ "evmc_tx_initcode", "structevmc__tx__initcode.html", "structevmc__tx__initcode" ],
[ "evmc_vm", "structevmc__vm.html", "structevmc__vm" ]
];
Binary file added bc_s.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added bc_sd.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added bdwn.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion bindings/rust/evmc-sys/evmc.h
View file

This file was deleted.

Loading

0 comments on commit 77d7ee3

Please sign in to comment.