package biocaml

  1. Overview
  2. Docs
package biocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type

Streaming interface to the Zlib library.

The module deals with compressed streams.

Default Parameters

module Default : sig ... end

This module contains the default values for most optional parameters of the module.

Error Types

module Error : sig ... end

In_chanel.t Functions

val unzip_in_channel : ?format:[ `gzip | `raw ] -> ?zlib_buffer_size:int -> ?buffer_size:int -> Core.In_channel.t -> (string, [> Error.t ]) Core.result Stream.t

Decompress an Input Channel.

val zip_in_channel : ?format:[ `gzip | `raw ] -> ?zlib_buffer_size:int -> ?level:int -> ?buffer_size:int -> Core.In_channel.t -> string Stream.t

Compress an Input Channel.

exception Error of Error.unzip

The exception raise by the *_exn functions of this module.

val unzip_in_channel_exn : ?format:[ `gzip | `raw ] -> ?zlib_buffer_size:int -> ?buffer_size:int -> Core.In_channel.t -> string Stream.t

Like unzip_in_channel but calls to Stream.next may raise Error e exceptions.

Transform.t Implementations

module Transform : sig ... end