package printbox

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Render to Text

package printbox

printbox
- PrintBox
  - Simple
- PrintBox_text

Legend:
Library
Module
Module type
Parameter
Class
Class type

Render to Text

This module should be used to output boxes directly to a terminal, or another area of monospace text

val set_string_len : (String.t -> int -> int -> int) -> unit

Set which function is used to compute string length. Typically to be used with a unicode-sensitive length function An example of such function for utf8 encoded strings is the following (it uses the Uutf library):

let string_leng s i len =
  Uutf.String.fold_utf_8 ~pos:i ~len (fun n _ _ -> n+1) 0 s

Note that this function assumes there is no newline character in the given string.

val to_string : PrintBox.t -> string

Returns a string representation of the given structure.

val output : ?indent:int -> out_channel -> PrintBox.t -> unit

Outputs the given structure on the channel.

val pp : Format.formatter -> PrintBox.t -> unit

Pretty-print the box into this formatter.

since 0.2