package bos

  1. Overview
  2. Docs

Module Bos_setup.Fmt

include module type of struct include Fmt end
val stdout : Format.formatter
val stderr : Format.formatter
val pf : Format.formatter -> ('a, Format.formatter, unit) format -> 'a
val pr : ('a, Format.formatter, unit) format -> 'a
val epr : ('a, Format.formatter, unit) format -> 'a
val str : ('a, Format.formatter, unit, string) format4 -> 'a
val kpf : (Format.formatter -> 'a) -> Format.formatter -> ('b, Format.formatter, unit, 'a) format4 -> 'b
val kstr : (string -> 'a) -> ('b, Format.formatter, unit, 'a) format4 -> 'b
val str_like : Format.formatter -> ('a, Format.formatter, unit, string) format4 -> 'a
val with_buffer : ?like:Format.formatter -> Buffer.t -> Format.formatter
val failwith : ('a, Format.formatter, unit, 'b) format4 -> 'a
val failwith_notrace : ('a, Format.formatter, unit, 'b) format4 -> 'a
val invalid_arg : ('a, Format.formatter, unit, 'b) format4 -> 'a
val error : ('b, Format.formatter, unit, ('a, string) result) format4 -> 'b
val error_msg : ('b, Format.formatter, unit, ('a, [> `Msg of string ]) result) format4 -> 'b
type !'a t = Format.formatter -> 'a -> unit
val flush : 'a t
val nop : 'a t
val any : (unit, Format.formatter, unit) format -> 'a t
val using : ('a -> 'b) -> 'b t -> 'a t
val const : 'a t -> 'a -> 'b t
val if' : bool -> 'a t -> 'a t
val fmt : ('a, Format.formatter, unit) format -> Format.formatter -> 'a
val cut : 'a t
val sp : 'a t
val sps : int -> 'a t
val comma : 'a t
val semi : 'a t
val append : 'a t -> 'a t -> 'a t
val (++) : 'a t -> 'a t -> 'a t
val concat : ?sep:unit t -> 'a t list -> 'a t
val iter : ?sep:unit t -> (('a -> unit) -> 'b -> unit) -> 'a t -> 'b t
val iter_bindings : ?sep:unit t -> (('a -> 'b -> unit) -> 'c -> unit) -> ('a * 'b) t -> 'c t
val box : ?indent:int -> 'a t -> 'a t
val hbox : 'a t -> 'a t
val vbox : ?indent:int -> 'a t -> 'a t
val hvbox : ?indent:int -> 'a t -> 'a t
val hovbox : ?indent:int -> 'a t -> 'a t
val parens : 'a t -> 'a t
val brackets : 'a t -> 'a t
val braces : 'a t -> 'a t
val quote : ?mark:string -> 'a t -> 'a t
val id : 'a -> 'a
val field : ?label:string t -> ?sep:unit t -> string -> ('b -> 'a) -> 'a t -> 'b t
val record : ?sep:unit t -> 'a t list -> 'a t
val bool : bool t
val int : int t
val nativeint : nativeint t
val int32 : int32 t
val int64 : int64 t
val uint : int t
val unativeint : nativeint t
val uint32 : int32 t
val uint64 : int64 t
val float : float t
val float_dfrac : int -> float t
val float_dsig : int -> float t
val char : char t
val string : string t
val buffer : Buffer.t t
val exn : exn t
val exn_backtrace : (exn * Printexc.raw_backtrace) t
val pair : ?sep:unit t -> 'a t -> 'b t -> ('a * 'b) t
val option : ?none:unit t -> 'a t -> 'a option t
val result : ok:'a t -> error:'b t -> ('a, 'b) result t
val list : ?sep:unit t -> 'a t -> 'a list t
val array : ?sep:unit t -> 'a t -> 'a array t
val seq : ?sep:unit t -> 'a t -> 'a Seq.t t
val hashtbl : ?sep:unit t -> ('a * 'b) t -> ('a, 'b) Hashtbl.t t
val queue : ?sep:unit t -> 'a t -> 'a Queue.t t
val stack : ?sep:unit t -> 'a t -> 'a Stack.t t
module Dump = Fmt.Dump
val si_size : scale:int -> string -> int t
val byte_size : int t
val bi_byte_size : int t
val uint64_ns_span : int64 t
type !'a vec = int * (int -> 'a)
val on_bytes : char vec t -> bytes t
val on_string : char vec t -> string t
val ascii : ?w:int -> ?subst:unit t -> unit -> char vec t
val octets : ?w:int -> ?sep:unit t -> unit -> char vec t
val addresses : ?addr:int t -> ?w:int -> 'a vec t -> 'a vec t
val hex : ?w:int -> unit -> char vec t
val words : string t
val paragraphs : string t
val text : string t
val lines : string t
val truncated : max:int -> string t
val text_loc : ((int * int) * (int * int)) t
val one_of : ?empty:unit t -> 'a t -> 'a list t
val did_you_mean : ?pre:unit t -> ?post:unit t -> kind:string -> 'a t -> ('a * 'a list) t
val if_utf_8 : 'a t -> 'a t -> 'a t
val utf_8 : Format.formatter -> bool
val set_utf_8 : Format.formatter -> bool -> unit
type color = [
  1. | `Black
  2. | `Blue
  3. | `Cyan
  4. | `Green
  5. | `Magenta
  6. | `Red
  7. | `White
  8. | `Yellow
]
type style = [
  1. | `Bg of [ `Black | `Blue | `Cyan | `Green | `Hi of color | `Magenta | `Red | `White | `Yellow ]
  2. | `Black
  3. | `Blue
  4. | `Bold
  5. | `Cyan
  6. | `Faint
  7. | `Fg of [ `Black | `Blue | `Cyan | `Green | `Hi of color | `Magenta | `Red | `White | `Yellow ]
  8. | `Green
  9. | `Italic
  10. | `Magenta
  11. | `None
  12. | `Red
  13. | `Reverse
  14. | `Underline
  15. | `White
  16. | `Yellow
]
val styled : style -> 'a t -> 'a t
type style_renderer = [
  1. | `Ansi_tty
  2. | `None
]
val style_renderer : Format.formatter -> style_renderer
val set_style_renderer : Format.formatter -> style_renderer -> unit
val of_to_string : ('a -> string) -> 'a t
val to_to_string : 'a t -> 'a -> string
val strf : ('a, Format.formatter, unit, string) format4 -> 'a
  • deprecated use Fmt.str instead.
val kstrf : (string -> 'a) -> ('b, Format.formatter, unit, 'a) format4 -> 'b
  • deprecated use Fmt.kstr instead.
val strf_like : Format.formatter -> ('a, Format.formatter, unit, string) format4 -> 'a
  • deprecated use Fmt.str_like instead.
val always : (unit, Format.formatter, unit) format -> 'a t
  • deprecated use Fmt.any instead.
val unit : (unit, Format.formatter, unit) format -> unit t
  • deprecated use Fmt.any instead.
val prefix : unit t -> 'a t -> 'a t
  • deprecated use Fmt.(++) instead.
val suffix : unit t -> 'a t -> 'a t
  • deprecated use Fmt.(++) instead.
val styled_unit : style -> (unit, Format.formatter, unit) format -> unit t
  • deprecated use Fmt.(styled s (any fmt)) instead.
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