mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
9 lines
No EOL
8.7 KiB
HTML
9 lines
No EOL
8.7 KiB
HTML
<!DOCTYPE html>
|
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCChar (containers.CCChar)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCChar</span></h1></header><h2>Utils around char</h2><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.14</li></ul><div class="spec include"><div class="doc"></div><details open="open"><summary><span class="def"><code><span class="keyword">include </span><span class="keyword">module type of </span><span class="keyword">sig</span> ... <span class="keyword">end</span></code></span></summary><div class="spec val" id="val-code"><a href="#val-code" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>code : char <span class="keyword">‑></span> int = "%identity" </code></div><div class="doc"></div></div><div class="spec val" id="val-chr"><a href="#val-chr" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>chr : int <span class="keyword">‑></span> char</code></div><div class="doc"></div></div><div class="spec val" id="val-escaped"><a href="#val-escaped" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>escaped : char <span class="keyword">‑></span> string</code></div><div class="doc"></div></div><div class="spec val" id="val-lowercase"><a href="#val-lowercase" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>lowercase : char <span class="keyword">‑></span> char</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag deprecated">Deprecated</span> Use Char.lowercase_ascii instead.</li></ul></div></div><div class="spec val" id="val-uppercase"><a href="#val-uppercase" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>uppercase : char <span class="keyword">‑></span> char</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag deprecated">Deprecated</span> Use Char.uppercase_ascii instead.</li></ul></div></div><div class="spec val" id="val-lowercase_ascii"><a href="#val-lowercase_ascii" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>lowercase_ascii : char <span class="keyword">‑></span> char</code></div><div class="doc"></div></div><div class="spec val" id="val-uppercase_ascii"><a href="#val-uppercase_ascii" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>uppercase_ascii : char <span class="keyword">‑></span> char</code></div><div class="doc"></div></div><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code><span class="keyword"> = </span>char</code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-compare"><a href="#val-compare" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>compare : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"></div></div><div class="spec val" id="val-equal"><a href="#val-equal" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>equal : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"></div></div><div class="spec val" id="val-unsafe_chr"><a href="#val-unsafe_chr" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>unsafe_chr : int <span class="keyword">‑></span> char = "%identity" </code></div><div class="doc"></div></div></details></div><div class="spec val" id="val-equal"><a href="#val-equal" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>equal : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p>The equal function for chars.</p></div></div><div class="spec val" id="val-compare"><a href="#val-compare" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>compare : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>The comparison function for characters, with the same specification as
|
|
<span class="xref-unresolved" title="unresolved reference to "Pervasives.compare"">Pervasives.compare</span>. Along with the type <code class="code">t</code>, this function <code class="code">compare</code>
|
|
allows the module <code class="code">Char</code> to be passed as argument to the functors
|
|
<span class="xref-unresolved" title="unresolved reference to "Set.Make"">Set.Make</span> and <span class="xref-unresolved" title="unresolved reference to "Map.Make"">Map.Make</span>.</p></div></div><div class="spec val" id="val-lowercase_ascii"><a href="#val-lowercase_ascii" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>lowercase_ascii : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Convert the given character to its equivalent lowercase character,
|
|
using the US-ASCII character set.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.20</li></ul></div></div><div class="spec val" id="val-uppercase_ascii"><a href="#val-uppercase_ascii" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>uppercase_ascii : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Convert the given character to its equivalent uppercase character,
|
|
using the US-ASCII character set.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.20</li></ul></div></div><div class="spec val" id="val-of_int_exn"><a href="#val-of_int_exn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_int_exn : int <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Alias to <span class="xref-unresolved" title="unresolved reference to "Char.chr"">Char.chr</span>.
|
|
Return the character with the given ASCII code.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Invalid_argument</span>: if the int is not within <code class="code">0,...,255</code>.</li><li><span class="at-tag since">Since</span>: 1.0</li></ul></div></div><div class="spec val" id="val-of_int"><a href="#val-of_int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_int : int <span class="keyword">‑></span> <a href="index.html#type-t">t</a> option</code></div><div class="doc"><p>Safe version of <a href="index.html#val-of_int_exn">of_int_exn</a>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.0</li></ul></div></div><div class="spec val" id="val-to_int"><a href="#val-to_int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_int : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Alias to <span class="xref-unresolved" title="unresolved reference to "Char.code"">Char.code</span>.
|
|
Return the ASCII code of the argument.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.0</li></ul></div></div><div class="spec val" id="val-pp_buf"><a href="#val-pp_buf" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp_buf : Buffer.t <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Renamed from <code class="code">pp</code> since 2.0.</p></div></div><div class="spec val" id="val-pp"><a href="#val-pp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp : Format.formatter <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Renamed from <code class="code">print</code> since 2.0.</p></div></div></body></html> |