package tar

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package tar

tar
- Tar
  - ASYNC
  - Header
    
    Extended
    
    Link
  - HeaderReader
    
    Async
    
    Reader
  - HeaderWriter
    
    Async
    
    Writer
  - IO
  - Make
    
    Archive
    
    IO
  - READER
  - WRITER
- Tar_cstruct
  - Archive
tar.gz
- Tar_gz
  - Make
    
    Async
    
    Reader
    
    Writer
  - READER

Legend:
Library
Module
Module type
Parameter
Class
Class type

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 ]) Stdlib.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.