From d7214345e59bef7cb72dda1c3343e3116823b4df Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Tue, 8 Feb 2022 12:58:08 -0500 Subject: [PATCH] update doc and aliases --- README.md | 6 +++++- src/core/containers.ml | 2 +- src/core/containersLabels.ml | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cc0584c6..8c645e51 100644 --- a/README.md +++ b/README.md @@ -431,7 +431,7 @@ map = - : string option = Some "33" ``` -### New types: `CCVector`, `CCHeap`, `CCResult`, `CCSexp` +### New types: `CCVector`, `CCHeap`, `CCResult`, `CCSexp`, `CCByte_buffer` Containers also contains (!) a few datatypes that are not from the standard library but that are useful in a lot of situations: @@ -458,6 +458,10 @@ library but that are useful in a lot of situations: functorized printer and parser for S-expressions, respectively as actual S-expressions (like `sexplib`) and as canonical binary-safe S-expressions (like `csexp`) +- `CCByte_buffer`: a better version of the standard `Buffer.t` which cannot be + extended and prevents access to its internal byte array. This type is + designed for (blocking) IOs and to produce complex strings incrementally + in an efficient way. Now for a few examples: diff --git a/src/core/containers.ml b/src/core/containers.ml index 3d7951e2..17ea3de2 100644 --- a/src/core/containers.ml +++ b/src/core/containers.ml @@ -5,7 +5,7 @@ module Array = CCArray module Bool = CCBool -module Byte_buf = CCByte_buf +module Byte_buffer = CCByte_buffer module Char = CCChar module Equal = CCEqual module Either = CCEither diff --git a/src/core/containersLabels.ml b/src/core/containersLabels.ml index a320761f..29f8716f 100644 --- a/src/core/containersLabels.ml +++ b/src/core/containersLabels.ml @@ -5,7 +5,7 @@ module Array = CCArrayLabels module Bool = CCBool -module Byte_buf = CCByte_buf +module Byte_buffer = CCByte_buffer module Char = CCChar module Equal = CCEqualLabels module Either = CCEither