~ubuntu-branches/ubuntu/natty/ocamlnet/natty

<pre><span class="keyword">module</span> Netbuffer: <code class="code">sig</code> <a href="Netbuffer.html">..</a> <code class="code">end</code></pre>A Netbuffer.t is a buffer that can grow and shrink dynamically.<br>

133

134

135

136

<pre><span class="keyword">val</span> <a name="VALcreate"></a>create : <code class="type">int -> <a href="Netbuffer.html#TYPEt">t</a></code></pre><div class="info">

137

Creates a netbuffer which allocates initially this number of bytes.

138

The logical length is zero.<br>

139

</div>

140

<pre><span class="keyword">val</span> <a name="VALcontents"></a>contents : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> string</code></pre><div class="info">

141

Returns the contents of the buffer as fresh string.<br>

142

</div>

143

<pre><span class="keyword">val</span> <a name="VALsub"></a>sub : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> int -> string</code></pre><div class="info">

144

<code class="code">sub nb k n</code>: returns the n characters starting at position <code class="code">n</code> from

145

netbuffer <code class="code">nb</code> as fresh string<br>

146

</div>

147

<pre><span class="keyword">val</span> <a name="VALblit"></a>blit : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> string -> int -> int -> unit</code></pre><div class="info">

148

<code class="code">blit nb srcpos dest destpos len</code>: Copies the <code class="code">len</code> bytes at

149

position <code class="code">srcpos</code> from <code class="code">nb</code> to the string <code class="code">dest</code> at position <code class="code">destpos</code>.<br>

150

</div>

151

<pre><span class="keyword">val</span> <a name="VALlength"></a>length : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int</code></pre><div class="info">

152

Returns the logical length of the buffer<br>

153

</div>

154

<pre><span class="keyword">val</span> <a name="VALadd_string"></a>add_string : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> string -> unit</code></pre><div class="info">

155

<code class="code">add_string nb s</code>: Adds a copy of the string <code class="code">s</code> to the logical end of

156

the netbuffer <code class="code">nb</code>. If necessary, <code class="code">nb</code> grows.<br>

157

</div>

158

<pre><span class="keyword">val</span> <a name="VALadd_sub_string"></a>add_sub_string : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> string -> int -> int -> unit</code></pre><div class="info">

159

<code class="code">add_sub_string nb s k n</code>: Adds the substring of <code class="code">s</code> starting at position

160

<code class="code">k</code> with length <code class="code">n</code> to the logical end of the netbuffer <code class="code">nb</code>. If necessary,

161

<code class="code">nb</code> grows.

162

<p>

163

164

This is semantically the same as

165

<code class="code">add_string nb (String.sub s k n)</code>, but the extra copy is avoided.<br>

166

</div>

167

<pre><span class="keyword">val</span> <a name="VALadd_inplace"></a>add_inplace : <code class="type">?len:int -> <a href="Netbuffer.html#TYPEt">t</a> -> (string -> int -> int -> int) -> int</code></pre><div class="info">

168

<code class="code">add_inplace nb f</code>: Calls the function <code class="code">f</code> to add bytes to the

169

netbuffer <code class="code">nb</code>. The arguments of <code class="code">f</code> are the buffer, the position

170

in the buffer, and the maximum length. The function <code class="code">f</code> must return

171

the actual number of added bytes; this number is also returned by

172

<code class="code">add_inplace</code>.

173

<p>

174

175

Example: let n = add_inplace nb (Pervasives.input ch)

176

<p>

177

178

The argument <code class="code">len</code> is the number of bytes to add (second argument of

179

<code class="code">f</code>). It defaults to the number of free bytes in the buffer after space

180

for at least one byte has been allocated.<br>

181

</div>

182

<pre><span class="keyword">val</span> <a name="VALinsert_string"></a>insert_string : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> string -> unit</code></pre><div class="info">

183

<code class="code">insert_string nb p s</code>: Inserts the value of string <code class="code">s</code> at position

184

<code class="code">p</code> into the netbuffer <code class="code">nb</code><br>

185

</div>

186

<pre><span class="keyword">val</span> <a name="VALinsert_sub_string"></a>insert_sub_string : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> string -> int -> int -> unit</code></pre><div class="info">

187

<code class="code">insert_string nb p s k n</code>: Inserts a substring of string <code class="code">s</code> at position

188

<code class="code">p</code> into the netbuffer <code class="code">nb</code>. The substring is denoted by position <code class="code">k</code>

189

and has length <code class="code">n</code><br>

190

</div>

191

<pre><span class="keyword">val</span> <a name="VALinsert_char"></a>insert_char : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> char -> unit</code></pre><div class="info">

192

<code class="code">insert_char nb p c</code>: Inserts character <code class="code">c</code> at position <code class="code">p</code> into

193

the netbuffer <code class="code">nb</code><br>

194

</div>

195

<pre><span class="keyword">val</span> <a name="VALdelete"></a>delete : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> int -> unit</code></pre><div class="info">

196

<code class="code">delete nb k n</code>: Deletes the <code class="code">n</code> bytes at position <code class="code">k</code> of netbuffer

197

<code class="code">nb</code> in-place.

198

<p>

199

200

The netbuffer does not shrink, however, i.e. the free space is not

201

given back to the memory manager.<br>

202

</div>

203

<pre><span class="keyword">val</span> <a name="VALclear"></a>clear : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> unit</code></pre><div class="info">

204

Deletes all contents from the buffer. As <code class="code">delete</code>, the netbuffer does

205

not shrink.<br>

206

</div>

207

<pre><span class="keyword">val</span> <a name="VALtry_shrinking"></a>try_shrinking : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> unit</code></pre><div class="info">

208

<code class="code">try_shrinking nb</code>: If the length of the buffer is less than half of

209

the allocated space, the netbuffer is reallocated in order to save

210

memory.<br>

211

</div>

212

<pre><span class="keyword">val</span> <a name="VALindex_from"></a>index_from : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> char -> int</code></pre><div class="info">

213

<code class="code">index_from nb k c</code>: Searches the character <code class="code">c</code> in the netbuffer beginning

214

at position <code class="code">k</code>. If found, the position of the left-most occurence is

215

returned. Otherwise, <code class="code">Not_found</code> is raised.<br>

216

</div>

217

<pre><span class="keyword">val</span> <a name="VALunsafe_buffer"></a>unsafe_buffer : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> string</code></pre><div class="info">

218

<b>Warning! This is a low-level function!</b>

219

Returns the current string that internally holds the buffer.

220

The byte positions 0 to length - 1 actually store the contents of

221

the buffer. You can directly read and modify the buffer. Note that

222

there is no protection if you read or write positions beyond the

223

length of the buffer.<br>

224

</div>

225

<pre><span class="keyword">val</span> <a name="VALprint_buffer"></a>print_buffer : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> unit</code></pre><div class="info">

226

For the toploop<br>

227

</div>

228

</body></html>

b'\\ No newline at end of file'

Older »