FUSE Class

Properties   Methods   Events   Config Settings   Errors  

The FUSE class gives applications the ability to create a virtual filesystem using a FUSE-like API.

Syntax

class cbfsconnect.FUSE

Remarks

The FUSE class is used to create a virtual filesystem whose contents are stored and exposed in an application-defined manner. The FUSE class offers applications an API similar to the one used by the FUSE library on Linux.

Getting Started

Each FUSE class instance controls a single virtual filesystem, and therefore a single virtual drive. Applications can use multiple instances of the FUSE class if their use-case requires the creation of multiple virtual drives; the class's tag property can be used to distinguish between instances during event handlers.

Here's how to get up and running:

1. If the system driver has not been installed yet, call the install method to do so. This needs to be done only once.
   • In production, the system driver can be installed (or updated) ahead of time by the application's installation script using the Installer DLL (dynamic link library). Please refer to the Driver Installation topic for more information.
2. Call the initialize method to initialize the FUSE class. This must be done each time the application starts (if the application is using multiple FUSE class instances, only the first instance created should be used to call initialize).
3. Ensure that all of the necessary event handlers have been implemented. Some event handlers, such as on_open, on_read, on_get_attr, and on_read_dir, are mandatory and must be implemented by all applications (this is not an exhaustive list). Others are optional, and need to be implemented only when certain features are enabled. Please refer to the events' documentation for more information.
4. Create a virtual drive by calling the mount method. This operation incorporates several steps, such as creation of the virtual disk, mounting a "storage media" and adding a mounting point. A mounting point can be a drive letter, a universal naming convention (UNC) path, or a directory on an existing NTFS-formatted drive (see Mounting Points for details).
5. The application can unmount the "media" from the virtual drive using the unmount method.
6. To uninstall the system driver, call the uninstall method. This should not be done as part of the driver-upgrade process.
   • In production, the system driver can be uninstalled by the application's uninstallation script using the Installer DLL. Please refer to the Driver Installation topic for more information.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

access_denied_process_count Property

The number of records in the AccessDeniedProcess arrays.

Syntax

def get_access_denied_process_count() -> int: ...

access_denied_process_count = property(get_access_denied_process_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• access_denied_process_desired_access
• access_denied_process_id
• access_denied_process_include_children
• access_denied_process_name

The array indices start at 0 and end at access_denied_process_count - 1.

This property is read-only.

access_denied_process_desired_access Property

The kind of access granted or denied.

Syntax

def get_access_denied_process_desired_access(access_denied_process_index: int) -> int: ...

Default Value

0

Remarks

The kind of access granted or denied.

This property specifies what kind of access is granted or denied by the rule. Possible values are:

The access_denied_process_index parameter specifies the index of the item in the array. The size of the array is controlled by the access_denied_process_count property.

This property is read-only.

access_denied_process_include_children Property

Whether child processes are affected.

Syntax

def get_access_denied_process_include_children(access_denied_process_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether child processes are affected.

This property indicates whether the rule applies to children of the target process.

The access_denied_process_index parameter specifies the index of the item in the array. The size of the array is controlled by the access_denied_process_count property.

This property is read-only.

access_denied_process_id Property

The Id of the target process.

Syntax

def get_access_denied_process_id(access_denied_process_index: int) -> int: ...

Default Value

0

Remarks

The Id of the target process.

This property reflects the target process's Id (PID). Will be 0 if the target process was specified by access_denied_process_process_name, or -1 if the rule applies to all processes.

The access_denied_process_index parameter specifies the index of the item in the array. The size of the array is controlled by the access_denied_process_count property.

This property is read-only.

access_denied_process_name Property

The filename of the target process's executable.

Syntax

def get_access_denied_process_name(access_denied_process_index: int) -> str: ...

Default Value

""

Remarks

The filename of the target process's executable.

This property reflects the full file name of the target process's executable. Will be empty if the target process was specified by access_denied_process_process_id (or if the rule applies to all processes, in which case access_denied_process_process_id will be -1).

The access_denied_process_index parameter specifies the index of the item in the array. The size of the array is controlled by the access_denied_process_count property.

This property is read-only.

access_granted_process_count Property

The number of records in the AccessGrantedProcess arrays.

Syntax

def get_access_granted_process_count() -> int: ...

access_granted_process_count = property(get_access_granted_process_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• access_granted_process_desired_access
• access_granted_process_id
• access_granted_process_include_children
• access_granted_process_name

The array indices start at 0 and end at access_granted_process_count - 1.

This property is read-only.

access_granted_process_desired_access Property

The kind of access granted or denied.

Syntax

def get_access_granted_process_desired_access(access_granted_process_index: int) -> int: ...

Default Value

0

Remarks

The kind of access granted or denied.

This property specifies what kind of access is granted or denied by the rule. Possible values are:

The access_granted_process_index parameter specifies the index of the item in the array. The size of the array is controlled by the access_granted_process_count property.

This property is read-only.

access_granted_process_include_children Property

Whether child processes are affected.

Syntax

def get_access_granted_process_include_children(access_granted_process_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether child processes are affected.

This property indicates whether the rule applies to children of the target process.

The access_granted_process_index parameter specifies the index of the item in the array. The size of the array is controlled by the access_granted_process_count property.

This property is read-only.

access_granted_process_id Property

The Id of the target process.

Syntax

def get_access_granted_process_id(access_granted_process_index: int) -> int: ...

Default Value

0

Remarks

The Id of the target process.

This property reflects the target process's Id (PID). Will be 0 if the target process was specified by access_granted_process_process_name, or -1 if the rule applies to all processes.

The access_granted_process_index parameter specifies the index of the item in the array. The size of the array is controlled by the access_granted_process_count property.

This property is read-only.

access_granted_process_name Property

The filename of the target process's executable.

Syntax

def get_access_granted_process_name(access_granted_process_index: int) -> str: ...

Default Value

""

Remarks

The filename of the target process's executable.

This property reflects the full file name of the target process's executable. Will be empty if the target process was specified by access_granted_process_process_id (or if the rule applies to all processes, in which case access_granted_process_process_id will be -1).

The access_granted_process_index parameter specifies the index of the item in the array. The size of the array is controlled by the access_granted_process_count property.

This property is read-only.

process_restrictions_enabled Property

Whether process access restrictions are enabled.

Syntax

def get_process_restrictions_enabled() -> bool: ...
def set_process_restrictions_enabled(value: bool) -> None: ...

process_restrictions_enabled = property(get_process_restrictions_enabled, set_process_restrictions_enabled)

Default Value

FALSE

Remarks

This property controls whether the class should enforce per-process access restrictions; by default, it is disabled. When enabled, the add_granted_process and add_denied_process methods can be used to add process-specific access rules for the class to enforce across the entire virtual drive.

When an application enables this propery, it should use the add_granted_process method to add at least one pocess as allowed; otherwise, the data will be inaccessible.

The current process access rules are reflected by the AccessGrantedProcess* and AccessDeniedProcess* properties.

Note: The methods and properties related to process access lists are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of process access information occurs in a thread-safe manner.

serialize_events Property

Whether events should be fired on a single worker thread, or many.

Syntax

def get_serialize_events() -> int: ...
def set_serialize_events(value: int) -> None: ...

serialize_events = property(get_serialize_events, set_serialize_events)

Default Value

0

Remarks

This property specifies whether the class should fire all events serially on a single worker thread, or concurrently on multiple worker threads. The possible values are:

Windows: in general, the class will always fire events related to a single file sequentially (though not necessarily on the same worker thread all the time), regardless of how this property is set. Please refer to the Threading and Concurrency topic for more information.

Linux: with this property set to seOnMultipleThreads, the class may fire events related to the same file concurrently in several threads. If the application doesn't support this, it should stick to the seOnOneWorkerThread mode.

Note: This property cannot be changed when active is True, and it cannot be changed within events.

storage_characteristics Property

This property includes the characteristic flags with which to create the virtual drive (Windows only).

Syntax

def get_storage_characteristics() -> int: ...
def set_storage_characteristics(value: int) -> None: ...

storage_characteristics = property(get_storage_characteristics, set_storage_characteristics)

Default Value

16

Remarks

The system, as well as other applications, uses these flags to optimize their use of the virtual drive. This property should be set by ORing together zero or more of the following flags:

Note: This property cannot be changed when the drive is mounted and cannot be changed within events.

tag Property

This property stores application-defined data specific to a particular instance of the class.

Syntax

def get_tag() -> int: ...
def set_tag(value: int) -> None: ...

tag = property(get_tag, set_tag)

Default Value

0

Remarks

This property can be used to store data specific to a particular instance of the class.

add_denied_process Method

Adds a rule that prevents a process from accessing the virtual drive (Windows only).

Syntax

def add_denied_process(process_file_name: str, process_id: int, child_processes: bool, desired_access: int) -> None: ...

Remarks

When the process_restrictions_enabled property is enabled, this method can be used to add an access rule that denies the process specified by ProcessFileName or ProcessId the access right specified by DesiredAccess.

Processes that are already running can be specified by passing their process Id (PID) for the ProcessId parameter (in which case ProcessFileName should be empty). Processes that have not yet started can be specified by passing the full file name of the process's executable file for ProcessFileName (in which case ProcessId should be set to 0). If ProcessName is empty, and ProcessId is -1, the new rule will apply to all processes. When adding a PID-based rule, you need to be aware of the PID Reuse behavior of Windows.

ChildProcesses controls whether the rule also applies to children of the target process.

DesiredAccess specifies the access right to deny; valid values are:

To remove the process access rule later, pass the same ProcessFileName and ProcessId values to the remove_denied_process method.

Note: This method can be called only when active is True, and it cannot be called within events.

The methods and properties related to process access lists are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of process access information occurs in a thread-safe manner.

add_granted_process Method

Adds a rule that allows a process to access the virtual drive (Windows only).

Syntax

def add_granted_process(process_file_name: str, process_id: int, child_processes: bool, desired_access: int) -> None: ...

Remarks

When the process_restrictions_enabled property is enabled, this method can be used to add an access rule that grants the process specified by ProcessFileName or ProcessId the access right specified by DesiredAccess.

Processes that are already running can be specified by passing their process Id (PID) for the ProcessId parameter (in which case ProcessFileName should be empty). Processes that have not yet started can be specified by passing the full file name of the process's executable file for ProcessFileName (in which case ProcessId should be set to 0). If ProcessName is empty, and ProcessId is -1, the new rule will apply to all processes. When adding a PID-based rule, you need to be aware of the PID Reuse behavior of Windows.

ChildProcesses controls whether the rule also applies to children of the target process.

DesiredAccess specifies the access right to grant; valid values are:

To remove the process access rule later, pass the same ProcessFileName and ProcessId values to the remove_granted_process method.

Note: This method can be called only when active is True, and it cannot be called within events.

The methods and properties related to process access lists are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of process access information occurs in a thread-safe manner.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

file_time_to_nanoseconds Method

This method returns the subsecond part of the time expressed in nanoseconds.

Syntax

def file_time_to_nanoseconds(file_time: datetime.datetime) -> int: ...

Remarks

Use this method to obtain the subsecond part of the FileTime value, expressed in nanoseconds.

file_time_to_unix_time Method

This method converts FileTime to the Unix time format.

Syntax

def file_time_to_unix_time(file_time: datetime.datetime) -> int: ...

Remarks

Use this method to convert the FileTime value to the Unix time format. The subsecond part of the value is not preserved; to obtain it, use the file_time_to_nanoseconds method.

fill_dir Method

This method fills the buffer with information about a directory entry.

Syntax

def fill_dir(filler_context: int, name: str, ino: int, mode: int, uid: int, gid: int, link_count: int, size: int, a_time: datetime.datetime, m_time: datetime.datetime, c_time: datetime.datetime) -> int: ...

Remarks

Use the FillDir method from the on_read_dir event handler to fill the buffer with the information about a file.

Call the method in a loop to add multiple entries.

The FillerContext parameter is passed to the on_read_dir event handler and must be passed by the event handler to this method without modifications.

The Name parameter should contain the name of the directory entry.

The Ino parameter should be set to the Id of the file, which must be unique within a filesystem. Ino is optional on Windows and is ignored on Linux, where FUSE internally generates internal Ids.

The Mode parameter is a combination of bit flags.

Windows: Mode may include 0x4000 (S_IFDIR) to indicate that the entry is a directory, and it must include either 0x80 (S_IWUSR) to indicate a file that can be read and written or 0x100 (S_IRUSR) to indicate a read-only file. Other flags are ignored.

Linux: Mode may include any appropriate file mode flags. See inode(7) for more information.

Windows: The Uid, Gid, and LinkCount parameters are not used.

Linux: The Uid and Gid parameters must be set to the owner's user Id and group Id, respectively. LinkCount should be set to the number of hard links that the file has (which usually is 1).

Size must be set to the size of the file's data. For directories, the parameter should be set to 0.

ATime, MTime, CTime: Set, respectively, to the Access Time, Modification Time, and Creation Time values of the file or directory. All date/time parameters in the class are specified in UTC.

To convert Unix time to a format suitable for this function, use the unix_time_to_file_time method.

Windows:

Any nonapplicable time values can be set to January 1, 1970 00:00:00 UTC.

The method returns 0 on success and sends an error code otherwise.

Note: This method cannot be called within events.

get_driver_status Method

This method retrieves the status of the system driver.

Syntax

def get_driver_status(product_guid: str) -> int: ...

Remarks

Windows:

This method retrieves the status of the system driver. This status can then be used to verify whether it has been properly installed and is ready for use.

The value returned by the method corresponds to the dwCurrentState field of the SERVICE_STATUS structure from the Windows API. It will be one of the following:

ProductGUID is used to distinguish between driver installations performed by different applications. Such information is necessary to guard against unexpected situations such as, e.g., the driver being uninstalled by one application despite other applications still needing it.

The GUID must be specified in so-called "Registry Format" (e.g., "{1FAD0EF2-9A03-4B87-B4BC-645B7035ED90}") with curly braces included.

To ensure proper operation, it is critical that each individual application have its own unique ProductGUID value, and that applications (and their installation scripts) use that value when calling any of the following methods:

• install
• uninstall
• get_driver_status
• get_module_version
• register_icon
• unregister_icon
• initialize

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation topic for more information about the latter.

Note: This method cannot be called within events.

Linux:

This method currently is not used.

get_driver_version Method

This method retrieves the version of the system driver.

Syntax

def get_driver_version(product_guid: str) -> int: ...

Remarks

This method retrieves the version of the system driver. The value is returned as a 64-bit integer composed of four 16-bit words that each correspond to a piece of the overall module version. For example, a version of 2.32.6.28 would cause the value 0x000200200006001C to be returned.

If the driver is not installed, this method returns 0.

ProductGUID is used to distinguish between driver installations performed by different applications. Such information is necessary to guard against unexpected situations such as, e.g., the driver being uninstalled by one application despite other applications still needing it.

The GUID must be specified in so-called "Registry Format" (e.g., "{1FAD0EF2-9A03-4B87-B4BC-645B7035ED90}") with curly braces included.

To ensure proper operation, it is critical that each individual application have its own unique ProductGUID value, and that applications (and their installation scripts) use that value when calling any of the following methods:

• install
• uninstall
• get_driver_status
• get_module_version
• register_icon
• unregister_icon
• initialize

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation topic for more information about the latter.

Note: This method cannot be called within events.

get_gid Method

This method returns the group Id of the caller process.

Syntax

def get_gid() -> int: ...

Remarks

Windows:

This method currently is not used.

Linux:

Call this method from the event handlers to obtain the group Id of the caller process.

get_originator_process_id Method

Retrieves the Id of the process (PID) that initiated the operation (Windows only).

Syntax

def get_originator_process_id() -> int: ...

Remarks

This method can be called within certain events to retrieve the Id of the process (PID) that initiated the operation. If the query fails, this method returns 0.

Please note that PIDs are not unique, and may be reused by different processes over time (though in practice, this is uncommon).

Applications cannot use this method to retrieve information about remote processes accessing virtual drives shared on the network. Windows does not provide such information due to the nature of remote access.

Note: This method can be called only within events, and it must be called in the same thread that the event was originally fired on. However, it must not be called within events that work with opened files , such as on_read_file and on_write_file, since such events can be initiated by system components (e.g., the cache manager, memory manager, etc.). If applications need the information this method returns during such events, they may do the following:

1. Call this method within the on_create_file or on_open_file event.
2. Store the information somewhere, and store a reference to it in the event's HandleContext parameter.
3. In a later event, access the information via the reference stored in HandleContext.

Please refer to the Contexts topic for more information on how to use events' context parameters.

Note: Renaming and deletion of files is performed after the file is opened. Thus, access checks should be performed during file opening as described above.

get_originator_process_name Method

Retrieves the name of the process that initiated the operation (Windows only).

Syntax

def get_originator_process_name() -> str: ...

Remarks

This method can be called within certain events to retrieve the name of the process that initiated the operation. If the query fails, this method returns empty string.

Applications cannot use this method to retrieve information about remote processes accessing virtual drives shared on the network. Windows does not provide such information due to the nature of remote access.

Note: This method can be called only within events, and it must be called in the same thread that the event was originally fired on. However, it must not be called within events that work with opened files , such as on_read_file and on_write_file, since such events can be initiated by system components (e.g., the cache manager, memory manager, etc.). If applications need the information this method returns during such events, they may do the following:

1. Call this method within the on_create_file or on_open_file event.
2. Store the information somewhere, and store a reference to it in the event's HandleContext parameter.
3. In a later event, access the information via the reference stored in HandleContext.

Please refer to the Contexts topic for more information on how to use events' context parameters.

Note: Renaming and deletion of files is performed after the file is opened. Thus, access checks should be performed during file opening as described above.

get_originator_thread_id Method

Retrieves the Id of the thread that initiated the operation (Windows only).

Syntax

def get_originator_thread_id() -> int: ...

Remarks

This method can be called within certain events to retrieve the Id of the thread that initiated the operation. If the query fails, this method returns 0.

This method is available only in Windows.

Please note that thread Ids are not unique, and may be reused by different threads over time.

Note: This method can be called only within events, and it must be called in the same thread that the event was originally fired on. However, it must not be called within events that work with opened files , such as on_read_file and on_write_file, since such events can be initiated by system components (e.g., the cache manager, memory manager, etc.). If applications need the information this method returns during such events, they may do the following:

1. Call this method within the on_create_file or on_open_file event.
2. Store the information somewhere, and store a reference to it in the event's HandleContext parameter.
3. In a later event, access the information via the reference stored in HandleContext.

Please refer to the Contexts topic for more information on how to use events' context parameters.

Note: Renaming and deletion of files is performed after the file is opened. Thus, access checks should be performed during file opening as described above.

get_originator_token Method

Retrieves the security token associated with the process that initiated the operation (Windows only).

Syntax

def get_originator_token() -> int: ...

Remarks

This method can be called within certain events to retrieve the security token associated with the process that initiated the operation. If the query fails, this method returns INVALID_HANDLE_VALUE.

This method is available only in Windows.

The security token returned by this method can be passed to the Windows API's GetTokenInformation function to obtain more information about the process. This is particularly useful for implementing custom security checks; please refer to the Security Checks topic for more information.

Important: When applications are finished using the returned security token, they must close it using the Windows API's CloseHandle function.

Network Access Notes

For virtual drives shared on the network, applications may wish to obtain information about the network users accessing it (e.g., account names). Drives can be shared in several modes in Windows, which can affect the information retrievable via the security token this method returns:

• Authenticated mode, in which case the Helper DLL (which, in general, is responsible for relaying remote drive requests to and from the system driver) will impersonate the network user, allowing that account's actual information to be retrieved.
• Guest mode, in which case the retrievable information is for the system's GUEST account.
• Administrative shares (those which exist by default and whose names end with '$'; e.g., C$, ADMIN$, etc.), in which case the retrievable information is for the LOCAL_SYSTEM account.

Note: This method can be called only within events, and it must be called in the same thread that the event was originally fired on. However, it must not be called within events that work with opened files , such as on_read_file and on_write_file, since such events can be initiated by system components (e.g., the cache manager, memory manager, etc.). If applications need the information this method returns during such events, they may do the following:

1. Call this method within the on_create_file or on_open_file event.
2. Store the information somewhere, and store a reference to it in the event's HandleContext parameter.
3. In a later event, access the information via the reference stored in HandleContext.

Please refer to the Contexts topic for more information on how to use events' context parameters.

Note: Renaming and deletion of files is performed after the file is opened. Thus, access checks should be performed during file opening as described above.

get_uid Method

The method returns the user Id of the caller process.

Syntax

def get_uid() -> int: ...

Remarks

Windows:

This method currently is not used.

Linux:

Call this method from the event handlers to obtain the user Id of the caller process.

initialize Method

This method initializes the class.

Syntax

def initialize(product_guid: str) -> None: ...

Remarks

This method initializes the class and must be called each time the application starts before attempting to call any of the class's other methods with the exception of installation-related methods.

ProductGUID is used to distinguish between driver installations performed by different applications. Such information is necessary to guard against unexpected situations such as, e.g., the driver being uninstalled by one application despite other applications still needing it.

The GUID must be specified in so-called "Registry Format" (e.g., "{1FAD0EF2-9A03-4B87-B4BC-645B7035ED90}") with curly braces included.

To ensure proper operation, it is critical that each individual application have its own unique ProductGUID value, and that applications (and their installation scripts) use that value when calling any of the following methods:

• install
• uninstall
• get_driver_status
• get_module_version
• register_icon
• unregister_icon
• initialize

If the required driver was not installed using the install method with the same value of ProductGUID, initialize will return a ERROR_FILE_NOT_FOUND error (Win32 error code 2).

If the loaded kernel-mode driver is older than the user-mode API, initialize will return a ERROR_INVALID_KERNEL_INFO_VERSION error (Win32 error code 340). In this situation, an update of the driver using the install method is required before the class can be used.

install Method

This method installs or upgrades the product's system drivers (Windows only).

Syntax

def install(cab_file_name: str, product_guid: str, path_to_install: str, flags: int) -> int: ...

Remarks

Windows:

This method is used to install or upgrade the product's system driver. If the system must be rebooted to complete the installation process, this method will return a nonzero value.

Important: To upgrade the product's modules, use only the install method. Previously installed versions of the modules should not be uninstalled first. Calling the install method will upgrade the previously installed version.

Please refer to the Driver Installation topic for more information.

CabFileName must be the path of the .cab file containing the product modules.

Note: This .cab file must remain on the target system (or be available in some other way) after installation, because it is required to uninstall the modules from the system.

ProductGUID is used to distinguish between driver installations performed by different applications. Such information is necessary to guard against unexpected situations such as, e.g., the driver being uninstalled by one application despite other applications still needing it.

The GUID must be specified in so-called "Registry Format" (e.g., "{1FAD0EF2-9A03-4B87-B4BC-645B7035ED90}") with curly braces included.

To ensure proper operation, it is critical that each individual application have its own unique ProductGUID value, and that applications (and their installation scripts) use that value when calling any of the following methods:

• install
• uninstall
• get_driver_status
• get_module_version
• register_icon
• unregister_icon
• initialize

PathToInstall controls where the modules are installed. Pass an empty string (highly recommended) to automatically install them to the appropriate Windows system directory.

Flags specifies various installation options and should contain zero or more of the following flags, ORed together:

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation topic for more information about the latter.

This method requires administrative rights to execute successfully. If the user account of the process that calls this method doesn't have such rights, the call will fail with an ERROR_PRIVILEGE_NOT_HELD (0x0522) error.

Note: This method cannot be called within events.

Linux:

This method currently is not used.

mount Method

This method creates a virtual drive or directory and mounts a filesystem.

Syntax

def mount(mount_point: str) -> None: ...

Remarks

Call this method to create a virtual drive or directory and mount a filesystem.

The MountPoint parameter contains a path to the directory, into which the virtual filesystem is "inserted". This path must exist at the time of mounting and must be empty.

Windows:

The MountPoint parameter may also contain a drive letter or a UNC path; please refer to the Mounting Points topic for more information.

remove_denied_process Method

Removes a rule that prevents a process from accessing the virtual drive (Windows only).

Syntax

def remove_denied_process(process_file_name: str, process_id: int) -> None: ...

Remarks

When the process_restrictions_enabled property is enabled, this method can be used to remove an access rule previously added with the add_denied_process method.

Pass the same values for ProcessFileName and ProcessId as were used to add the rule when add_denied_process was called previously. Please refer to that method's documentation for more information.

Note: This method can be called only when active is True, and it cannot be called within events.

The methods and properties related to process access lists are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of process access information occurs in a thread-safe manner.

remove_granted_process Method

Removes a rule that allows a process to access the virtual drive (Windows only).

Syntax

def remove_granted_process(process_file_name: str, process_id: int) -> None: ...

Remarks

When the process_restrictions_enabled property is enabled, this method can be used to remove an access rule previously added with the add_granted_process method.

Pass the same values for ProcessFileName and ProcessId as were used to add the rule when add_granted_process was called previously. Please refer to that method's documentation for more information.

Note: This method can be called only when active is True, and it cannot be called within events.

The methods and properties related to process access lists are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of process access information occurs in a thread-safe manner.

uninstall Method

Uninstalls the product's system drivers and/or helper DLL (Windows only).

Syntax

def uninstall(cab_file_name: str, product_guid: str, installed_path: str, flags: int) -> int: ...

Remarks

This method is used to uninstall the product's various modules (i.e., the system drivers and Helper DLL). If the system must be rebooted to complete the uninstallation process, this method will return a non-zero value indicating which module(s) requested the reboot (see install for possible values).

Important: To upgrade the product's modules, use only the install method. Previously installed versions of the modules should not be uninstalled first. Calling the install method will upgrade the previously installed version.

Please refer to the Driver Installation topic for more information.

The same values must be passed for the CabFileName, ProductGUID, and InstalledPath parameters as were passed when install was called; please refer to its documentation for more information.

Flags specifies which versions of the product's modules should be uninstalled, and should be set by OR'ing together one or more of the following values:

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation topic for more information about the latter.

This method requires administrative rights to execute successfully. If the user account of the process that calls this method doesn't have such rights, the call will fail with an ERROR_PRIVILEGE_NOT_HELD (0x0522) error.

Note: This method cannot be called within events.

unix_time_to_file_time Method

This event converts the date/time in Unix format to Windows FileTime format.

Syntax

def unix_time_to_file_time(unix_time: int, nanoseconds: int) -> datetime.datetime: ...

Remarks

Use this method to convert the date/time in Unix format to Windows FileTime format.

Pass the Unix time value to UnixTime and optionally pass the subsecond part of the time, expressed in nanoseconds, to the Nanoseconds parameter. If the subsecond part of the time is not available, set Nanoseconds to zero (0) value.

unmount Method

This method unmounts a filesystem.

Syntax

def unmount() -> None: ...

Remarks

This method unmounts the mounted filesystem and deletes a virtual device from the system.

on_access Event

This event fires when the OS needs to check file access permissions.

Syntax

class FUSEAccessEventParams(object):
  @property
  def path() -> str: ...

  @property
  def mask() -> int: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_access() -> Callable[[FUSEAccessEventParams], None]: ...
@on_access.setter
def on_access(event_hook: Callable[[FUSEAccessEventParams], None]) -> None: ...

Remarks

Windows:

This event fires when the OS needs to know whether the file or directory specified in Path can be deleted. For this, the Mask parameter is set to 2 (W_OK).

The application must return 0 in the Result parameter to indicate that deletion is permitted, or otherwise sends an error code.

Linux:

This event fires when the OS needs to check access permissions of the file or directory specified in Path. Specifically, the event fires when a process uses the access() system call.

The application must return 0 in the Result parameter to indicate that access requested by the Mask parameter is permitted, or otherwise sends -EACCES< to indicate that access is denied.

If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_chmod Event

This event fires when the OS needs to change the permission bits of a file.

Syntax

class FUSEChmodEventParams(object):
  @property
  def path() -> str: ...

  @property
  def file_context() -> int: ...

  @property
  def mode() -> int: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_chmod() -> Callable[[FUSEChmodEventParams], None]: ...
@on_chmod.setter
def on_chmod(event_hook: Callable[[FUSEChmodEventParams], None]) -> None: ...

Remarks

Windows:

This event is not used.

Linux:

This event fires when the OS needs to change the permission bits of a file or directory and is identified either by Path or FileContext.

Mode contains the new permission bits.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_chown Event

This event fires when the OS needs to change the owner and group of a file.

Syntax

class FUSEChownEventParams(object):
  @property
  def path() -> str: ...

  @property
  def file_context() -> int: ...

  @property
  def uid() -> int: ...

  @property
  def gid() -> int: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_chown() -> Callable[[FUSEChownEventParams], None]: ...
@on_chown.setter
def on_chown(event_hook: Callable[[FUSEChownEventParams], None]) -> None: ...

Remarks

Windows:

This event currently is not used.

Linux:

This event fires when the OS needs to change the owner and group of a file or directory and is identified by either Path or FileContext.

Uid and Gid contain the new owner Id and group Id, respectively.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_copy_file_range Event

This event fires when the OS needs to copy a range of data from one file to another.

Syntax

class FUSECopyFileRangeEventParams(object):
  @property
  def path_in() -> str: ...

  @property
  def file_context_in() -> int: ...

  @property
  def offset_in() -> int: ...

  @property
  def path_out() -> str: ...

  @property
  def file_context_out() -> int: ...

  @property
  def offset_out() -> int: ...

  @property
  def size() -> int: ...

  @property
  def flags() -> int: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_copy_file_range() -> Callable[[FUSECopyFileRangeEventParams], None]: ...
@on_copy_file_range.setter
def on_copy_file_range(event_hook: Callable[[FUSECopyFileRangeEventParams], None]) -> None: ...

Remarks

Windows:

This event currently is not used.

Linux:

This event fires when the OS needs to copy a range of data from one file to another. The source file is identified either by PathIn or FileContextIn. The destination file is identified either by PathOut or FileContextOut.

OffsetIn specifies the starting offset in the source file from which the data are taken.

OffsetOut specifies the starting offset in the destination file, to which the data should be written.

Size specifies the size of the data block to be copied.

Flags is provided for future extensions and currently is not used.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_create Event

This event fires when the OS wants to create a file.

Syntax

class FUSECreateEventParams(object):
  @property
  def path() -> str: ...

  @property
  def mode() -> int: ...

  @property
  def file_context() -> int: ...
  @file_context.setter
  def file_context(value) -> None: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_create() -> Callable[[FUSECreateEventParams], None]: ...
@on_create.setter
def on_create(event_hook: Callable[[FUSECreateEventParams], None]) -> None: ...

Remarks

This event fires when the OS wants to create a file named Path.

Linux:

The application must create the file according to the creation mode and open it afterward. The creation mode is specified in the Mode parameter, whose values correspond to the ones used in the creat() function in POSIX and the Linux API.

The application may use the FileContext parameter to store a file handle or other information that is related to the open file. Windows:

The stored information will be shared between all concurrent file open operations performed on this file.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_destroy Event

This event fires upon filesystem exit.

Syntax

class FUSEDestroyEventParams(object):
# In class FUSE:
@property
def on_destroy() -> Callable[[FUSEDestroyEventParams], None]: ...
@on_destroy.setter
def on_destroy(event_hook: Callable[[FUSEDestroyEventParams], None]) -> None: ...

Remarks

This event fires when the filesystem is shut down.

on_error Event

This event fires if an unhandled error occurs during an event.

Syntax

class FUSEErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class FUSE:
@property
def on_error() -> Callable[[FUSEErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[FUSEErrorEventParams], None]) -> None: ...

Remarks

This event fires if an unhandled error occurs during another event. Developers can use this information to track down unhandled errors in an application's event handlers.

IMPORTANT: Not everything is possible or allowed in the event handlers. Please see the Event Handling topic for details.

on_f_allocate Event

This event fires when the OS needs to allocate space for an open file.

Syntax

class FUSEFAllocateEventParams(object):
  @property
  def path() -> str: ...

  @property
  def file_context() -> int: ...

  @property
  def mode() -> int: ...

  @property
  def offset() -> int: ...

  @property
  def length() -> int: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_f_allocate() -> Callable[[FUSEFAllocateEventParams], None]: ...
@on_f_allocate.setter
def on_f_allocate(event_hook: Callable[[FUSEFAllocateEventParams], None]) -> None: ...

Remarks

This event fires when the OS needs to allocate space for an open file. The file is identified by FileContext, and the Path parameter contains the name of the file.

The event should increase the allocation size (it may not decrease the allocation size) according to the following rule: new allocation size of the file must be the greater of Offset+Length and the current file size. The actual file size must be adjusted up to match the new allocation size unless the Mode parameter includes the value 1 (FALLOC_FL_KEEP_SIZE). In the latter case, the size remains unchanged. On Windows, the class always specifies FALLOC_FL_KEEP_SIZE, but on other systems, the flag may be absent. If the size was increased, the event handler must fill the newly added space with zeros (i.e., zeroize space).

Linux: The OS may send additional flags in the Mode parameter to manipulate file contents. An event handler should check the presense of such flags and deny the request if the requested flags are not supported.

The range of the file data to allocate space for and zeroize starts from Offset and occupies Length bytes.

The event handler must ensure that the required space is allocated for specified file. If the event handler returns success, then any subsequent write request to the specified range must be guaranteed not to fail because of lack of space in the backend storage.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_flush Event

This event fires when the OS needs to flush an open file's data out to storage before the file is closed.

Syntax

class FUSEFlushEventParams(object):
  @property
  def path() -> str: ...

  @property
  def file_context() -> int: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_flush() -> Callable[[FUSEFlushEventParams], None]: ...
@on_flush.setter
def on_flush(event_hook: Callable[[FUSEFlushEventParams], None]) -> None: ...

Remarks

This event fires any time the OS needs the virtual filesystem to flush data out to storage when the file is about to be closed. The file to flush is identified by either Path or FileContext.

When the file is opened several times, the event will be fired for each file close. Linux:

The OS gives no guarantee as to the number of times (if any) the event will fire.

To handle this event properly, applications must flush the requested data, writing it out to their backend storage.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_f_sync Event

This event fires when the OS needs to flush an open file's data out to storage.

Syntax

class FUSEFSyncEventParams(object):
  @property
  def path() -> str: ...

  @property
  def file_context() -> int: ...

  @property
  def data_sync() -> int: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_f_sync() -> Callable[[FUSEFSyncEventParams], None]: ...
@on_f_sync.setter
def on_f_sync(event_hook: Callable[[FUSEFSyncEventParams], None]) -> None: ...

Remarks

This event fires when the OS needs the virtual filesystem to flush data of the file out to storage, which can happen at any time the file is opened. The file to flush is identified by either Path or FileContext.

To handle this event properly, applications must flush the requested data, writing it out to their backend storage.

Linux:

The nonzero of the DataSync parameter indicates that only the user data should be flushed and not the metadata.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_get_attr Event

This event fires when the OS needs information about a file or directory.

Syntax

class FUSEGetAttrEventParams(object):
  @property
  def path() -> str: ...

  @property
  def file_context() -> int: ...

  @property
  def ino() -> int: ...
  @ino.setter
  def ino(value) -> None: ...

  @property
  def mode() -> int: ...
  @mode.setter
  def mode(value) -> None: ...

  @property
  def uid() -> int: ...
  @uid.setter
  def uid(value) -> None: ...

  @property
  def gid() -> int: ...
  @gid.setter
  def gid(value) -> None: ...

  @property
  def link_count() -> int: ...
  @link_count.setter
  def link_count(value) -> None: ...

  @property
  def size() -> int: ...
  @size.setter
  def size(value) -> None: ...

  @property
  def a_time() -> datetime.datetime: ...
  @a_time.setter
  def a_time(value) -> None: ...

  @property
  def m_time() -> datetime.datetime: ...
  @m_time.setter
  def m_time(value) -> None: ...

  @property
  def c_time() -> datetime.datetime: ...
  @c_time.setter
  def c_time(value) -> None: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_get_attr() -> Callable[[FUSEGetAttrEventParams], None]: ...
@on_get_attr.setter
def on_get_attr(event_hook: Callable[[FUSEGetAttrEventParams], None]) -> None: ...

Remarks

This event fires when the OS needs information about the file or directory identified by either Path or FileContext (the latter in most cases will not be initialized). If the entry with the specified name does not exist, the handler must return ENOENT in the Result parameter.

The Ino parameter should be set to the Id of the file, which must be unique within a filesystem. Ino is optional on Windows and is ignored on Linux, where FUSE internally generates internal Ids.

The Mode parameter is a combination of bit flags.

Windows: Mode may include 0x4000 (S_IFDIR) to indicate that the entry is a directory, and it must include either 0x80 (S_IWUSR) to indicate a file that can be read and written or 0x100 (S_IRUSR) to indicate a read-only file. Other flags are ignored.

Linux: Mode may include any appropriate file mode flags. See inode(7) for more information.

Windows: The Uid, Gid, and LinkCount parameters are not used.

Linux: The Uid and Gid parameters must be set to the owner's user Id and group Id, respectively. LinkCount should be set to the number of hard links that the file has (which usually is 1).

Size must be set to the size of the file's data. For directories, the parameter should be set to 0.

ATime, MTime, CTime: Set, respectively, to the Access Time, Modification Time, and Creation Time values of the file or directory. All date/time parameters in the class are specified in UTC.

To convert Unix time to the format that is suitable for this event, use the unix_time_to_file_time method.

Windows:

Any nonapplicable time values can be left unchanged, or set to January 1, 1970 00:00:00 UTC.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

Note: For this event, returning ERROR_FILE_INVALID has no effect.

on_init Event

This event fires on filesystem startup.

Syntax

class FUSEInitEventParams(object):
  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_init() -> Callable[[FUSEInitEventParams], None]: ...
@on_init.setter
def on_init(event_hook: Callable[[FUSEInitEventParams], None]) -> None: ...

Remarks

This event fires when the filesystem is started.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_lock Event

This event fires when the OS needs to lock or unlock the range of bytes of a file.

Syntax

class FUSELockEventParams(object):
  @property
  def path() -> str: ...

  @property
  def file_context() -> int: ...

  @property
  def lock_type() -> int: ...

  @property
  def lock_start() -> int: ...

  @property
  def lock_len() -> int: ...

  @property
  def cmd() -> int: ...

  @property
  def lock_owner() -> int: ...

  @property
  def lock_pid() -> int: ...
  @lock_pid.setter
  def lock_pid(value) -> None: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_lock() -> Callable[[FUSELockEventParams], None]: ...
@on_lock.setter
def on_lock(event_hook: Callable[[FUSELockEventParams], None]) -> None: ...

Remarks

This event fires when the OS needs to lock or unlock the range of bytes of the file, identified by either Path or FileContext. Local locking is performed by the system and your application needs to handle this even when it needs to perform an operation over the network.

LockType identifies whether the range is to be locked or unlocked. It can be one of the following:

LockStart and LockLen specify the starting position and the length of the block to be locked or unlocked. Cmd can be one of

Windows:

LockOwner and LockPid parameters are not used and are set to 0.

Linux:

This event fires for a POSIX-style lock. For additional information about LockOwner and other parameters, please refer to http://libfuse.github.io/doxygen/structfuse__operations.html#a1c3fff5cf0c1c2003d117e764b9a76fd.

if Cmd is F_GETLK, the event handler should place the PID of the owner process to the LockPid parameter.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_mk_dir Event

This event fires when the OS needs to create a directory.

Syntax

class FUSEMkDirEventParams(object):
  @property
  def path() -> str: ...

  @property
  def mode() -> int: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_mk_dir() -> Callable[[FUSEMkDirEventParams], None]: ...
@on_mk_dir.setter
def on_mk_dir(event_hook: Callable[[FUSEMkDirEventParams], None]) -> None: ...

Remarks

This event fires when the OS needs to create a directory, referenced as Path.

The Mode parameter is a combination of bit flags.

Windows:

Mode includes 0x4000 (S_IFDIR) to indicate that the entry is a directory and may include 0x80 (S_IWUSR) to indicate that the directory must not have its ReadOnly attribute set. If the 0x80 flag is not set, the event handler must set a read-only attribute for a newly created directory.

Linux:

Mode includes permission bits and may include additional bits depending on the OS.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_open Event

This event fires when the OS wants to open a file.

Syntax

class FUSEOpenEventParams(object):
  @property
  def path() -> str: ...

  @property
  def flags() -> int: ...

  @property
  def direct_io() -> bool: ...
  @direct_io.setter
  def direct_io(value) -> None: ...

  @property
  def keep_cache() -> bool: ...
  @keep_cache.setter
  def keep_cache(value) -> None: ...

  @property
  def non_seekable() -> bool: ...
  @non_seekable.setter
  def non_seekable(value) -> None: ...

  @property
  def file_context() -> int: ...
  @file_context.setter
  def file_context(value) -> None: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_open() -> Callable[[FUSEOpenEventParams], None]: ...
@on_open.setter
def on_open(event_hook: Callable[[FUSEOpenEventParams], None]) -> None: ...

Remarks

This event fires when the OS wants to open the existing file specified by Path using the open options reflected in Flags. The set of possible flags and options corresponds to the Flags parameter of Linux open(2) call.

The application may use the FileContext parameter to store a file handle or other information, related to the open file.

Windows:

The stored information will be shared between all concurrent file open operations performed on this file.

Linux:

DirectIO parameter may be set by the application to tell the kernel that buffering or caching should be avoided. KeepCache parameter may be set by the application to tell the kernel that existing file caches (if any) should not be invalidated. NonSeekable parameter may be set by the application to tell the kernel that the file is not seekable.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_read Event

This event fires when the OS needs to read data from an open file.

Syntax

class FUSEReadEventParams(object):
  @property
  def path() -> str: ...

  @property
  def file_context() -> int: ...

  @property
  def buffer() -> c_void_p: ...

  @property
  def size() -> int: ...

  @property
  def offset() -> int: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_read() -> Callable[[FUSEReadEventParams], None]: ...
@on_read.setter
def on_read(event_hook: Callable[[FUSEReadEventParams], None]) -> None: ...

Remarks

This event fires when the OS needs to read data from an already-open file, identified by either Path or FileContext.

To handle this event properly, applications should read Size bytes of data from the specified file into the memory region pointed to by Buffer. Reading must begin at the specified Offset in the file and all of the requested data are expected to be read. Applications must not attempt to copy more than Size bytes of data into Buffer.

Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

When reading is complete, applications must set Result to the actual number of bytes written to Buffer. Note: Although it is technically possible for an application to return fewer than Size bytes of data, doing so is abnormal and should be avoided. Most processes treat read requests as "all or nothing", so returning less data than requested is likely to cause an ungraceful failure.

If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_read_dir Event

This event fires when the OS wants to read (enumerate) a directory's contents.

Syntax

class FUSEReadDirEventParams(object):
  @property
  def path() -> str: ...

  @property
  def filler_context() -> int: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_read_dir() -> Callable[[FUSEReadDirEventParams], None]: ...
@on_read_dir.setter
def on_read_dir(event_hook: Callable[[FUSEReadDirEventParams], None]) -> None: ...

Remarks

This event fires when the OS wants to enumerate the contents of the directory, identified by Path. In response to this event, the application must call the fill_dir method and pass the FillerContextparameter as well as the information about the directory entry. Please refer to the description of fill_dir for further details.

If fill_dir returns an error code, set Result to the returned code (do not negate the code). If there are no more files to pass, set Result to 0.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

Note: For this event, returning ERROR_FILE_INVALID has no effect.

on_release Event

This event fires when the OS needs to release (close) a file.

Syntax

class FUSEReleaseEventParams(object):
  @property
  def path() -> str: ...

  @property
  def file_context() -> int: ...

  @property
  def flags() -> int: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_release() -> Callable[[FUSEReleaseEventParams], None]: ...
@on_release.setter
def on_release(event_hook: Callable[[FUSEReleaseEventParams], None]) -> None: ...

Remarks

This event fires when the OS wants to close the file identified by either Path or FileContext.

The Flags parameter contains the same value as the one passed during file creation or opening.

Windows:

If the file is opened two or more times concurrently (i.e., several open handles exist), this parameter will contain the flags of the last open operation rather than the flags of an operation that opened a handle being closed.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_rename Event

This event fires when the OS wants to rename or move a file or directory within the virtual filesystem.

Syntax

class FUSERenameEventParams(object):
  @property
  def old_path() -> str: ...

  @property
  def new_path() -> str: ...

  @property
  def flags() -> int: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_rename() -> Callable[[FUSERenameEventParams], None]: ...
@on_rename.setter
def on_rename(event_hook: Callable[[FUSERenameEventParams], None]) -> None: ...

Remarks

This event fires when the OS wants to rename or move the specified file or directory from OldPath to NewPath, both of which are fully qualified and located in the virtual filesystem. The Flags parameter currently is not used.

To handle this event properly, applications must perform any actions needed to rename or move the specified file or directory in their backend storage, overwriting the destination file if necessary. An application may also, for its own reasons, decide not to overwrite a destination file, in which case it must deny the operation by returning an appropriate error code via ResultCode.

Windows:

This event fires only if a file or directory with the specified NewPath does not exist; or if such a file does exist, and an overwrite was requested. Cases in which a file with the specified NewPath exists, and an overwrite was not requested, are handled by the class internally. Note: Windows only allows files to be overwritten, and denies a rename or move request automatically if the destination is an existing directory.

Any handles to the file being renamed are closed before the rename operation and are reopened after the operation. If the rename operation fails, then the file handles are reopened using the old name. If any of the reopen operations fail, the reopening process is stopped, and any handles that already have been reopened are closed again.

The value returned by the application in the ResultCode parameter is passed back to the system.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_rm_dir Event

This event fires when the OS wants to remove (delete) a directory.

Syntax

class FUSERmDirEventParams(object):
  @property
  def path() -> str: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_rm_dir() -> Callable[[FUSERmDirEventParams], None]: ...
@on_rm_dir.setter
def on_rm_dir(event_hook: Callable[[FUSERmDirEventParams], None]) -> None: ...

Remarks

This event fires when the OS has decided to delete the directory specified by Path.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

Windows:

The resulting error value is ignored because of the OS design.

on_stat_fs Event

This event fires when the OS needs information about the virtual drive's capacity and free space.

Syntax

class FUSEStatFSEventParams(object):
  @property
  def path() -> str: ...

  @property
  def block_size() -> int: ...
  @block_size.setter
  def block_size(value) -> None: ...

  @property
  def total_blocks() -> int: ...
  @total_blocks.setter
  def total_blocks(value) -> None: ...

  @property
  def free_blocks() -> int: ...
  @free_blocks.setter
  def free_blocks(value) -> None: ...

  @property
  def free_blocks_avail() -> int: ...
  @free_blocks_avail.setter
  def free_blocks_avail(value) -> None: ...

  @property
  def total_files() -> int: ...
  @total_files.setter
  def total_files(value) -> None: ...

  @property
  def free_files() -> int: ...
  @free_files.setter
  def free_files(value) -> None: ...

  @property
  def max_filename_length() -> int: ...
  @max_filename_length.setter
  def max_filename_length(value) -> None: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_stat_fs() -> Callable[[FUSEStatFSEventParams], None]: ...
@on_stat_fs.setter
def on_stat_fs(event_hook: Callable[[FUSEStatFSEventParams], None]) -> None: ...

Remarks

This event fires anytime the OS needs to retrieve the virtual drive's total storage capacity and free space. This event is mandatory to handle. Without it, the OS will not be able to initialize the drive.

To handle this event properly, applications must set event parameters accordingly. BlockSize must be set to the size of the block, and TotalBlocks must be set to the total number of blocks on the virtual drive. FreeBlocks and FreeBlocksAvail denote the number of free blocks available to the system and to the unprivileged user, respectively.

Windows:

The minimum drive size accepted by Windows is 6144 bytes. However, the class adjusts the minimum size to be at least 49152 bytes to ensure compatibility with possible changes in future Windows updates.

Linux:

TotalFiles and FreeFiles must be set to the total and available number of file slots (inodes) available within a filesystem. MaxFilenameLength should be set to the maximal length of the filename (path component) supported by the filesystem.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_truncate Event

This event fires when the OS needs to truncate (set the size of) a file.

Syntax

class FUSETruncateEventParams(object):
  @property
  def path() -> str: ...

  @property
  def file_context() -> int: ...

  @property
  def size() -> int: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_truncate() -> Callable[[FUSETruncateEventParams], None]: ...
@on_truncate.setter
def on_truncate(event_hook: Callable[[FUSETruncateEventParams], None]) -> None: ...

Remarks

This event fires when the OS wants to set the size of the file, which is identified by either Path or FileContext.

Note: On non-Windows systems, FileContext may be 0 even for a file that is opened at the moment when the event fires.

The Size parameter contains the new file size. If the new size is larger than the old size, the added space is expected to be filled with null bytes ('\0').

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_unlink Event

This event fires when the OS wants to unlink (delete) a file.

Syntax

class FUSEUnlinkEventParams(object):
  @property
  def path() -> str: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_unlink() -> Callable[[FUSEUnlinkEventParams], None]: ...
@on_unlink.setter
def on_unlink(event_hook: Callable[[FUSEUnlinkEventParams], None]) -> None: ...

Remarks

This event fires when the OS has decided to delete the file specified by Path.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

Windows:

The resulting error value is ignored because of the OS design.

on_u_time Event

This event fires when the OS needs to change access and modification times of a file.

Syntax

class FUSEUTimeEventParams(object):
  @property
  def path() -> str: ...

  @property
  def file_context() -> int: ...

  @property
  def a_time() -> datetime.datetime: ...

  @property
  def m_time() -> datetime.datetime: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_u_time() -> Callable[[FUSEUTimeEventParams], None]: ...
@on_u_time.setter
def on_u_time(event_hook: Callable[[FUSEUTimeEventParams], None]) -> None: ...

Remarks

This event fires when the OS needs to change access and modification times of the file, which is identified by either Path or FileContext. The ATime and MTime parameters contain the access time and modification time, respectively. All date/time parameters in the class are specified in UTC

To convert the values of the ATime and MTime parameters to Unix time, use the file_time_to_unix_time method.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

on_write Event

This event fires when the OS needs to write data to an open file.

Syntax

class FUSEWriteEventParams(object):
  @property
  def path() -> str: ...

  @property
  def file_context() -> int: ...

  @property
  def write_page() -> bool: ...

  @property
  def offset() -> int: ...

  @property
  def buffer() -> c_void_p: ...

  @property
  def size() -> int: ...

  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_write() -> Callable[[FUSEWriteEventParams], None]: ...
@on_write.setter
def on_write(event_hook: Callable[[FUSEWriteEventParams], None]) -> None: ...

Remarks

This event fires when the OS needs to write data to the already-open file, which is identified by either Path or FileContext.

To handle this event properly, applications should write Size bytes of data from the memory region pointed to by Buffer to the specified file. Writing must begin at the specified Offset in the file and all of the provided data are expected to be written.

Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The WritePage parameter will be set to a nonzero value when writing is performed by the cache manager or another system component. If this is the case, FileContext may not match the value that would be passed in the case of a nonbuffered write by a user-mode process.

When writing is complete, applications must set Result to the actual number of bytes written to the file.

If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available, or security checks failed), set it to a negative error code value (e.g., -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Handling topic for more information.

FUSE Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

FUSE Config Settings

Base Config Settings

FUSE Errors

The class uses Unix/Linux system error codes during operation, as necessary. Please refer to the Error Handling topic for more information.