package progress

You can search for identifiers within the package.

in-package search v0.2.0

User-definable progress bars

Install

dune-project

Dependency

sha256=7ae7f5c5a2db88107d0b3fd37d5344f066921270a3e74d56dd13457feb9e586e

sha512=3828ac568e447e5f1e59450ee48491c256d8bc77abe234190e14e2db5be7b81f379837083f0eb28ea9572fce2781fd0addd7adc1701947c0b2de9d8319ace042

Sourcetype t

A line buffer is a variant of Stdlib.Buffer that supports skipping some section of the underlying bytestring when doing a write pass.

Sourceval create : size:int -> t

Create a line buffer with the given initial size.

Sourceval with_ppf : t -> (Format.formatter -> 'a) -> 'a

with_ppf buf f gives a view of buf as a formatter to f (and then flushes the formatter to buf).

Sourceval add_char : t -> char -> unit

Sourceval add_string : t -> string -> unit

Sourceval add_substring : t -> string -> off:int -> len:int -> unit

Sourceval add_line_buffer : dst:t -> src:t -> unit

val lift_write : 
  len:int ->
  write:('a -> into:bytes -> pos:int -> unit) ->
  (t -> 'a -> unit) Progress_engine__.Stdlib_ext.Staged.t

Sourceval contents : t -> [ `Clean of string | `Dirty of string ]

Reset the write head to the start of the buffer and return a copy of the intervening contents.

Sourceval reset : t -> unit

Sourcetype mark

Sourceval current_position : t -> mark

Get a mark of the current write head in the buffer.

Sourcemodule Span : sig ... end

Sourceval skip : t -> Span.t -> unit

Advance over a given span in the buffer.