package ocamline

You can search for identifiers within the package.

in-package search v0.2.0

ocamline
- Ocamline

Legend:
Library
Module
Module type
Parameter
Class
Class type

val read : 
  ?trim_delim:bool ->
  ?brackets:(char * char) list ->
  ?prompt:string ->
  ?strings:char list ->
  ?history_loc:string ->
  ?hints_callback:(string -> (string * LNoise.hint_color * bool) option) ->
  ?completion_callback:(string -> LNoise.completions -> unit) ->
  ?delim:string ->
  unit ->
  string

read ?trim_delim ?brackets ?prompt ?strings ?history_loc ?hints_callback ?completion_callback ?delim () will read input from stdin until a new line or delim string is encountered. Occurrences of delim not at the end of the line will not stop the input process. If delim is an empty string, it will return on new lines.

trim_delim: Whether or not to remove the line delimiter from the return value.

brackets: Any characters that once opened must be closed before the line is accepted.

prompt: Customizes the prompt displayed to the user.

strings: If brackets are in strings, they won't have to be closed.

history_loc: The location to save the user's history of commands (used by Linenoise).

hints_callback: Linenoise's hints_callback

completion_callback: Linenoise's completion_callback

delim: The string that, when found, halts scanning and returns the input.

Default values:

trim_delim = false

brackets=[]

prompt=">"

strings=[]

history_loc=".ocamline_history.txt"

hints_callback=No op

completion_callback=No op

delim="" (* new lines *))