package csv-lwt

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

Lwt interface to the CSV library.

This module only offers Lwt input/output functions for CSV files. Csv provides additional functions to transform CSV data.

type t = Csv.t

Input

type in_channel

Stateful handle to input CSV files.

val of_channel : ?separator:char -> ?strip:bool -> ?has_header:bool -> ?header:string list -> ?backslash_escape:bool -> ?excel_tricks:bool -> ?fix:bool -> Lwt_io.input_channel -> in_channel Lwt.t
val load : ?separator:char -> ?strip:bool -> ?backslash_escape:bool -> ?excel_tricks:bool -> ?fix:bool -> string -> t Lwt.t
val load_in : ?separator:char -> ?strip:bool -> ?backslash_escape:bool -> ?excel_tricks:bool -> ?fix:bool -> Lwt_io.input_channel -> t Lwt.t
val close_in : in_channel -> unit Lwt.t

close_in ic closes the channel ic. The underlying channel is closed as well.

val next : in_channel -> string list Lwt.t
val fold_left : f:('a -> string list -> 'a Lwt.t) -> init:'a -> in_channel -> 'a Lwt.t
val fold_right : f:(string list -> 'a -> 'a Lwt.t) -> in_channel -> 'a -> 'a Lwt.t
val iter : f:(string list -> unit Lwt.t) -> in_channel -> unit Lwt.t

See Csv.inter.

val current_record : in_channel -> string list

Output

type out_channel
val to_channel : ?separator:char -> ?backslash_escape:bool -> ?excel_tricks:bool -> ?quote_all:bool -> Lwt_io.output_channel -> out_channel
val close_out : out_channel -> unit Lwt.t
val output_record : out_channel -> string list -> unit Lwt.t
val output_all : out_channel -> t -> unit Lwt.t
val save : ?separator:char -> ?backslash_escape:bool -> ?excel_tricks:bool -> ?quote_all:bool -> string -> t -> unit Lwt.t
val print : ?separator:char -> ?backslash_escape:bool -> ?excel_tricks:bool -> ?quote_all:bool -> t -> unit Lwt.t

Functions to access rows when a header is present

module Row : module type of Csv.Row

Represent a row with header. Compatible with Csv.Row.

module Rows : sig ... end