package stdune

  1. Overview
  2. Docs
package stdune
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Console.Status_lineSource

Status line management

Sourcetype t =
  1. | Live of unit -> User_message.Style.t Pp.t
    (*

    A "live" value that's updated continuously, such as a progress indicator. This message is not shown when a "dumb" terminal backend is in use.

    *)
  2. | Constant of User_message.Style.t Pp.t
    (*

    A fixed value. Unlike with Live, this text is printed even if a dumb console backend is in use.

    *)

The current status line

Sourceval set : t -> unit
Sourceval clear : unit -> unit

Clear the current status line

Sourcetype overlay
Sourceval add_overlay : t -> overlay

Add an overlay on top of the current status line. set and clear remove any active overlay.

Sourceval remove_overlay : overlay -> unit

Remove an overlay if it is still active. Do nothing otherwise.

Sourceval with_overlay : t -> f:(unit -> 'a) -> 'a

with_overlay t ~f is the same as:

  let id = add_overlay t in
  Exn.protect f ~finally:(fun () -> remove_overlay id)
Sourceval refresh : unit -> unit
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