File: Xmlm.Buffer.html

package info (click to toggle)
xmlm 1.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 424 kB
  • ctags: 670
  • sloc: ml: 1,770; sh: 90; makefile: 19
file content (60 lines) | stat: -rw-r--r-- 3,261 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Xmlm.String.html">
<link rel="next" href="Xmlm.S.html">
<link rel="Up" href="Xmlm.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Xmlm" rel="Chapter" href="Xmlm.html"><title>Xmlm.Buffer</title>
</head>
<body>
<div class="navbar"><a href="Xmlm.String.html">Previous</a>
&nbsp;<a href="Xmlm.html">Up</a>
&nbsp;<a href="Xmlm.S.html">Next</a>
</div>
<center><h1>Module type <a href="type_Xmlm.Buffer.html">Xmlm.Buffer</a></h1></center>
<br>
<pre><span class="keyword">module type</span> Buffer = <code class="code"><span class="keyword">sig</span></code> <a href="Xmlm.Buffer.html">..</a> <code class="code"><span class="keyword">end</span></code></pre>Input signature for internal buffers.<br>
<hr width="100%">
<pre><span class="keyword">type</span> <a name="TYPEstring"></a><code class="type"></code>string </pre>
<div class="info">
The type for strings.<br>
</div>

<pre><span class="keyword">type</span> <a name="TYPEt"></a><code class="type"></code>t </pre>
<div class="info">
The type for buffers.<br>
</div>

<pre><span class="keyword">exception</span> <a name="EXCEPTIONFull"></a>Full</pre>
<div class="info">
Raised if the buffer cannot be grown.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcreate"></a>create : <code class="type">int -> <a href="Xmlm.Buffer.html#TYPEt">t</a></code></pre><div class="info">
Creates a buffer of the given size.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALadd_uchar"></a>add_uchar : <code class="type"><a href="Xmlm.Buffer.html#TYPEt">t</a> -> int -> unit</code></pre><div class="info">
Adds the given (guaranteed valid) unicode
      <a href="http://www.unicode.org/glossary/#code_point">code point</a> to a
      buffer. 
<p>

      <b>Raises</b> <a href="Xmlm.Buffer.html#EXCEPTIONFull"><code class="code"><span class="constructor">Xmlm</span>.<span class="constructor">Buffer</span>.<span class="constructor">Full</span></code></a> if the buffer cannot be grown.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALclear"></a>clear : <code class="type"><a href="Xmlm.Buffer.html#TYPEt">t</a> -> unit</code></pre><div class="info">
Clears the buffer.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcontents"></a>contents : <code class="type"><a href="Xmlm.Buffer.html#TYPEt">t</a> -> <a href="Xmlm.Buffer.html#TYPEstring">string</a></code></pre><div class="info">
Returns the buffer contents.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALlength"></a>length : <code class="type"><a href="Xmlm.Buffer.html#TYPEt">t</a> -> int</code></pre><div class="info">
Returns the number of characters contained in the buffer.<br>
</div>
</body></html>