https://github.com/synrc/fs

📁 FS: Windows, Linux, Mac Driver
https://github.com/synrc/fs

linux mac windows

Last synced: about 1 month ago
JSON representation

📁 FS: Windows, Linux, Mac Driver

• Host: GitHub
• URL: https://github.com/synrc/fs
• Owner: 5HT
• License: other
• Created: 2014-05-10T19:59:48.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-06-06T12:40:18.000Z (7 months ago)
• Last Synced: 2024-10-29T20:55:54.447Z (about 2 months ago)
• Topics: linux, mac, windows
• Language: Erlang
• Homepage: https://fs.n2o.dev
• Size: 128 KB
• Stars: 237
• Watchers: 8
• Forks: 69
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
FS: Native Listener (Mac Windows Linux)

=======================================

[![Actions Status](https://github.com/synrc/fs/workflows/mix/badge.svg)](https://github.com/synrc/fs/actions)

[![Build Status](https://travis-ci.com/synrc/fs.svg?branch=master)](https://travis-ci.com/synrc/fs)

[![Hex pm](http://img.shields.io/hexpm/v/fs.svg?style=flat)](https://hex.pm/packages/fs)

Backends

--------

* Mac [fsevent](https://github.com/thibaudgg/rb-fsevent)

* Linux [inotify](https://github.com/rvoicilas/inotify-tools/wiki)

* Windows [inotify-win](https://github.com/thekid/inotify-win)

NOTE: On Linux you need to install inotify-tools.

### Subscribe to Notifications

```erlang

> fs:start_link(fs_watcher, "/Users/5HT/synrc/fs"). % need to start the fs watcher

> fs:subscribe(fs_watcher). % the pid will receive events as messages

> flush().

Shell got {<0.47.0>,

           {fs,file_event},

           {"/Users/5HT/synrc/fs/src/README.md",[closed,modified]}}

```

### List Events from Backend

```erlang

> fs:known_events(fs_watcher). % returns events known by your backend

[mustscansubdirs,userdropped,kerneldropped,eventidswrapped,

 historydone,rootchanged,mount,unmount,created,removed,

 inodemetamod,renamed,modified,finderinfomod,changeowner,

 xattrmod,isfile,isdir,issymlink,ownevent]

```

### Sample Subscriber

```erlang

> fs:start_looper(). % starts a sample process that logs events

=INFO REPORT==== 28-Aug-2013::19:36:26 ===

file_event: "/tank/proger/erlfsmon/src/4913" [closed,modified]

```

Credits

-------

* Vladimir Kirillov

* Maxim Sokhatsky

* Dominic Letz 

OM A HUM