package progress

  1. Overview
  2. Docs
User-definable progress bars

Install

dune-project
 Dependency

Authors

Maintainers

Sources

progress-0.5.0.tbz
sha256=7f87f0597363928c45ba859ae5a1430f6aa3c29e251ff1a53cf786ed0e045961
sha512=45dee4fe2ae0b7fc3ca675f6e854d738873eb608ef9155ea5d7edac4639c183ae1f512847a1b43bdfc1f4c459e7d5b44d03ee809455797e680f890b33d531367

doc/progress.engine/Progress_engine/Make/Line/Internals/Line_buffer/index.html

Module Internals.Line_bufferSource

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
Sourceval 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.