Type deai.plugin.file:Watch

See file.watch for more information about this type

Methods

`add(paths)`	Add files
`add_one(path)`	Add a file
`remove(path)`	Remove a file

add(paths) → integer

Return type:: integer
Parameters:: paths ([string])

Add files

Add new files to a watch, returns 0 if successful.

add_one(path) → integer

Return type:: integer
Parameters:: path (string)

Add a file

Add a single new file to a watch, returns 0 if successful.

remove(path) → integer

Return type:: integer
Parameters:: path (string)

Remove a file

Returns 0 if successful. If the file is not in the watch, return -ENOENT.

Signals

`access(path, file_name)`	A file was accessed.
`attrib(path, file_name)`	A file’s metadata was changed.
`close-nowrite(path, file_name)`	A file or directory not opened for iting was closed.
`close-write(path, file_name)`	A file opened for writing was closed.
`create(path, file_name)`	A file or directory is created.
`delete(path, file_name)`	A file or directory was deleted from watched directory.
`delete-self(path, file_name)`	A watched file or directory was itself deleted.
`modify(path, file_name)`	A file was modified.
`move-from(path, file_name, cookie)`	A file in a watched directory was renamed to a new place.
`move-self(path, file_name)`	A watched file or directory was itself moved
`move-to(path, file_name, cookie)`	A file was renamed into a watched directory.
`open(path, file_name)`	A file or directory was opened

signal access(path, file_name)

Parameters:

path (string)
file_name (string)

A file was accessed.

signal attrib(path, file_name)

Parameters:

path (string)
file_name (string)

A file’s metadata was changed.

signal close-nowrite(path, file_name)

Parameters:

path (string)
file_name (string)

A file or directory not opened for iting was closed.

signal close-write(path, file_name)

Parameters:

path (string)
file_name (string)

A file opened for writing was closed.

signal create(path, file_name)

Parameters:

path (string)
file_name (string)

A file or directory is created.

signal delete(path, file_name)

Parameters:

path (string)
file_name (string)

A file or directory was deleted from watched directory.

signal delete-self(path, file_name)

Parameters:

path (string)
file_name (string)

A watched file or directory was itself deleted.

signal modify(path, file_name)

Parameters:

path (string)
file_name (string)

A file was modified.

signal move-from(path, file_name, cookie)

Parameters:

path (string)
file_name (string)
cookie (integer) – unique integer associated with this move, can be used to pair this event with a move-to() event.

A file in a watched directory was renamed to a new place.

signal move-self(path, file_name)

Parameters:

path (string)
file_name (string)

A watched file or directory was itself moved

signal move-to(path, file_name, cookie)

Parameters:

path (string)
file_name (string)
cookie (integer) – unique integer associated with this move, can be used to pair this event with a move-from() event.

A file was renamed into a watched directory.

signal open(path, file_name)

Parameters:

path (string)
file_name (string)

A file or directory was opened