···1+This project uses (perhaps the development version of) [`b0`] for
2+development. Consult [b0 occasionally] for quick hints on how to
3+perform common development tasks.
4+5+[`b0`]: https://erratique.ch/software/b0
6+[b0 occasionally]: https://erratique.ch/software/b0/doc/occasionally.html
+19-25
README.md
···1Uutf — Non-blocking streaming Unicode codec for OCaml
2--------------------------------------------------------------------------------
3-%%VERSION%%
0000000045Uutf is a non-blocking streaming codec to decode and encode the UTF-8,
6UTF-16, UTF-16LE and UTF-16BE encoding schemes. It can efficiently
···910Functions are also provided to fold over the characters of UTF encoded
11OCaml string values and to directly encode characters in OCaml
12-Buffer.t values. **Note** that since OCaml 4.14, that functionality
13-can be found in the Stdlib and you are encouraged to migrate to it.
1415Uutf has no dependency and is distributed under the ISC license.
1617-Home page: http://erratique.ch/software/uutf
18-Contact: Daniel Bünzli `<daniel.buenzl i@erratique.ch>`
0192021## Installation
···27If you don't use `opam` consult the [`opam`](opam) file for build
28instructions.
2930-31## Documentation
3233-The documentation and API reference is automatically generated by from
34-the source interfaces. It can be consulted [online][doc] or via
35-`odig doc uutf`.
36-37-[doc]: http://erratique.ch/software/uutf/doc/
38-39-40-## Sample programs
41-42-Sample programs are located in the `test` directory of the
43-distribution. They can be built and run with:
44-45- topkg build --test true && topkg test
4647-The resulting binaries are in `_build/test` :
04849-- `test.native` tests the library, nothing should fail.
50-- `utftrip.native`, among other things, reads unicode on `stdin` and rewrites
51- it on `stdout`. Invoke with `--help` for more information. Depends
52- on [Cmdliner](http://erratique.ch/software/cmdliner).
···1Uutf — Non-blocking streaming Unicode codec for OCaml
2+=====================================================
3+4+**Warning.** You are encouraged not to use this library.
5+6+- As of OCaml 4.14, both UTF encoding and decoding are available
7+ in the standard library, see the `String` and `Buffer` modules.
8+- If you are looking for a stream abstraction compatible with
9+ effect based concurrency look into [`bytesrw`] package.
10+11+---
1213Uutf is a non-blocking streaming codec to decode and encode the UTF-8,
14UTF-16, UTF-16LE and UTF-16BE encoding schemes. It can efficiently
···1718Functions are also provided to fold over the characters of UTF encoded
19OCaml string values and to directly encode characters in OCaml
20+Buffer.t values.
02122Uutf has no dependency and is distributed under the ISC license.
2324+Home page: <http://erratique.ch/software/uutf>
25+26+[`bytesrw`]: https://erratique.ch/software/bytesrw
272829## Installation
···35If you don't use `opam` consult the [`opam`](opam) file for build
36instructions.
37038## Documentation
3940+The documentation can be consulted [online] or via `odig doc uutf`.
0000000000004142+Questions are welcome but better asked on the [OCaml forum] than on the
43+issue tracker.
4445+[online]: http://erratique.ch/software/uutf/doc/
46+[OCaml forum]: https://discuss.ocaml.org/
00
-3
_tags
···1true : bin_annot, safe_string
2-3<_b0> : -traverse
4<src> : include
5-<test> : include
6<test/utftrip.*> : package(unix), package(cmdliner)
7-<test/examples.*> : package(unix)
···1{0 Uutf {%html: <span class="version">%%VERSION%%</span>%}}
20000000003Uutf is a non-blocking streaming codec to decode and encode the UTF-8,
4UTF-16, UTF-16LE and UTF-16BE encoding schemes. It can efficiently
5work character by character without blocking on IO. Decoders perform
···78Functions are also provided to fold over the characters of UTF encoded
9OCaml string values and to directly encode characters in OCaml
10-{!Buffer.t} values. {b Note} that since OCaml 4.14, that functionality
11-can be found in the Stdlib and you are encouraged to migrate to it.
1213-{1:api API}
1415{!modules:
16Uutf
···1{0 Uutf {%html: <span class="version">%%VERSION%%</span>%}}
23+{b Warning.} You are encouraged not to use this library.
4+5+{ul
6+{- As of OCaml 4.14, both UTF encoding and decoding are available
7+ in the standard library, see the {!String} and {!Buffer} modules.}
8+{- If you are looking for a stream abstraction compatible with
9+ effect based concurrency look into the
10+ {{:https://erratique.ch/software/bytesrw}bytesrw} package.}}
11+12Uutf is a non-blocking streaming codec to decode and encode the UTF-8,
13UTF-16, UTF-16LE and UTF-16BE encoding schemes. It can efficiently
14work character by character without blocking on IO. Decoders perform
···1617Functions are also provided to fold over the characters of UTF encoded
18OCaml string values and to directly encode characters in OCaml
19+{!Buffer.t} values.
02021+{1:library_uutf Library [uutf]}
2223{!modules:
24Uutf
+32-28
opam
···1opam-version: "2.0"
2name: "uutf"
3-synopsis: """Non-blocking streaming Unicode codec for OCaml"""
4-maintainer: ["Daniel Bünzli <daniel.buenzl i@erratique.ch>"]
5-authors: ["The uutf programmers"]
0000000006homepage: "https://erratique.ch/software/uutf"
7doc: "https://erratique.ch/software/uutf/doc/"
8-dev-repo: "git+https://erratique.ch/repos/uutf.git"
9bug-reports: "https://github.com/dbuenzli/uutf/issues"
10-license: ["ISC"]
11-tags: ["unicode" "text" "utf-8" "utf-16" "codec" "org:erratique"]
12-depends: ["ocaml" {>= "4.03.0"}
13- "ocamlfind" {build}
14- "ocamlbuild" {build}
15- "topkg" {build & >= "1.0.3"}]
16depopts: ["cmdliner"]
17-conflicts: ["cmdliner" {< "1.1.0"}]
18-build: [["ocaml" "pkg/pkg.ml" "build" "--dev-pkg" "%{dev}%"
19- "--with-cmdliner" "%{cmdliner:installed}%"]]
20-description: """
21-Uutf is a non-blocking streaming codec to decode and encode the UTF-8,
22-UTF-16, UTF-16LE and UTF-16BE encoding schemes. It can efficiently
23-work character by character without blocking on IO. Decoders perform
24-character position tracking and support newline normalization.
25-26-Functions are also provided to fold over the characters of UTF encoded
27-OCaml string values and to directly encode characters in OCaml
28-Buffer.t values. **Note** that since OCaml 4.14, that functionality
29-can be found in the Stdlib and you are encouraged to migrate to it.
30-31-Uutf has no dependency and is distributed under the ISC license.
32-33-Home page: http://erratique.ch/software/uutf
34-Contact: Daniel Bünzli `<daniel.buenzl i@erratique.ch>`"""
···1opam-version: "2.0"
2name: "uutf"
3+synopsis: "Non-blocking streaming Unicode codec for OCaml"
4+description: """\
5+**Warning.** You are encouraged not to use this library.
6+7+- As of OCaml 4.14, both UTF encoding and decoding are available
8+ in the standard library, see the `String` and `Buffer` modules.
9+- If you are looking for a stream abstraction compatible with
10+ effect based concurrency look into [`bytesrw`] package."""
11+maintainer: "Daniel Bünzli <daniel.buenzl i@erratique.ch>"
12+authors: "The uutf programmers"
13+license: "ISC"
14+tags: ["unicode" "text" "utf-8" "utf-16" "codec" "org:erratique"]
15homepage: "https://erratique.ch/software/uutf"
16doc: "https://erratique.ch/software/uutf/doc/"
017bug-reports: "https://github.com/dbuenzli/uutf/issues"
18+depends: [
19+ "ocaml" {>= "4.08.0"}
20+ "ocamlfind" {build}
21+ "ocamlbuild" {build}
22+ "topkg" {build & >= "1.0.3"}
23+]
24depopts: ["cmdliner"]
25+conflicts: [
26+ "cmdliner" {< "1.3.0"}
27+]
28+build: [
29+ "ocaml"
30+ "pkg/pkg.ml"
31+ "build"
32+ "--dev-pkg"
33+ "%{dev}%"
34+ "--with-cmdliner"
35+ "%{cmdliner:installed}%"
36+]
37+dev-repo: "git+https://erratique.ch/repos/uutf.git"
38+x-maintenance-intent: ["(latest)"]
0000