package biocaml

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Default Parameters
Error Types
In_chanel.t Functions
Transform.t Implementations

The OCaml Bioinformatics Library

Install

dune-project

Dependency

biocaml.org Readme Edit opam file Versions (5)

Authors

Maintainers

B

biocaml@googlegroups.com

Sources

v0.10.1.tar.gz

md5=4cf944bcae5d36bf47b67f6bcb2455d7

sha512=0262b5768aefd7c080f664c46c88876fce9a658cc6a87358a77b7112c49ae3042e7ab542e76be5738fbaeda853149b308b48d4897960b5c7ae3b4da71d978bd8

doc/biocaml.unix/Biocaml_unix/Zip/index.html

Module `Biocaml_unix.Zip`

Streaming interface to the Zlib library.

The module deals with compressed streams.

The DEFLATE compression algorithm is defined in the RFC 1951.
GZIP file-format is defined in the RFC 1952 (c.f. also wikipedia:Gzip).

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_kernel.In_channel.t ->
  (string, [> Error.t ]) Core_kernel.result Stream.t

Decompress an Input Channel.

val zip_in_channel : 
  ?format:[ `gzip | `raw ] ->
  ?zlib_buffer_size:int ->
  ?level:int ->
  ?buffer_size:int ->
  Core_kernel.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_kernel.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