Module Core_kernel.Rope

A rope is a standard data structure that represents a single string as a tree of strings, allowing concatenation to do no work up front.

That is, a string formed by many Rope concatenations followed by a to_string needs only copy each input to the output once, whereas a string expression looking like a ^ b ^ c ^ ... ^ z must create an intermediate string for every concatenation, and will copy the original data into and out of short-lived temporary strings many times.

On the other hand, because String.concat [ s1; s2; s3; ... ] allocates a single string and copies the inputs into it, Rope is no improvement over that usage. Rope becomes useful when the construction of the sequence of strings is more complex -- a good example is prettyprinting an expression language, where you need to parenthesize subexpressions (appending a short string at both ends) and handle infix binary operators (appending two long strings both made up of many parts, with a short string in between).

Any operations that would produce a Rope longer than String.max_length raise instead. They are not marked with _exn on their names since (at least on 64-bit) this number is far in excess of the size of your memory, so isn't likely to come up in practice.

A more fully-featured Rope implementation is available in the zed library.

type t
val of_string : Core_kernel__.Import.string ‑> t

Takes O(1) time. The string isn't copied, so don't mutate it.

val empty : t
val is_empty : t ‑> Core_kernel__.Import.bool
val length : t ‑>
val to_string : t ‑> Core_kernel__.Import.string

Allocates a fresh string, so takes time proportional to the total size of the result.

val (^) : t ‑> t ‑> t

These take time proportional to the number of t's passed.

val concat : ?⁠sep:t ‑> t Core_kernel__.Import.list ‑> t
val concat_array : ?⁠sep:t ‑> t Core_kernel__.Import.array ‑> t
val add_to_buffer : t ‑> Buffer.t ‑> Core_kernel__.Import.unit

Appends the contents of the Rope at the end of a destination buffer.