| Current File : //proc/thread-self/root/usr/share/doc/python3-llfuse/html/data.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Data Structures — Python-LLFUSE 1.3.6 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.3.6',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="Python-LLFUSE 1.3.6 documentation" href="index.html" />
<link rel="next" title="The global lock" href="lock.html" />
<link rel="prev" title="FUSE API Functions" href="fuse_api.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="lock.html" title="The global lock"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="fuse_api.html" title="FUSE API Functions"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Python-LLFUSE 1.3.6 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="data-structures">
<h1>Data Structures<a class="headerlink" href="#data-structures" title="Permalink to this headline">¶</a></h1>
<dl class="data">
<dt id="llfuse.ENOATTR">
<code class="descclassname">llfuse.</code><code class="descname">ENOATTR</code><a class="headerlink" href="#llfuse.ENOATTR" title="Permalink to this definition">¶</a></dt>
<dd><p>This errorcode is unfortunately missing in the <a class="reference external" href="https://docs.python.org/3/library/errno.html#module-errno" title="(in Python v3.7)"><code class="xref py py-obj docutils literal"><span class="pre">errno</span></code></a> module,
so it is provided by Python-LLFUSE instead.</p>
</dd></dl>
<dl class="data">
<dt id="llfuse.ROOT_INODE">
<code class="descclassname">llfuse.</code><code class="descname">ROOT_INODE</code><a class="headerlink" href="#llfuse.ROOT_INODE" title="Permalink to this definition">¶</a></dt>
<dd><p>The inode of the root directory, i.e. the mount point of the file
system.</p>
</dd></dl>
<dl class="data">
<dt id="llfuse.default_options">
<code class="descclassname">llfuse.</code><code class="descname">default_options</code><a class="headerlink" href="#llfuse.default_options" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a recommended set of options that should be passed to
<a class="reference internal" href="fuse_api.html#llfuse.init" title="llfuse.init"><code class="xref py py-obj docutils literal"><span class="pre">llfuse.init</span></code></a> to get reasonable behavior and
performance. Python-LLFUSE is compatible with any other combination
of options as well, but you should only deviate from the defaults
with good reason.</p>
<p>(The <code class="samp docutils literal"><span class="pre">fsname=<foo></span></code> option is guaranteed never to be included in the
default options, so you can always safely add it to the set).</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.42.</span></p>
</div>
</dd></dl>
<dl class="exception">
<dt id="llfuse.FUSEError">
<em class="property">exception </em><code class="descclassname">llfuse.</code><code class="descname">FUSEError</code><a class="headerlink" href="#llfuse.FUSEError" title="Permalink to this definition">¶</a></dt>
<dd><p>This exception may be raised by request handlers to indicate that
the requested operation could not be carried out. The system call
that resulted in the request (if any) will then fail with error
code <em>errno_</em>.</p>
</dd></dl>
<dl class="class">
<dt id="llfuse.RequestContext">
<em class="property">class </em><code class="descclassname">llfuse.</code><code class="descname">RequestContext</code><a class="headerlink" href="#llfuse.RequestContext" title="Permalink to this definition">¶</a></dt>
<dd><p>Instances of this class are passed to some <a class="reference internal" href="operations.html#llfuse.Operations" title="llfuse.Operations"><code class="xref py py-obj docutils literal"><span class="pre">Operations</span></code></a> methods to
provide information about the caller of the syscall that initiated
the request.</p>
<dl class="attribute">
<dt id="llfuse.RequestContext.pid">
<code class="descname">pid</code><a class="headerlink" href="#llfuse.RequestContext.pid" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.RequestContext.uid">
<code class="descname">uid</code><a class="headerlink" href="#llfuse.RequestContext.uid" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.RequestContext.gid">
<code class="descname">gid</code><a class="headerlink" href="#llfuse.RequestContext.gid" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.RequestContext.umask">
<code class="descname">umask</code><a class="headerlink" href="#llfuse.RequestContext.umask" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="llfuse.StatvfsData">
<em class="property">class </em><code class="descclassname">llfuse.</code><code class="descname">StatvfsData</code><a class="headerlink" href="#llfuse.StatvfsData" title="Permalink to this definition">¶</a></dt>
<dd><p>Instances of this class store information about the file system.
The attributes correspond to the elements of the <code class="docutils literal"><span class="pre">statvfs</span></code>
struct, see <em class="manpage">statvfs(2)</em> for details.</p>
<dl class="attribute">
<dt id="llfuse.StatvfsData.f_bsize">
<code class="descname">f_bsize</code><a class="headerlink" href="#llfuse.StatvfsData.f_bsize" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.StatvfsData.f_frsize">
<code class="descname">f_frsize</code><a class="headerlink" href="#llfuse.StatvfsData.f_frsize" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.StatvfsData.f_blocks">
<code class="descname">f_blocks</code><a class="headerlink" href="#llfuse.StatvfsData.f_blocks" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.StatvfsData.f_bfree">
<code class="descname">f_bfree</code><a class="headerlink" href="#llfuse.StatvfsData.f_bfree" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.StatvfsData.f_bavail">
<code class="descname">f_bavail</code><a class="headerlink" href="#llfuse.StatvfsData.f_bavail" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.StatvfsData.f_files">
<code class="descname">f_files</code><a class="headerlink" href="#llfuse.StatvfsData.f_files" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.StatvfsData.f_ffree">
<code class="descname">f_ffree</code><a class="headerlink" href="#llfuse.StatvfsData.f_ffree" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.StatvfsData.f_favail">
<code class="descname">f_favail</code><a class="headerlink" href="#llfuse.StatvfsData.f_favail" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.StatvfsData.f_namemax">
<code class="descname">f_namemax</code><a class="headerlink" href="#llfuse.StatvfsData.f_namemax" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="llfuse.EntryAttributes">
<em class="property">class </em><code class="descclassname">llfuse.</code><code class="descname">EntryAttributes</code><a class="headerlink" href="#llfuse.EntryAttributes" title="Permalink to this definition">¶</a></dt>
<dd><p>Instances of this class store attributes of directory entries.
Most of the attributes correspond to the elements of the <code class="docutils literal"><span class="pre">stat</span></code>
C struct as returned by e.g. <code class="docutils literal"><span class="pre">fstat</span></code> and should be
self-explanatory.</p>
<dl class="attribute">
<dt id="llfuse.EntryAttributes.st_ino">
<code class="descname">st_ino</code><a class="headerlink" href="#llfuse.EntryAttributes.st_ino" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.EntryAttributes.generation">
<code class="descname">generation</code><a class="headerlink" href="#llfuse.EntryAttributes.generation" title="Permalink to this definition">¶</a></dt>
<dd><p>The inode generation number</p>
</dd></dl>
<dl class="attribute">
<dt id="llfuse.EntryAttributes.entry_timeout">
<code class="descname">entry_timeout</code><a class="headerlink" href="#llfuse.EntryAttributes.entry_timeout" title="Permalink to this definition">¶</a></dt>
<dd><p>Validity timeout for the name/existence of the directory entry</p>
<p>Floating point numbers may be used. Units are seconds.</p>
</dd></dl>
<dl class="attribute">
<dt id="llfuse.EntryAttributes.attr_timeout">
<code class="descname">attr_timeout</code><a class="headerlink" href="#llfuse.EntryAttributes.attr_timeout" title="Permalink to this definition">¶</a></dt>
<dd><p>Validity timeout for the attributes of the directory entry</p>
<p>Floating point numbers may be used. Units are seconds.</p>
</dd></dl>
<dl class="attribute">
<dt id="llfuse.EntryAttributes.st_mode">
<code class="descname">st_mode</code><a class="headerlink" href="#llfuse.EntryAttributes.st_mode" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.EntryAttributes.st_nlink">
<code class="descname">st_nlink</code><a class="headerlink" href="#llfuse.EntryAttributes.st_nlink" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.EntryAttributes.st_uid">
<code class="descname">st_uid</code><a class="headerlink" href="#llfuse.EntryAttributes.st_uid" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.EntryAttributes.st_gid">
<code class="descname">st_gid</code><a class="headerlink" href="#llfuse.EntryAttributes.st_gid" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.EntryAttributes.st_rdev">
<code class="descname">st_rdev</code><a class="headerlink" href="#llfuse.EntryAttributes.st_rdev" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.EntryAttributes.st_size">
<code class="descname">st_size</code><a class="headerlink" href="#llfuse.EntryAttributes.st_size" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.EntryAttributes.st_blksize">
<code class="descname">st_blksize</code><a class="headerlink" href="#llfuse.EntryAttributes.st_blksize" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.EntryAttributes.st_blocks">
<code class="descname">st_blocks</code><a class="headerlink" href="#llfuse.EntryAttributes.st_blocks" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="llfuse.EntryAttributes.st_atime_ns">
<code class="descname">st_atime_ns</code><a class="headerlink" href="#llfuse.EntryAttributes.st_atime_ns" title="Permalink to this definition">¶</a></dt>
<dd><p>Time of last access in (integer) nanoseconds</p>
</dd></dl>
<dl class="attribute">
<dt id="llfuse.EntryAttributes.st_ctime_ns">
<code class="descname">st_ctime_ns</code><a class="headerlink" href="#llfuse.EntryAttributes.st_ctime_ns" title="Permalink to this definition">¶</a></dt>
<dd><p>Time of last inode modification in (integer) nanoseconds</p>
</dd></dl>
<dl class="attribute">
<dt id="llfuse.EntryAttributes.st_mtime_ns">
<code class="descname">st_mtime_ns</code><a class="headerlink" href="#llfuse.EntryAttributes.st_mtime_ns" title="Permalink to this definition">¶</a></dt>
<dd><p>Time of last modification in (integer) nanoseconds</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="llfuse.SetattrFields">
<em class="property">class </em><code class="descclassname">llfuse.</code><code class="descname">SetattrFields</code><a class="headerlink" href="#llfuse.SetattrFields" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference internal" href="#llfuse.SetattrFields" title="llfuse.SetattrFields"><code class="xref py py-obj docutils literal"><span class="pre">SetattrFields</span></code></a> instances are passed to the <a class="reference internal" href="operations.html#llfuse.Operations.setattr" title="llfuse.Operations.setattr"><code class="xref py py-obj docutils literal"><span class="pre">setattr</span></code></a> handler
to specify which attributes should be updated.</p>
<dl class="attribute">
<dt id="llfuse.SetattrFields.update_atime">
<code class="descname">update_atime</code><a class="headerlink" href="#llfuse.SetattrFields.update_atime" title="Permalink to this definition">¶</a></dt>
<dd><p>If this attribute is true, it signals the <a class="reference internal" href="operations.html#llfuse.Operations.setattr" title="llfuse.Operations.setattr"><code class="xref py py-obj docutils literal"><span class="pre">Operations.setattr</span></code></a>
method that the <a class="reference internal" href="#llfuse.EntryAttributes.st_atime_ns" title="llfuse.EntryAttributes.st_atime_ns"><code class="xref py py-obj docutils literal"><span class="pre">st_atime_ns</span></code></a> field contains an
updated value.</p>
</dd></dl>
<dl class="attribute">
<dt id="llfuse.SetattrFields.update_mtime">
<code class="descname">update_mtime</code><a class="headerlink" href="#llfuse.SetattrFields.update_mtime" title="Permalink to this definition">¶</a></dt>
<dd><p>If this attribute is true, it signals the <a class="reference internal" href="operations.html#llfuse.Operations.setattr" title="llfuse.Operations.setattr"><code class="xref py py-obj docutils literal"><span class="pre">Operations.setattr</span></code></a>
method that the <a class="reference internal" href="#llfuse.EntryAttributes.st_mtime_ns" title="llfuse.EntryAttributes.st_mtime_ns"><code class="xref py py-obj docutils literal"><span class="pre">st_mtime_ns</span></code></a> field contains an
updated value.</p>
</dd></dl>
<dl class="attribute">
<dt id="llfuse.SetattrFields.update_mode">
<code class="descname">update_mode</code><a class="headerlink" href="#llfuse.SetattrFields.update_mode" title="Permalink to this definition">¶</a></dt>
<dd><p>If this attribute is true, it signals the <a class="reference internal" href="operations.html#llfuse.Operations.setattr" title="llfuse.Operations.setattr"><code class="xref py py-obj docutils literal"><span class="pre">Operations.setattr</span></code></a>
method that the <a class="reference internal" href="#llfuse.EntryAttributes.st_mode" title="llfuse.EntryAttributes.st_mode"><code class="xref py py-obj docutils literal"><span class="pre">st_mode</span></code></a> field contains an
updated value.</p>
</dd></dl>
<dl class="attribute">
<dt id="llfuse.SetattrFields.update_uid">
<code class="descname">update_uid</code><a class="headerlink" href="#llfuse.SetattrFields.update_uid" title="Permalink to this definition">¶</a></dt>
<dd><p>If this attribute is true, it signals the <a class="reference internal" href="operations.html#llfuse.Operations.setattr" title="llfuse.Operations.setattr"><code class="xref py py-obj docutils literal"><span class="pre">Operations.setattr</span></code></a>
method that the <a class="reference internal" href="#llfuse.EntryAttributes.st_uid" title="llfuse.EntryAttributes.st_uid"><code class="xref py py-obj docutils literal"><span class="pre">st_uid</span></code></a> field contains an
updated value.</p>
</dd></dl>
<dl class="attribute">
<dt id="llfuse.SetattrFields.update_gid">
<code class="descname">update_gid</code><a class="headerlink" href="#llfuse.SetattrFields.update_gid" title="Permalink to this definition">¶</a></dt>
<dd><p>If this attribute is true, it signals the <a class="reference internal" href="operations.html#llfuse.Operations.setattr" title="llfuse.Operations.setattr"><code class="xref py py-obj docutils literal"><span class="pre">Operations.setattr</span></code></a>
method that the <a class="reference internal" href="#llfuse.EntryAttributes.st_gid" title="llfuse.EntryAttributes.st_gid"><code class="xref py py-obj docutils literal"><span class="pre">st_gid</span></code></a> field contains an
updated value.</p>
</dd></dl>
<dl class="attribute">
<dt id="llfuse.SetattrFields.update_size">
<code class="descname">update_size</code><a class="headerlink" href="#llfuse.SetattrFields.update_size" title="Permalink to this definition">¶</a></dt>
<dd><p>If this attribute is true, it signals the <a class="reference internal" href="operations.html#llfuse.Operations.setattr" title="llfuse.Operations.setattr"><code class="xref py py-obj docutils literal"><span class="pre">Operations.setattr</span></code></a>
method that the <a class="reference internal" href="#llfuse.EntryAttributes.st_size" title="llfuse.EntryAttributes.st_size"><code class="xref py py-obj docutils literal"><span class="pre">st_size</span></code></a> field contains an
updated value.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><h3><a href="index.html">Table Of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="general.html">General Information</a></li>
<li class="toctree-l1"><a class="reference internal" href="fuse_api.html">FUSE API Functions</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Data Structures</a></li>
<li class="toctree-l1"><a class="reference internal" href="lock.html">The global lock</a></li>
<li class="toctree-l1"><a class="reference internal" href="operations.html">Request Handlers</a></li>
<li class="toctree-l1"><a class="reference internal" href="util.html">Utility Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="gotchas.html">Common Gotchas</a></li>
<li class="toctree-l1"><a class="reference internal" href="example.html">Example File Systems</a></li>
<li class="toctree-l1"><a class="reference internal" href="changes.html">Changelog</a></li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="fuse_api.html"
title="previous chapter">FUSE API Functions</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="lock.html"
title="next chapter">The global lock</a></p>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="lock.html" title="The global lock"
>next</a> |</li>
<li class="right" >
<a href="fuse_api.html" title="FUSE API Functions"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Python-LLFUSE 1.3.6 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2010-2015, Nikolaus Rath.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.9.
</div>
</body>
</html>