1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
=================
Data Structures
=================
.. currentmodule:: pyfuse3
.. py:data:: ENOATTR
This errorcode is unfortunately missing in the `errno` module,
so it is provided by pyfuse3 instead.
.. py:data:: ROOT_INODE
The inode of the root directory, i.e. the mount point of the file
system.
.. py:data:: RENAME_EXCHANGE
A flag that may be passed to the `~Operations.rename` handler. When
passed, the handler must atomically exchange the two paths (which
must both exist).
.. py:data:: RENAME_NOREPLACE
A flag that may be passed to the `~Operations.rename` handler. When
passed, the handler must not replace an existing target.
.. py:data:: default_options
This is a recommended set of options that should be passed to
`pyfuse3.init` to get reasonable behavior and
performance. pyfuse3 is compatible with any other combination
of options as well, but you should only deviate from the defaults
with good reason.
(The :samp:`fsname=<foo>` option is guaranteed never to be included in the
default options, so you can always safely add it to the set).
The default options are:
* ``default_permissions`` enables permission checking by kernel.
Without this any umask (or uid/gid) would not have an effect.
.. autoexception:: FUSEError
.. autoclass currently doesn't work for NewTypes
.. https://github.com/sphinx-doc/sphinx/issues/11552
.. class:: FileHandleT
A subclass of `int`, representing an integer file handle produced by a
`~Operations.create`, `~Operations.open`, or `~Operations.opendir` call.
.. class:: FileNameT
A subclass of `bytes`, representing a file name, with no embedded
zero-bytes (``\0``).
.. class:: FlagT
A subclass of `int`, representing flags modifying the behavior of an
operation.
.. class:: InodeT
A subclass of `int`, representing an inode number.
.. class:: ModeT
A subclass of `int`, representing a file mode.
.. class:: XAttrNameT
A subclass of `bytes`, representing an extended attribute name, with no
embedded zero-bytes (``\0``).
.. autoclass:: RequestContext
.. attribute:: pid
.. attribute:: uid
.. attribute:: gid
.. attribute:: umask
.. autoclass:: StatvfsData
.. attribute:: f_bsize
.. attribute:: f_frsize
.. attribute:: f_blocks
.. attribute:: f_bfree
.. attribute:: f_bavail
.. attribute:: f_files
.. attribute:: f_ffree
.. attribute:: f_favail
.. attribute:: f_namemax
.. autoclass:: EntryAttributes
.. autoattribute:: st_ino
.. autoattribute:: generation
.. autoattribute:: entry_timeout
.. autoattribute:: attr_timeout
.. autoattribute:: st_mode
.. autoattribute:: st_nlink
.. autoattribute:: st_uid
.. autoattribute:: st_gid
.. autoattribute:: st_rdev
.. autoattribute:: st_size
.. autoattribute:: st_blksize
.. autoattribute:: st_blocks
.. autoattribute:: st_atime_ns
.. autoattribute:: st_ctime_ns
.. autoattribute:: st_mtime_ns
.. autoclass:: FileInfo
.. autoattribute:: fh
This attribute must be set to the file handle to be returned from
`Operations.open`.
.. autoattribute:: direct_io
If true, signals to the kernel that this file should not be cached
or buffered.
.. autoattribute:: keep_cache
If true, signals to the kernel that previously cached data for this
inode is still valid, and should not be invalidated.
.. autoattribute:: nonseekable
If true, indicates that the file does not support seeking.
.. autoclass:: SetattrFields
.. attribute:: update_atime
If this attribute is true, it signals the `Operations.setattr`
method that the `~EntryAttributes.st_atime_ns` field contains an
updated value.
.. attribute:: update_mtime
If this attribute is true, it signals the `Operations.setattr`
method that the `~EntryAttributes.st_mtime_ns` field contains an
updated value.
.. attribute:: update_mode
If this attribute is true, it signals the `Operations.setattr`
method that the `~EntryAttributes.st_mode` field contains an
updated value.
.. attribute:: update_uid
If this attribute is true, it signals the `Operations.setattr`
method that the `~EntryAttributes.st_uid` field contains an
updated value.
.. attribute:: update_gid
If this attribute is true, it signals the `Operations.setattr`
method that the `~EntryAttributes.st_gid` field contains an
updated value.
.. attribute:: update_size
If this attribute is true, it signals the `Operations.setattr`
method that the `~EntryAttributes.st_size` field contains an
updated value.
.. autoclass:: ReaddirToken
An identifier for a particular `~Operations.readdir` invocation.
|
