zotonic_fileindexer v1.0.0-rc.10

zotonic_fileindexer (zotonic_fileindexer v1.0.0-rc.10)

Indexes directories of applications.

Link to this section Summary

Types

fileindex/0

Functions

flush()
Clear the complete cache, force a rescan.
flush(App)
Clear the cache for the given application. Useful to force a rescan.
flush(App, SubDir)
Clear the cache for the given application and subdir prefix. Useful to force a rescan.
scan(App, SubDir)
Scan an application/dir for files matching a file pattern
scan(App, SubDir, Pattern)
start()
start(StartType, StartArgs)
stop(State)

Link to this section Types

Link to this type

fileindex/0

-type fileindex() :: #fileindex{}.

Link to this section Functions

Link to this function

flush()

-spec flush() -> ok.
Clear the complete cache, force a rescan.
Link to this function

flush(App)

-spec flush(atom()) -> ok.
Clear the cache for the given application. Useful to force a rescan.
Link to this function

flush(App, SubDir)

-spec flush(atom(), file:filename_all()) -> ok.
Clear the cache for the given application and subdir prefix. Useful to force a rescan.
Link to this function

scan(App, SubDir)

-spec scan(atom(), file:filename_all()) -> {ok, [zotonic_fileindexer:fileindex()]} | {error, term()}.
Scan an application/dir for files matching a file pattern
Link to this function

scan(App, SubDir, Pattern)

-spec scan(atom(), file:filename_all(), string() | binary() | undefined) ->
        {ok, [zotonic_fileindexer:fileindex()]} | {error, term()}.
Link to this function

start()

Link to this function

start(StartType, StartArgs)

Link to this function

stop(State)