The fs-watcher Reference Manual

This is the fs-watcher Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 05:16:46 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 fs-watcher

Filesystem watcher for changes

Author

Florian Margaine <>

License

MIT License

Dependencies
  • com.gigamonkeys.pathnames (system).
  • alexandria (system).
Source

fs-watcher.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 fs-watcher/fs-watcher.asd

Source

fs-watcher.asd.

Parent Component

fs-watcher (system).

ASDF Systems

fs-watcher.


3.1.2 fs-watcher/src/package.lisp

Source

fs-watcher.asd.

Parent Component

fs-watcher (system).

Packages

fs-watcher.


3.1.3 fs-watcher/src/fs-watcher.lisp

Dependency

src/package.lisp (file).

Source

fs-watcher.asd.

Parent Component

fs-watcher (system).

Public Interface

watch (function).

Internals

4 Packages

Packages are listed by definition order.


4.1 fs-watcher

Source

src/package.lisp.

Use List
  • com.gigamonkeys.pathnames.
  • common-lisp.
Public Interface

watch (function).

Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: watch (pathnames callback &key delay)

Watches a list of pathnames

Package

fs-watcher.

Source

src/fs-watcher.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: dir-contents (pathnames)

For each directory, collect the file pathnames recursively. Results are appended and returned as a single list.

Package

fs-watcher.

Source

src/fs-watcher.lisp.

Function: mtime (pathname)

Returns the mtime of a pathname

Package

fs-watcher.

Source

src/fs-watcher.lisp.

Function: run-loop (pathnames mtimes callback delay)

The main loop constantly polling the filesystem

Package

fs-watcher.

Source

src/fs-watcher.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables