Module findf

findfに対するインターフェース関数群.

Description

findfに対するインターフェース関数群.

Data Types

file_error()

file_error() = term()

fileモジュールの関数が発生させるエラー. file:format_error/1 に渡して人間可読な文字列が得られる.

state()

state() = #state{dirs = [string()], exts = [string()]}

ディレクトリのリストdirsと拡張子のリストextsを保持するレコード. 初期値は、dirsもextsも空リスト.

void()

void() = ok | void | none

Function Index

add_to_dirs/1ディレクトリのリストにディレクトリを追加する.
add_to_exts/1拡張子のリストに拡張子を追加する.
find_file/1ファイル名の一部から、実在するファイルを探す.
get_dirs/0現在保持しているディレクトリのリストを返す.
get_exts/0現在保持している拡張子のリストを返す.
open_file/1ファイル名の一部に対応するファイルがあれば開く.
read_file/1ファイル名の一部に対応するファイルがあれば読む.
remove_from_dirs/1ディレクトリのリストからディレクトリを削除する.
remove_from_exts/1拡張子のリストから拡張子を削除する.
set_dirs/1ディレクトリのリストをセットする.
set_exts/1拡張子のリストをセットする.
start/0findfの開始.
start/1状態を引数に渡してfindfを開始.
stop/0findfの停止.

Function Details

add_to_dirs/1

add_to_dirs(Dir::string()) -> void()

ディレクトリのリストにディレクトリを追加する.

add_to_exts/1

add_to_exts(Ext::string()) -> void()

拡張子のリストに拡張子を追加する.

find_file/1

find_file(Name::string()) -> string()

throws file_error()

ファイル名の一部から、実在するファイルを探す.

get_dirs/0

get_dirs() -> [string()]

現在保持しているディレクトリのリストを返す.

get_exts/0

get_exts() -> [string()]

現在保持している拡張子のリストを返す.

open_file/1

open_file(Name::string()) -> pid()

throws file_error()

ファイル名の一部に対応するファイルがあれば開く.

read_file/1

read_file(Name::string()) -> binary()

throws file_error()

ファイル名の一部に対応するファイルがあれば読む.

remove_from_dirs/1

remove_from_dirs(Dir::string()) -> void()

ディレクトリのリストからディレクトリを削除する.

remove_from_exts/1

remove_from_exts(Ext::string()) -> void()

拡張子のリストから拡張子を削除する.

set_dirs/1

set_dirs(Dirs::[string()]) -> void()

ディレクトリのリストをセットする.

set_exts/1

set_exts(Exts::[string()]) -> void()

拡張子のリストをセットする.

start/0

start() -> {ok, Pid} | ignore | {error, Error}

findfの開始.

start/1

start(InitState::#sate{}) -> {ok, Pid} | ignore | {error, Error}

状態を引数に渡してfindfを開始

stop/0

stop() -> none()

findfの停止.


Generated by EDoc, Dec 3 2008, 13:34:23.