Module r3_hex_erl_tar

Data Types

add_opt()

add_opt() = dereference | verbose | {chunks, pos_integer()} | {atime, non_neg_integer()} | {mtime, non_neg_integer()} | {ctime, non_neg_integer()} | {mode, non_neg_integer()} | {uid, non_neg_integer()} | {gid, non_neg_integer()}

create_opt()

create_opt() = compressed | cooked | dereference | verbose

extract_opt()

extract_opt() = {cwd, string()} | {files, [name_in_archive()]} | {chunks, pos_integer()} | {max_size, pos_integer() | infinity} | compressed | cooked | memory | keep_old_files | verbose

file_op()

file_op() = fun((close, file:io_device()) -> ok | {error, term()}) | fun((position, {file:io_device(), file:location()}) -> {ok, integer()} | {error, term()}) | fun((read2, {file:io_device(), non_neg_integer()}) -> {ok, string() | binary()} | eof | {error, term()}) | fun((write, {file:io_device(), iodata()}) -> ok | {error, term()})

filelist()

filelist() = [file:filename() | {name_in_archive(), file:filename_all()}]

gid()

gid() = non_neg_integer()

mode()

mode() = non_neg_integer()

name_in_archive()

name_in_archive() = string()

open_type()

open_type() = file:filename_all() | {binary, binary()} | {file, file:io_device()}

tar_descriptor()

abstract datatype: tar_descriptor()

tar_entry()

tar_entry() = {Name::name_in_archive(), Type::typeflag(), Size::non_neg_integer(), MTime::tar_time(), Mode::mode(), Uid::uid(), Gid::gid()}

tar_time()

tar_time() = non_neg_integer()

typeflag()

typeflag() = regular | link | symlink | char | block | directory | fifo | reserved | unknown

uid()

uid() = non_neg_integer()

user_data()

user_data() = term()

Function Index

add/3
add/4
close/1
create/2
create/3
extract/1
extract/2
format_error/1
init/3
open/2
t/1
table/1
table/2
tt/1

Function Details

add/3

add(TarDescriptor, Name, Options) -> ok | {error, term()}

add/4

add(TarDescriptor, Filename, NameInArchive, Options) -> ok | {error, term()}

close/1

close(TarDescriptor::tar_descriptor()) -> ok | {error, term()}

create/2

create(Name::file:filename_all(), FileList::filelist()) -> ok | {error, {string(), term()}}

create/3

create(Name::file:filename_all(), FileList::filelist(), Options::[create_opt()]) -> ok | {error, term()} | {error, {string(), term()}}

extract/1

extract(Open::open_type()) -> ok | {error, term()}

extract/2

extract(Open::open_type(), Opts::[]) -> ok | {error, term()}

extract(Open::open_type(), Opts::[extract_opt(), ...]) -> ok | {ok, [{string(), binary()}]} | {error, term()}

format_error/1

format_error(Atom::term()) -> string()

init/3

init(UserData::user_data(), AccessMode::write | read, Fun::file_op()) -> {ok, tar_descriptor()} | {error, badarg}

open/2

open(Open::open_type(), Mode::[write | compressed | cooked]) -> {ok, tar_descriptor()} | {error, term()}

t/1

t(Name::file:filename()) -> ok | {error, term()}

table/1

table(Open::open_type()) -> {ok, [name_in_archive()]} | {error, term()}

table/2

table(Open::open_type(), Opts::[compressed | verbose | cooked]) -> {ok, [name_in_archive() | tar_entry()]} | {error, term()}

tt/1

tt(Name::open_type()) -> ok | {error, term()}


Generated by EDoc