mirror of
https://github.com/fluencelabs/wasmer
synced 2025-05-18 21:21:19 +00:00
23 lines
10 KiB
HTML
23 lines
10 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="API documentation for the Rust `state` mod in crate `wasmer_wasi`."><meta name="keywords" content="rust, rustlang, rust-lang, state"><title>wasmer_wasi::state - 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">☰</div><a href='../../wasmer_wasi/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 state</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>wasmer_wasi</a></p><script>window.sidebarCurrent = {name: 'state', 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'>−</span>]</a></span><a class='srclink' href='../../src/wasmer_wasi/state/mod.rs.html#1-976' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>wasmer_wasi</a>::<wbr><a class="mod" href=''>state</a></span></h1><div class='docblock'><p>WARNING: the API exposed here is unstable and very experimental. Certain things are not ready
|
|||
|
|
yet and may be broken in patch releases. If you're using this and have any specific needs,
|
|||
|
|
please let us know here https://github.com/wasmerio/wasmer/issues/583 or by filing an issue.</p>
|
|||
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|||
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.Fd.html" title='wasmer_wasi::state::Fd struct'>Fd</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.HostFile.html" title='wasmer_wasi::state::HostFile struct'>HostFile</a></td><td class='docblock-short'><p>A thin wrapper around <code>std::fs::File</code></p>
|
|||
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Inode.html" title='wasmer_wasi::state::Inode struct'>Inode</a></td><td class='docblock-short'><p>An index (and generation) into an <code>Arena</code>.</p>
|
|||
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.InodeVal.html" title='wasmer_wasi::state::InodeVal struct'>InodeVal</a></td><td class='docblock-short'><p>A file that Wasi knows about that may or may not be open</p>
|
|||
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.PollEventBuilder.html" title='wasmer_wasi::state::PollEventBuilder struct'>PollEventBuilder</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.PollEventIter.html" title='wasmer_wasi::state::PollEventIter struct'>PollEventIter</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Stderr.html" title='wasmer_wasi::state::Stderr struct'>Stderr</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Stdin.html" title='wasmer_wasi::state::Stdin struct'>Stdin</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Stdout.html" title='wasmer_wasi::state::Stdout struct'>Stdout</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.WasiFs.html" title='wasmer_wasi::state::WasiFs struct'>WasiFs</a></td><td class='docblock-short'><p>Warning, modifying these fields directly may cause invariants to break and
|
|||
|
|
should be considered unsafe. These fields may be made private in a future release</p>
|
|||
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.WasiState.html" title='wasmer_wasi::state::WasiState struct'>WasiState</a></td><td class='docblock-short'></td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|||
|
|
<table><tr class='module-item'><td><a class="enum" href="enum.Kind.html" title='wasmer_wasi::state::Kind enum'>Kind</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.PollEvent.html" title='wasmer_wasi::state::PollEvent enum'>PollEvent</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.WasiFsError.html" title='wasmer_wasi::state::WasiFsError enum'>WasiFsError</a></td><td class='docblock-short'><p>Error type for external users</p>
|
|||
|
|
</td></tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
|
|||
|
|
<table><tr class='module-item'><td><a class="constant" href="constant.ALL_RIGHTS.html" title='wasmer_wasi::state::ALL_RIGHTS constant'>ALL_RIGHTS</a></td><td class='docblock-short'><p>all the rights enabled</p>
|
|||
|
|
</td></tr><tr class='module-item'><td><a class="constant" href="constant.MAX_SYMLINKS.html" title='wasmer_wasi::state::MAX_SYMLINKS constant'>MAX_SYMLINKS</a></td><td class='docblock-short'><p>A completely aribtrary "big enough" number used as the upper limit for
|
|||
|
|
the number of symlinks that can be traversed when resolving a path</p>
|
|||
|
|
</td></tr><tr class='module-item'><td><a class="constant" href="constant.VIRTUAL_ROOT_FD.html" title='wasmer_wasi::state::VIRTUAL_ROOT_FD constant'>VIRTUAL_ROOT_FD</a></td><td class='docblock-short'><p>the fd value of the virtual root</p>
|
|||
|
|
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|||
|
|
<table><tr class='module-item'><td><a class="trait" href="trait.WasiFile.html" title='wasmer_wasi::state::WasiFile trait'>WasiFile</a></td><td class='docblock-short'><p>This trait relies on your file closing when it goes out of scope via <code>Drop</code></p>
|
|||
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.WasiPath.html" title='wasmer_wasi::state::WasiPath trait'>WasiPath</a></td><td class='docblock-short'></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_wasi_state.html" title='wasmer_wasi::state::get_wasi_state fn'>get_wasi_state</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'><p>Get WasiState from a Ctx
|
|||
|
|
This function is unsafe because it must be called on a WASI Ctx</p>
|
|||
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.host_file_type_to_wasi_file_type.html" title='wasmer_wasi::state::host_file_type_to_wasi_file_type fn'>host_file_type_to_wasi_file_type</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.iterate_poll_events.html" title='wasmer_wasi::state::iterate_poll_events fn'>iterate_poll_events</a></td><td class='docblock-short'></td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
|||
|
|
<table><tr class='module-item'><td><a class="type" href="type.PollEventSet.html" title='wasmer_wasi::state::PollEventSet type'>PollEventSet</a></td><td class='docblock-short'></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>⏎</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_wasi";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|