luo980/uvw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
gh-pages
uvw/structuvw_1_1fs__event.html
Michele Caini 273f6fe65e updated doc: v3.1.0
2023-05-22 11:13:58 +02:00

338 lines
17 KiB
HTML
Raw Permalink Blame History

<!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>uvw: uvw::fs_event Struct Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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">uvw<span id="projectnumber">&#160;3.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<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('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceuvw.html">uvw</a></li><li class="navelem"><a class="el" href="structuvw_1_1fs__event.html">fs_event</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structuvw_1_1fs__event-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">uvw::fs_event Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Common fs event.
<a href="structuvw_1_1fs__event.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="fs_8h_source.html">fs.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aba6a074fbe67e23eb320fa916f10a2ea"><td class="memItemLeft" align="right" valign="top">fs_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1fs__event.html#aba6a074fbe67e23eb320fa916f10a2ea">type</a></td></tr>
<tr class="separator:aba6a074fbe67e23eb320fa916f10a2ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8360c0c11f32c8ddf1edfdc3808d2108"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1fs__event.html#a8360c0c11f32c8ddf1edfdc3808d2108">path</a></td></tr>
<tr class="separator:a8360c0c11f32c8ddf1edfdc3808d2108"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a268a71d07c15d81cb384a0657cb708ce"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1fs__event.html#a268a71d07c15d81cb384a0657cb708ce">result</a></td></tr>
<tr class="separator:a268a71d07c15d81cb384a0657cb708ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bdc7cb85d905420d20c9b9e8adab56d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceuvw.html#a7f8333af7e3de1e46417f57d930c636e">file_info</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1fs__event.html#a4bdc7cb85d905420d20c9b9e8adab56d">stat</a></td></tr>
<tr class="separator:a4bdc7cb85d905420d20c9b9e8adab56d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bffdfd4d1dbb0f019d8ed4c5e07cef6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceuvw.html#ae0ae6e7fc2c6760fd0c8311b62a1b8dd">fs_info</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1fs__event.html#a5bffdfd4d1dbb0f019d8ed4c5e07cef6">statfs</a></td></tr>
<tr class="separator:a5bffdfd4d1dbb0f019d8ed4c5e07cef6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a875f46b4b423cf1a07d7b88fd47450b3"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; const char[]&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1fs__event.html#a875f46b4b423cf1a07d7b88fd47450b3">data</a></td></tr>
<tr class="separator:a875f46b4b423cf1a07d7b88fd47450b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9a38d48b4d30f3ad3c2b3d227182465"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1fs__event.html#ac9a38d48b4d30f3ad3c2b3d227182465">data</a></td></tr>
<tr class="separator:ac9a38d48b4d30f3ad3c2b3d227182465"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d208a113e76c46fda4c6ed58bb9fb69"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1fs__event.html#a5d208a113e76c46fda4c6ed58bb9fb69">name</a></td></tr>
<tr class="separator:a5d208a113e76c46fda4c6ed58bb9fb69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a12e3b532a77c7ef9a2f72b64601cf4"><td class="memItemLeft" align="right" valign="top">entry_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1fs__event.html#a9a12e3b532a77c7ef9a2f72b64601cf4">type</a></td></tr>
<tr class="separator:a9a12e3b532a77c7ef9a2f72b64601cf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95c2cf7fe72fa263a8d36bbc9ea45d44"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1fs__event.html#a95c2cf7fe72fa263a8d36bbc9ea45d44">eos</a></td></tr>
<tr class="separator:a95c2cf7fe72fa263a8d36bbc9ea45d44"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Common fs event. </p>
<p>Available types are:</p>
<ul>
<li><code>fs_request::fs_type::UNKNOWN</code></li>
<li><code>fs_request::fs_type::CUSTOM</code></li>
<li><code>fs_request::fs_type::OPEN</code></li>
<li><code>fs_request::fs_type::CLOSE</code></li>
<li><code>fs_request::fs_type::READ</code></li>
<li><code>fs_request::fs_type::WRITE</code></li>
<li><code>fs_request::fs_type::SENDFILE</code></li>
<li><code>fs_request::fs_type::STAT</code></li>
<li><code>fs_request::fs_type::LSTAT</code></li>
<li><code>fs_request::fs_type::FSTAT</code></li>
<li><code>fs_request::fs_type::FTRUNCATE</code></li>
<li><code>fs_request::fs_type::UTIME</code></li>
<li><code>fs_request::fs_type::FUTIME</code></li>
<li><code>fs_request::fs_type::ACCESS</code></li>
<li><code>fs_request::fs_type::CHMOD</code></li>
<li><code>fs_request::fs_type::FCHMOD</code></li>
<li><code>fs_request::fs_type::FSYNC</code></li>
<li><code>fs_request::fs_type::FDATASYNC</code></li>
<li><code>fs_request::fs_type::UNLINK</code></li>
<li><code>fs_request::fs_type::RMDIR</code></li>
<li><code>fs_request::fs_type::MKDIR</code></li>
<li><code>fs_request::fs_type::MKDTEMP</code></li>
<li><code>fs_request::fs_type::RENAME</code></li>
<li><code>fs_request::fs_type::SCANDIR</code></li>
<li><code>fs_request::fs_type::LINK</code></li>
<li><code>fs_request::fs_type::SYMLINK</code></li>
<li><code>fs_request::fs_type::READLINK</code></li>
<li><code>fs_request::fs_type::CHOWN</code></li>
<li><code>fs_request::fs_type::FCHOWN</code></li>
<li><code>fs_request::fs_type::REALPATH</code></li>
<li><code>fs_request::fs_type::COPYFILE</code></li>
<li><code>fs_request::fs_type::LCHOWN</code></li>
<li><code>fs_request::fs_type::OPENDIR</code></li>
<li><code>fs_request::fs_type::READDIR</code></li>
<li><code>fs_request::fs_type::CLOSEDIR</code></li>
<li><code>fs_request::fs_type::STATFS</code></li>
<li><code>fs_request::fs_type::MKSTEMP</code></li>
<li><code>fs_request::fs_type::LUTIME</code></li>
</ul>
<p>See the official <a href="http://docs.libuv.org/en/v1.x/fs.html#c.uv_fs_type">documentation</a> for further details. </p>
<p class="definition">Definition at line <a class="el" href="fs_8h_source.html#l00160">160</a> of file <a class="el" href="fs_8h_source.html">fs.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a875f46b4b423cf1a07d7b88fd47450b3" name="a875f46b4b423cf1a07d7b88fd47450b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a875f46b4b423cf1a07d7b88fd47450b3">&#9670;&#160;</a></span>data <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt;const char[]&gt; uvw::fs_event::data</td>
</tr>
</table>
</div><div class="memdoc">
<p>A bunch of data read from the given path. </p>
<p class="definition">Definition at line <a class="el" href="fs_8h_source.html#l00201">201</a> of file <a class="el" href="fs_8h_source.html">fs.h</a>.</p>
</div>
</div>
<a id="ac9a38d48b4d30f3ad3c2b3d227182465" name="ac9a38d48b4d30f3ad3c2b3d227182465"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9a38d48b4d30f3ad3c2b3d227182465">&#9670;&#160;</a></span>data <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* uvw::fs_event::data</td>
</tr>
</table>
</div><div class="memdoc">
<p>The content of a symbolic link. </p>
<p class="definition">Definition at line <a class="el" href="fs_8h_source.html#l00205">205</a> of file <a class="el" href="fs_8h_source.html">fs.h</a>.</p>
</div>
</div>
<a id="a95c2cf7fe72fa263a8d36bbc9ea45d44" name="a95c2cf7fe72fa263a8d36bbc9ea45d44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95c2cf7fe72fa263a8d36bbc9ea45d44">&#9670;&#160;</a></span>eos</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool uvw::fs_event::eos</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if there a no more entries to read. </p>
<p class="definition">Definition at line <a class="el" href="fs_8h_source.html#l00214">214</a> of file <a class="el" href="fs_8h_source.html">fs.h</a>.</p>
</div>
</div>
<a id="a5d208a113e76c46fda4c6ed58bb9fb69" name="a5d208a113e76c46fda4c6ed58bb9fb69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d208a113e76c46fda4c6ed58bb9fb69">&#9670;&#160;</a></span>name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* uvw::fs_event::name</td>
</tr>
</table>
</div><div class="memdoc">
<p>The name of the last entry. </p>
<p class="definition">Definition at line <a class="el" href="fs_8h_source.html#l00212">212</a> of file <a class="el" href="fs_8h_source.html">fs.h</a>.</p>
</div>
</div>
<a id="a8360c0c11f32c8ddf1edfdc3808d2108" name="a8360c0c11f32c8ddf1edfdc3808d2108"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8360c0c11f32c8ddf1edfdc3808d2108">&#9670;&#160;</a></span>path</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* uvw::fs_event::path</td>
</tr>
</table>
</div><div class="memdoc">
<p>The path affecting the request. </p>
<p class="definition">Definition at line <a class="el" href="fs_8h_source.html#l00197">197</a> of file <a class="el" href="fs_8h_source.html">fs.h</a>.</p>
</div>
</div>
<a id="a268a71d07c15d81cb384a0657cb708ce" name="a268a71d07c15d81cb384a0657cb708ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a268a71d07c15d81cb384a0657cb708ce">&#9670;&#160;</a></span>result</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::size_t uvw::fs_event::result</td>
</tr>
</table>
</div><div class="memdoc">
<p>Result value for the specific type. </p>
<p class="definition">Definition at line <a class="el" href="fs_8h_source.html#l00198">198</a> of file <a class="el" href="fs_8h_source.html">fs.h</a>.</p>
</div>
</div>
<a id="a4bdc7cb85d905420d20c9b9e8adab56d" name="a4bdc7cb85d905420d20c9b9e8adab56d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bdc7cb85d905420d20c9b9e8adab56d">&#9670;&#160;</a></span>stat</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceuvw.html#a7f8333af7e3de1e46417f57d930c636e">file_info</a> uvw::fs_event::stat</td>
</tr>
</table>
</div><div class="memdoc">
<p>An initialized instance of file_info. </p>
<p class="definition">Definition at line <a class="el" href="fs_8h_source.html#l00208">208</a> of file <a class="el" href="fs_8h_source.html">fs.h</a>.</p>
</div>
</div>
<a id="a5bffdfd4d1dbb0f019d8ed4c5e07cef6" name="a5bffdfd4d1dbb0f019d8ed4c5e07cef6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bffdfd4d1dbb0f019d8ed4c5e07cef6">&#9670;&#160;</a></span>statfs</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceuvw.html#ae0ae6e7fc2c6760fd0c8311b62a1b8dd">fs_info</a> uvw::fs_event::statfs</td>
</tr>
</table>
</div><div class="memdoc">
<p>An initialized instance of fs_info. </p>
<p class="definition">Definition at line <a class="el" href="fs_8h_source.html#l00209">209</a> of file <a class="el" href="fs_8h_source.html">fs.h</a>.</p>
</div>
</div>
<a id="aba6a074fbe67e23eb320fa916f10a2ea" name="aba6a074fbe67e23eb320fa916f10a2ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba6a074fbe67e23eb320fa916f10a2ea">&#9670;&#160;</a></span>type <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">fs_type uvw::fs_event::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Actual event type. </p>
<p class="definition">Definition at line <a class="el" href="fs_8h_source.html#l00196">196</a> of file <a class="el" href="fs_8h_source.html">fs.h</a>.</p>
</div>
</div>
<a id="a9a12e3b532a77c7ef9a2f72b64601cf4" name="a9a12e3b532a77c7ef9a2f72b64601cf4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a12e3b532a77c7ef9a2f72b64601cf4">&#9670;&#160;</a></span>type <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">entry_type uvw::fs_event::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>The entry type. </p>
<p class="definition">Definition at line <a class="el" href="fs_8h_source.html#l00213">213</a> of file <a class="el" href="fs_8h_source.html">fs.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/uvw/<a class="el" href="fs_8h_source.html">fs.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink