FileWatch

An instance of a FileWatcher Contains different implementations (win32 api, inotify and polling using the std.file methods) Specify version = FSWForcePoll; to force using std.file (is slower and more resource intensive than the other implementations)

struct FileWatch {

const

string path;

import core.sys.windows.windows : HANDLE, OVERLAPPED, CloseHandle, GetOverlappedResult, CreateFile, GetLastError, ReadDirectoryChangesW, FILE_NOTIFY_INFORMATION, FILE_ACTION_ADDED, FILE_ACTION_REMOVED, FILE_ACTION_MODIFIED, FILE_ACTION_RENAMED_NEW_NAME, FILE_ACTION_RENAMED_OLD_NAME, FILE_LIST_DIRECTORY, FILE_SHARE_WRITE, FILE_SHARE_READ, FILE_SHARE_DELETE, OPEN_EXISTING, FILE_FLAG_OVERLAPPED, FILE_FLAG_BACKUP_SEMANTICS, FILE_NOTIFY_CHANGE_FILE_NAME, FILE_NOTIFY_CHANGE_DIR_NAME, FILE_NOTIFY_CHANGE_LAST_WRITE, ERROR_IO_PENDING, ERROR_IO_INCOMPLETE, DWORD;;

import std.utf : toUTF8, toUTF16;;

import std.path : absolutePath;;

import std.conv : to;;

import std.datetime : SysTime;;

this(string path, bool recursive, bool treatDirAsFile);

~this();

version(FSWUsesWin32)

FileChangeEvent[] getEvents();

import core.sys.linux.sys.inotify : inotify_rm_watch, inotify_init1, inotify_add_watch, inotify_event, IN_CREATE, IN_DELETE, IN_DELETE_SELF, IN_MODIFY, IN_MOVE_SELF, IN_MOVED_FROM, IN_MOVED_TO, IN_NONBLOCK, IN_ATTRIB, IN_EXCL_UNLINK;;

import core.sys.linux.unistd : close, read;;

import core.sys.linux.fcntl : fcntl, F_SETFD, FD_CLOEXEC;;

import core.sys.linux.errno : errno;;

import core.sys.posix.poll : pollfd, poll, POLLIN;;

import std.string : toStringz, fromStringz;;

import std.conv : to;;

this(string path, bool ignored1, bool ignored2);

~this();

version(!FSWUsesWin32)
version(FSWUsesINotify)

FileChangeEvent[] getEvents();

import std.datetime : SysTime;;

import std.algorithm : countUntil, remove;;

import std.path : relativePath, absolutePath, baseName;;

this(string path, bool recursive, bool treatDirAsFile);

version(!FSWUsesWin32)
version(!FSWUsesINotify)
version(FSWUsesPolling)

FileChangeEvent[] getEvents();

}

Constructors

this this(string path, bool recursive, bool treatDirAsFile): Creates an instance using the Win32 API
this this(string path, bool ignored1, bool ignored2): Creates an instance using the linux inotify API
this this(string path, bool recursive, bool treatDirAsFile): Generic fallback implementation using std.file.dirEntries

Destructor

~this ~this(): Undocumented in source.

Members

Functions

getEvents FileChangeEvent[] getEvents(): Implementation using Win32 API or polling for files
getEvents FileChangeEvent[] getEvents(): Generic polling implementation
getEvents FileChangeEvent[] getEvents(): Implementation using inotify

Variables

path string path;: Path of the file set using the constructor

Examples

import core.thread;

FileChangeEvent waitForEvent(ref FileWatch watcher)
{
	FileChangeEvent[] ret;
	while ((ret = watcher.getEvents()).length == 0)
	{
		Thread.sleep(1.msecs);
	}
	return ret[0];
}

if (exists("test"))
	rmdirRecurse("test");
scope (exit)
{
	if (exists("test"))
		rmdirRecurse("test");
}

auto watcher = FileWatch("test", true);
mkdir("test");
auto ev = waitForEvent(watcher);
assert(ev.type == FileChangeEventType.createSelf);
write("test/a.txt", "abc");
ev = waitForEvent(watcher);
assert(ev.type == FileChangeEventType.create);
assert(ev.path == "a.txt");
Thread.sleep(2000.msecs); // for polling variant
append("test/a.txt", "def");
ev = waitForEvent(watcher);
assert(ev.type == FileChangeEventType.modify);
assert(ev.path == "a.txt");
rename("test/a.txt", "test/b.txt");
ev = waitForEvent(watcher);
assert(ev.type == FileChangeEventType.rename);
assert(ev.path == "a.txt");
assert(ev.newPath == "b.txt");
remove("test/b.txt");
ev = waitForEvent(watcher);
assert(ev.type == FileChangeEventType.remove);
assert(ev.path == "b.txt");
rmdirRecurse("test");
ev = waitForEvent(watcher);
assert(ev.type == FileChangeEventType.removeSelf);

FileWatch

Constructors

Destructor

Members

Functions

Variables

Examples

Meta

Source