package tar

  1. Overview
  2. Docs

Parameters

module Async : ASYNC
module Reader : READER with type 'a t = 'a Async.t

Signature

val read : ?level:Header.compatibility -> Reader.in_channel -> (Header.t, [ `Eof ]) result Async.t

Returns the next header block or throws Header.End_of_stream if two consecutive zero-filled blocks are discovered. Assumes stream is positioned at the possible start of a header block.

  • raises Header.End_of_stream

    if the stream unexpectedly fails.