hex_core v0.10.0

View Source hex_erl_tar (hex_core v0.10.0)

Link to this section Summary

Types

add_opt/0
add_type/0
create_opt/0
extract_opt/0
file_op/0
filelist/0
filename/0
gid/0
handle/0
header_gnu/0
header_v7/0
mode/0
open_handle/0
reader/0
reader_type/0
reg_file_reader/0
sparse_array/0
sparse_entry/0
sparse_file_reader/0
tar_entry/0
tar_header/0
tar_time/0
typeflag/0
uid/0

Functions

add(Reader, Name, Opts)
add(Reader, NameOrBin, NameInArchive, Options)
add(Reader, NameOrBin, NameInArchive, Mode, Options)
close(Reader)
create(Name, FileList)
create(Name, FileList, Options)
extract(Name)
extract(Reader, Opts)
format_error(Atom)
init(Handle, AccessMode, Fun)
open(Name, Mode)
t(Name)
table(Name)
table(Name, Opts)
tt(Name)

Link to this section Types

Link to this type

add_opt/0

View Source 
-type add_opt() ::
    dereference | verbose |
    {chunks, pos_integer()} |
    {atime, integer()} |
    {mtime, integer()} |
    {ctime, integer()} |
    {uid, integer()} |
    {gid, integer()}.
Link to this type

add_type/0

View Source 
-type add_type() :: string() | {string(), string()} | {string(), binary()}.
Link to this type

create_opt/0

View Source 
-type create_opt() :: compressed | cooked | dereference | verbose.
Link to this type

extract_opt/0

View Source 
-type extract_opt() ::
    {cwd, string()} |
    {files, [string()]} |
    compressed | cooked | memory | keep_old_files | verbose.
Link to this type

file_op/0

View Source 
-type file_op() ::
    fun((write | close | read2 | position,
         {handle(), iodata()} |
         handle() |
         {handle(), non_neg_integer()} |
         {handle(), non_neg_integer()}) ->
            ok | eof | {ok, string() | binary()} | {ok, non_neg_integer()} | {error, term()}).
Link to this type

filelist/0

View Source 
-type filelist() :: [file:filename() | {string(), binary()} | {string(), file:filename()}].
Link to this type

filename/0

View Source 
-type filename() :: string().
Link to this type

gid/0

View Source 
-type gid() :: non_neg_integer().
Link to this type

handle/0

View Source 
-type handle() :: file:io_device() | term().
Link to this type

header_gnu/0

View Source 
-type header_gnu() :: #header_gnu{}.
Link to this type

header_v7/0

View Source 
-type header_v7() :: #header_v7{}.
Link to this type

mode/0

View Source 
-type mode() :: non_neg_integer().
Link to this type

open_handle/0

View Source 
-type open_handle() :: file:filename() | {binary, binary()} | {file, term()}.
Link to this type

reader/0

View Source 
-type reader() :: #reader{}.
Link to this type

reader_type/0

View Source 
-type reader_type() :: reader() | reg_file_reader() | sparse_file_reader().
Link to this type

reg_file_reader/0

View Source 
-type reg_file_reader() :: #reg_file_reader{}.
Link to this type

sparse_array/0

View Source 
-type sparse_array() :: #sparse_array{}.
Link to this type

sparse_entry/0

View Source 
-type sparse_entry() :: #sparse_entry{}.
Link to this type

sparse_file_reader/0

View Source 
-type sparse_file_reader() :: #sparse_file_reader{}.
Link to this type

tar_entry/0

View Source 
-type tar_entry() :: {filename(), typeflag(), non_neg_integer(), tar_time(), mode(), uid(), gid()}.
Link to this type

tar_header/0

View Source 
-type tar_header() :: #tar_header{}.
Link to this type

tar_time/0

View Source 
-type tar_time() :: non_neg_integer().
Link to this type

typeflag/0

View Source 
-type typeflag() :: regular | link | symlink | char | block | directory | fifo | reserved | unknown.
Link to this type

uid/0

View Source 
-type uid() :: non_neg_integer().

Link to this section Functions

Link to this function

add(Reader, Name, Opts)

View Source 
-spec add(reader(), add_type(), [add_opt()]) -> ok | {error, term()}.
Link to this function

add(Reader, NameOrBin, NameInArchive, Options)

View Source 
-spec add(reader(), string() | binary(), string(), [add_opt()]) -> ok | {error, term()}.
Link to this function

add(Reader, NameOrBin, NameInArchive, Mode, Options)

View Source 
-spec add(reader(), string() | binary(), string(), integer(), [add_opt()]) -> ok | {error, term()}.
Link to this function

close(Reader)

View Source 
-spec close(reader()) -> ok | {error, term()}.
Link to this function

create(Name, FileList)

View Source 
-spec create(file:filename(), filelist()) -> ok | {error, {string(), term()}}.
Link to this function

create(Name, FileList, Options)

View Source 
-spec create(file:filename(), filelist(), [create_opt()]) ->
          ok | {error, term()} | {error, {string(), term()}}.
Link to this function

extract(Name)

View Source 
-spec extract(open_handle()) -> ok | {error, term()}.
Link to this function

extract(Reader, Opts)

View Source 
-spec extract(open_handle(), [extract_opt()]) -> ok | {ok, [{string(), binary()}]} | {error, term()}.
Link to this function

format_error(Atom)

View Source 
-spec format_error(term()) -> string().
Link to this function

init(Handle, AccessMode, Fun)

View Source 
-spec init(handle(), write | read, file_op()) -> {ok, reader()} | {error, badarg}.
Link to this function

open(Name, Mode)

View Source 
-spec open(open_handle(), [write | compressed | cooked]) -> {ok, reader()} | {error, term()}.
Link to this function

t(Name)

View Source 
-spec t(file:filename()) -> ok | {error, term()}.
Link to this function

table(Name)

View Source 
-spec table(open_handle()) -> {ok, [string()]} | {error, term()}.
Link to this function

table(Name, Opts)

View Source 
-spec table(open_handle(), [compressed | verbose | cooked]) -> {ok, [tar_entry()]} | {error, term()}.
Link to this function

tt(Name)

View Source 
-spec tt(open_handle()) -> ok | {error, term()}.