Module zotonic_fileindexer

Indexes directories of applications.

Copyright © 2018 Marc Worrell

Behaviours: application.

Authors: Marc Worrell (marc@worrell.nl).

Description

Indexes directories of applications.

Data Types

fileindex()

fileindex() = #fileindex{}

Function Index

flush/0Clear the complete cache, force a rescan.
flush/1Clear the cache for the given application.
flush/2Clear the cache for the given application and subdir prefix.
scan/2Scan an application/dir for files matching a file pattern.
scan/3
start/0
start/2
stop/1

Function Details

flush/0

flush() -> ok

Clear the complete cache, force a rescan.

flush/1

flush(App::atom()) -> ok

Clear the cache for the given application. Useful to force a rescan.

flush/2

flush(App::atom(), SubDir::file:filename_all()) -> ok

Clear the cache for the given application and subdir prefix. Useful to force a rescan.

scan/2

scan(App::atom(), SubDir::file:filename_all()) -> {ok, [zotonic_fileindexer:fileindex()]} | {error, term()}

Scan an application/dir for files matching a file pattern

scan/3

scan(App::atom(), SubDir::file:filename_all(), Pattern::string() | binary() | undefined) -> {ok, [zotonic_fileindexer:fileindex()]} | {error, term()}

start/0

start() -> any()

start/2

start(StartType, StartArgs) -> any()

stop/1

stop(State) -> any()


Generated by EDoc