package gapi-ocaml

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

This class adds a buffer to the underlying raw_in_channel. * As additional feature, the method enhanced_input_line is a fast * version of input_line that profits from the buffer. * *

  • parameter eol

    The accepted end-of-line delimiters. The method * enhanced_input_line recognizes any of the passed strings as EOL * delimiters. When more than one delimiter matches, the longest * is taken. Defaults to ["\n"] . Note that input_line * always only recognizes "\n" as EOL character, this cannot * be changed. * The delimiter strings must neither be empty, nor longer than * buffer_size. *

    @param buffer_size

    The size of the buffer, by default 4096. *

    @param pass_through

    If the read request has at least this size, * and the buffer is currently empty, the buffer will be bypassed. * Defaults to max_int, i.e. it is off.

method private enhanced_input_line : unit -> string

An improved implementation of input_line that uses the buffer

method private enhanced_input : Bytes.t -> int -> int -> input_result

An improved implementation of input_line that uses the buffer

Works similar to input, but distinguishes between normal data * and end-of-line separators. The latter are returned as * `Separator s. When normal data is found, it is copied to the * string, and `Data n is returned to indicate that n bytes * were copied.

OCaml

Innovation. Community. Security.