package opam-lib

  1. Overview
  2. Docs
package opam-lib
Legend:
Library
Module
Module type
Parameter
Class
Class type

Global configuration parameters (read from OpamGlobalConfig, and the environment when necessary)

val debug : unit -> bool
val verbose : unit -> bool
val color : unit -> bool
val utf8 : unit -> bool
val utf8_extended : unit -> bool
val disp_status_line : unit -> bool

General text formatting

type text_style = [
  1. | `black
  2. | `blue
  3. | `bold
  4. | `cyan
  5. | `green
  6. | `magenta
  7. | `red
  8. | `underline
  9. | `white
  10. | `yellow
]

Settable attributes for ANSI terminal output. Nesting is generally not handled.

val colorise : text_style -> string -> string

Helper coloring functions. Returns the string unchanged if color is disabled

val acolor : text_style -> Stdlib.out_channel -> string -> unit
val acolor_w : int -> text_style -> Stdlib.out_channel -> string -> unit

Logging

val timer : unit -> unit -> float

Timers, only active when debug is on. Returns the time between the application to each argument, in seconds

val log : string -> ?level:int -> ('a, Stdlib.out_channel, unit) Stdlib.format -> 'a

log section ~level fmt args. Used for debug messages, default level is 1

val slog : ('a -> string) -> Stdlib.out_channel -> 'a -> unit

Helper to pass stringifiers to log (use log "%a" (slog to_string) x rather than log "%s" (to_string x) to avoid costly unneeded stringifications

val error : ('a, unit, string, unit) Stdlib.format4 -> 'a
val warning : ('a, unit, string, unit) Stdlib.format4 -> 'a
val note : ('a, unit, string, unit) Stdlib.format4 -> 'a
val errmsg : ('a, Stdlib.out_channel, unit, unit, unit, unit) Stdlib.format6 -> 'a

Message without prefix, reformat or newline, to stderr (useful to continue error messages without repeating "ERROR")

val error_and_exit : ?num:int -> ('a, unit, string, 'b) Stdlib.format4 -> 'a
val msg : ('a, Stdlib.out_channel, unit, unit) Stdlib.format4 -> 'a
val formatted_msg : ?indent:int -> ('a, unit, string, unit) Stdlib.format4 -> 'a
val header_msg : ('a, unit, string, unit) Stdlib.format4 -> 'a
val header_error : ('a, unit, string, ('b, unit, string, unit) Stdlib.format4 -> 'b) Stdlib.format4 -> 'a
val status_line : ('a, Stdlib.out_channel, unit, unit, unit, unit) Stdlib.format6 -> 'a

Display a dynamic status line to stdout, that will be erased on next output. The message should not be wider than screen nor contain newlines.

val confirm : ?default:bool -> ('a, unit, string, bool) Stdlib.format4 -> 'a

Ask the user to press Y/y/N/n to continue (returns a boolean). Defaults to true (yes) if unspecified

val read : ('a, unit, string, string option) Stdlib.format4 -> 'a

Read some input from the user (returns a string option)

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct