package tar-eio

  1. Overview
  2. Docs
Decode and encode tar format files using Eio

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (3)

Authors

  1. D
    Dave Scott
  2. T
    Thomas Gazagnaire
  3. David Allsopp
  4. A
    Antonin Décimo
  5. R
    Reynir Björnsson
  6. H
    Hannes Mehnert

Maintainers

  1. R
    Reynir Björnsson <reynir@reynir.dk>
  2. D
    dave@recoil.org

Sources

tar-3.5.0.tbz
sha256=85a2a61d30eef81e4bf81e0b429d213ceb5dd6eaedcd60c979e1cbb91149f90c
sha512=07949e3ed9d95744e8e9e1744863aa3b791cb0ac24bcee8b9cdb0b942eb56fe2a3dfc933f6e94ebc8c0274ee77cf16377e63150231985382a460b20469ef2c01

doc/tar-eio/Tar_eio/index.html

Module Tar_eioSource

Eio Tar

This library provides low-level and high-level abstractions for reading and writing Tar files using Eio.

Sourcetype t
Sourcetype flow

A type for reading or writing tar files to.

Sourceval flow_of_two_way : _ Eio.Flow.two_way -> flow

Construct a flow from an Eio.Flow.two_way. Use flow_of_file if your flow is really a file.

Sourceval flow_of_file : _ Eio.File.rw -> flow

Construct a flow from an Eio.File.rw. If you are using a file it is best to use this function as the seek operations will be more efficient.

Sourcetype decode_error = [
  1. | `Fatal of Tar.error
  2. | `Unexpected_end_of_file
  3. | `Msg of string
]

Possible decoding errors

Sourceval pp_decode_error : decode_error Fmt.t

A pretty-printer for decoding errors.

High-level Interface

Sourceval extract : ?filter:(Tar.Header.t -> bool) -> sw:Eio.Switch.t -> Eio.Fs.dir_ty Eio.Path.t -> (unit, [> `Fatal of Tar.error ], t) Tar.t

extract ~sw dst produces a Tar.t that will extract to dst. For example:

Eio.Path.with_open_out ~create:`Never foo_tar_gz @@ fun src ->
Eio.Switch.run @@ fun sw ->
let t = Tar_eio.extract ~sw (env#cwd / "foo.out") in
(* optional gzip: let t = Tar_gz.in_gzipped t in *)
Tar_eio.run t (Tar_eio.flow_of_file src)

will extract the file at foo_tar_gz into the directory at "foo.out". Note that this function only creates files, directories and symlinks with the correct mode (it does not, yet, set the ownership of the files according to the tar file).

All operations, in particular the Tar_eio.run must be completed inside the scope of the Eio.Switch.t sw.

  • parameter filter

    Can be used to exclude certain entries based on their header.

Sourceval create : ?level:Tar.Header.compatibility -> ?global:Tar.Header.Extended.t -> ?filter:(Tar.Header.t -> bool) -> sw:Eio.Switch.t -> _ Eio.Path.t -> (unit, [> `Msg of string ], 'b) Tar.t

create ~sw dir is the opposite of extract. It returns a Tar.t of the supplied dir that is only valid for the scope of the function.

Common usage might be tarring a directory to a new file.

let foo = Eio.Path.(cwd / "foo") in
let foo_tar = Eio.Path.(cwd / "foo.tar") in
Eio.Path.with_open_out ~create:(`Or_truncate 0o755) foo_tar @@ fun foo_tar ->
Eio.Switch.run @@ fun sw ->
let t = Tar_eio.create ~sw foo in
Tar_eio.run t (Tar_eio.flow_of_file tar)
  • parameter filter

    Can be used to exclude certain entries based on their header.

Sourceval run : ('a, [> `Unexpected_end_of_file | `Msg of string ] as 'b, t) Tar.t -> flow -> ('a, 'b) result

run tar src will run the given tar using Eio on src.

Sourceval fold : (?global:Tar.Header.Extended.t -> Tar.Header.t -> 'acc -> ('acc, [> `Fatal of Tar.error | `Unexpected_end_of_file | `Msg of string ] as 'b, t) Tar.t) -> flow -> 'acc -> ('acc, 'b) result

fold f src init folds over the tarred src.

Low-level Interface

Sourceval value : ('a, 'err) result -> ('a, 'err, t) Tar.t

Converts a normal result into Tars IO type

Sourceval append_file : ?level:Tar.Header.compatibility -> ?header:Tar.Header.t -> Eio.Fs.dir_ty Eio.Path.t -> _ Eio.Flow.sink -> (unit, [> decode_error ]) result

append_file dst sink

Sourceval header_of_file : ?level:Tar.Header.compatibility -> ?getpwuid:(int64 -> string) -> ?getgrgid:(int64 -> string) -> Eio.Fs.dir_ty Eio.Path.t -> Tar.Header.t

Return the header needed for a particular file on disk. getpwuid and getgrgid are optional functions that should take the uid and gid respectively and return the passwd and group entry names for each. These will be added to the header.

Sourceval write_header : ?level:Tar.Header.compatibility -> Tar.Header.t -> _ Eio.Flow.sink -> (unit, [> decode_error ]) result
Sourceval write_global_extended_header : ?level:Tar.Header.compatibility -> Tar.Header.Extended.t -> _ Eio.Flow.sink -> (unit, [> decode_error ]) result
Sourceval write_end : _ Eio.Flow.sink -> unit