Module epax_index

Description
Function Index
Function Details

provides an API to handle the index stored locally.

Authors: Aman Mangal (mangalaman93@gmail.com).

Description

provides an API to handle the index stored locally

Function Index

app_exists/1	returns true when the app is already added into the index, false otherwise.
check_index/0	assuming the index correct, verifies the downloaded packages, deletes rest of the folders.
checkout_repo_and_add_to_index/2	downloads the repo in the packages folder and adds details to index.
get_applist/0	returns the list of applications added into the index.
get_index_entry/1	returns the application tuple stored in the index for the given package/application.
init/0	initializes index.
remove_from_index/1	deletes app from the index.
search/2	performs a full text search for given regular expression in the list of installed packages.
update_index/0	pulls any changes in the repository and updates the details of applications in index.

Function Details

app_exists/1

app_exists(Info) -> Result

Info = string() | atom()
Result = {ok, Status} | {error, Reason}
Status = Appname | false
Appname = atom()
Reason = string()

returns true when the app is already added into the index, false otherwise. Info can be either the link to the application or the name of the application

check_index/0

check_index() -> ok | {error, Reason}

Reason = term()

assuming the index correct, verifies the downloaded packages, deletes rest of the folders. If anything goes wrong, it initializes the index

checkout_repo_and_add_to_index/2

checkout_repo_and_add_to_index(Link, Options) -> Result

Link = string()
Options = [term()]
Result = {ok, App} | {error, Reason}
App = atom()
Reason = term()

downloads the repo in the packages folder and adds details to index

get_applist/0

get_applist() -> Result

Result = {ok, AllApps} | {error, Reason}
AllApps = [atom()]
Reason = term()

returns the list of applications added into the index

get_index_entry/1

get_index_entry(Appname) -> Result

Appname = atom()
Result = {ok, #application{}} | {error, Reason}
Reason = term()

returns the application tuple stored in the index for the given package/application

init/0

init() -> ok

initializes index

remove_from_index/1

remove_from_index(Appname) -> Result

Appname = atom()
Result = ok | {error, Reason}
Reason = term()

deletes app from the index

search/2

search(Regex, Option) -> ok | {error, Reason}

Regex = string()
Option = [term()]
Reason = term()

performs a full text search for given regular expression in the list of installed packages. Various options can be provided to control the search domain

update_index/0

update_index() -> ok | {error, Reason}

Reason = term()

pulls any changes in the repository and updates the details of applications in index

Generated by EDoc