linol/uutf/index.html
2025-08-24 01:27:17 +00:00

2 lines
2.8 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (uutf.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../index.html">Index</a> &#x00BB; uutf</nav><header class="odoc-preamble"><h1 id="package-uutf"><a href="#package-uutf" class="anchor"></a>Package uutf <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><p><b>Warning.</b> You are encouraged not to use this library.</p><ul><li>As of OCaml 4.14, both UTF encoding and decoding are available in the standard library, see the <code>String</code> and <code>Buffer</code> modules.</li><li>If you are looking for a stream abstraction compatible with effect based concurrency look into the <a href="https://erratique.ch/software/bytesrw">bytesrw</a> package.</li></ul><p>Uutf is a non-blocking streaming codec to decode and encode the UTF-8, UTF-16, UTF-16LE and UTF-16BE encoding schemes. It can efficiently work character by character without blocking on IO. Decoders perform character position tracking and support newline normalization.</p><p>Functions are also provided to fold over the characters of UTF encoded OCaml string values and to directly encode characters in OCaml <code>Buffer.t</code> values.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#library_uutf">Library <code>uutf</code></a></li><li><a href="#package_info">Package info</a></li></ul></nav></div><div class="odoc-content"><h2 id="library_uutf"><a href="#library_uutf" class="anchor"></a>Library <code>uutf</code></h2><ul class="modules"><li><a href="Uutf/index.html"><code>Uutf</code></a> <span class="synopsis">Non-blocking streaming Unicode codec.</span></li></ul><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-license-files"><td><a href="#info-license-files" aria-hidden="true" class="anchor"></a>license-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/LICENSE.md">LICENSE.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>