leo_file

• Description
• Function Index
• Function Details

leo_file is utilities for file processing.

References

• https://github.com/leo-project/leo_commons/blob/master/src/leo_file.erl

Description

leo_file is utilities for file processing

Function Index

file_delete_all/1	Remove all files of the target.
file_get_mount_path/1	Retrieve file mount path(s).
file_get_remain_disk/1	Retrieve remain disk capacity of the target.
file_get_total_size/1	Retrieve total of the file size.
file_touch/1	Touch a file.
file_unconsult/2	Unconsult the file.

Function Details

file_delete_all/1

file_delete_all(FilePath) -> ok | {error, any()}

• FilePath = string()

Remove all files of the target

file_get_mount_path/1

file_get_mount_path(FilePath) -> ok | {error, any()}

• FilePath = string()

Retrieve file mount path(s)

file_get_remain_disk/1

file_get_remain_disk(Params) -> ok | {error, any()}

• Params = {FilePath::string(), SizeKB::non_neg_integer(), Rate::non_neg_integer()}

Retrieve remain disk capacity of the target

file_get_total_size/1

file_get_total_size(Path) -> ok | {error, any()}

• Path = string()

Retrieve total of the file size

file_touch/1

file_touch(FilePath) -> ok | {error, any}

• FilePath = string()

Touch a file

file_unconsult/2

file_unconsult(FilePath, Term) -> ok | {error, any()}

• FilePath = string()
• Term = any()

Unconsult the file