package bio_io

You can search for identifiers within the package.

in-package search v0.2.0

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Private.Peekable_in_channel`Source

A wrapper of Jane Street's Stdio.In_channel. Add's peek_char and peek_line functions that work on fifos as well as regular files.

Used internally for bio input channels so that you can pipe directly from gzip even in channels that need peeking.

Differences from Stdio.In_channel

Some functions are not implemented.

Sourcetype t

Sourceval equal : t -> t -> Base.bool

Sourceval stdin : t

Sourceval create : Base.string -> t

Sourceval close : t -> Base.unit

Sourceval with_file : Base.string -> f:(t -> 'a) -> 'a

Sourceval input_all : t -> Base.string

Sourceval input_line : ?fix_win_eol:Base.bool -> t -> Base.string Base.option

Sourceval input_line_exn : ?fix_win_eol:Base.bool -> t -> Base.string

val fold_lines : 
  ?fix_win_eol:Base.bool ->
  t ->
  init:'a ->
  f:('a -> Base.string -> 'a) ->
  'a

Sourceval input_lines : ?fix_win_eol:Base.bool -> t -> Base.string Base.list

val iter_lines : 
  ?fix_win_eol:Base.bool ->
  t ->
  f:(Base.string -> Base.unit) ->
  Base.unit

Sourceval read_lines : ?fix_win_eol:Base.bool -> Base.string -> Base.string Base.list

Sourceval read_all : Base.string -> Base.string

Both peek functions are safe to call in the context of one of the iterator functions.

Sourceval peek_char : ?fix_win_eol:Base.bool -> t -> Base.char Base.option

Sourceval peek_line : ?fix_win_eol:Base.bool -> t -> Base.string Base.option