Description

a cross-platform folder & file watching library using win32, inotify or std.file

Package Information

Version0.2.0 (2016-Jul-20)
Repositoryhttps://github.com/WebFreak001/FSWatch
LicenseBSL-1.0
CopyrightCopyright © 2016, webfreak
Authorswebfreak
Registered byWebFreak
Sub packages
./examples/watch/
[directory based sub package]
Dependenciesnone

Installation

To use this package, put the following dependency into your project's dependencies section:

dub.json
dub.sdl

Readme

FSWatch

Build Status Dub version Dub downloads

A cross platform library simplifying watching for file changes using a non-blocking interface using the Win32 API, inotify or std.file.dirEntries as fallback.

Comparison between implementations

PlatformWatching DirectoryWatching File
WindowsReadDirectoryChangesW (very fast, accurate)polling using std.file.timeLastModified and std.file.exists (fast, not accurate for quick write)
Linuxinotify (very fast, accurate)inotify (very fast, accurate)
Otherpolling using std.file.dirEntries (slow, not accurate)polling using std.file.timeLastModified and std.file.exists (fast, not accurate for quick write)

To force usage of the std.file polling implementation you can just add version = FSWForcePoll;

Don't do this unless you have a specific reason as you will lose speed and accuracy!

Example

void main()
{
	// Initializes a FileWatch instance to watch on `project1/` recursively (recursive option does not have an effect on linux, its always recursive)
	auto watcher = FileWatch("project1/", true);
	while (true)
	{
		// This will fetch all queued events or an empty array if there are none
		foreach (event; watcher.getEvents())
		{
			// paths are relative to the watched directory in most cases
			if (event.path == "dub.json" || event.path == "dub.sdl")
			{
				if (event.type == FileChangeEventType.create)
				{
					// dub.json or dub.sdl got created
				}
				else if (event.type == FileChangeEventType.modify)
				{
					// dub.json or dub.sdl got modified
				}
				else if (event.type == FileChangeEventType.remove)
				{
					// dub.json or dub.sdl got deleted
				}
			}
			if (event.type == FileChangeEventType.rename)
			{
				// The file `event.path` has been removed to `event.newPath`
			}
			else if (event.type == FileChangeEventType.createSelf)
			{
				// the folder we are watching has been created
			}
			else if (event.type == FileChangeEventType.removeSelf)
			{
				// the folder we are watching has been deleted or renamed
			}
		}
		// ...
		myapp.handleInput();
		myapp.update();
		myapp.draw();
	}
}

Available versions

0.2.0 0.1.0 ~master