librdf0-dev 1.0.17-1.1 / usr / share / gtk-doc / html / librdf / redland-digest.html

This file is indexed.

/usr/share/gtk-doc/html/librdf/redland-digest.html is in librdf0-dev 1.0.17-1.1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Digests</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Redland RDF Library Manual">
<link rel="up" href="reference-manual.html" title="Part II. Reference Manual">
<link rel="prev" href="redland-concepts.html" title="Concepts">
<link rel="next" href="redland-files.html" title="Files">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="redland-concepts.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="reference-manual.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Redland RDF Library Manual</th>
<td><a accesskey="n" href="redland-files.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#redland-digest.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#redland-digest.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="redland-digest"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="redland-digest.top_of_page"></a>Digests</span></h2>
<p>Digests — Content digests.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="redland-digest.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">typedef             <a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest">librdf_digest</a>;
typedef             <a class="link" href="redland-digest.html#librdf-digest-factory" title="librdf_digest_factory">librdf_digest_factory</a>;
<a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="returnvalue">librdf_digest</span></a> *     <a class="link" href="redland-digest.html#librdf-new-digest" title="librdf_new_digest ()">librdf_new_digest</a>                   (<em class="parameter"><code><a class="link" href="redland-world.html#librdf-world" title="librdf_world"><span class="type">librdf_world</span></a> *world</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="redland-digest.html#librdf-free-digest" title="librdf_free_digest ()">librdf_free_digest</a>                  (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="redland-digest.html#librdf-digest-init" title="librdf_digest_init ()">librdf_digest_init</a>                  (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="redland-digest.html#librdf-digest-update" title="librdf_digest_update ()">librdf_digest_update</a>                (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>,
                                                         <em class="parameter"><code>const unsigned <span class="type">char</span> *buf</code></em>,
                                                         <em class="parameter"><code><span class="type">size_t</span> length</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="redland-digest.html#librdf-digest-update-string" title="librdf_digest_update_string ()">librdf_digest_update_string</a>         (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>,
                                                         <em class="parameter"><code>const unsigned <span class="type">char</span> *string</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="redland-digest.html#librdf-digest-final" title="librdf_digest_final ()">librdf_digest_final</a>                 (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>);
<span class="returnvalue">void</span> *              <a class="link" href="redland-digest.html#librdf-digest-get-digest" title="librdf_digest_get_digest ()">librdf_digest_get_digest</a>            (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>);
<span class="returnvalue">size_t</span>              <a class="link" href="redland-digest.html#librdf-digest-get-digest-length" title="librdf_digest_get_digest_length ()">librdf_digest_get_digest_length</a>     (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>);
<span class="returnvalue">char</span> *              <a class="link" href="redland-digest.html#librdf-digest-to-string" title="librdf_digest_to_string ()">librdf_digest_to_string</a>             (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="redland-digest.html#librdf-digest-print" title="librdf_digest_print ()">librdf_digest_print</a>                 (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>,
                                                         <em class="parameter"><code><span class="type">FILE</span> *fh</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="redland-digest.description"></a><h2>Description</h2>
<p>
Create a message digest over a block of data.  Includes implementations
of MD5, RMD160 and SHA1.
</p>
</div>
<div class="refsect1">
<a name="redland-digest.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="librdf-digest"></a><h3>librdf_digest</h3>
<pre class="programlisting">typedef struct librdf_digest_s librdf_digest;
</pre>
<p>
Redland content digest class.
</p>
</div>
<hr>
<div class="refsect2">
<a name="librdf-digest-factory"></a><h3>librdf_digest_factory</h3>
<pre class="programlisting">typedef struct librdf_digest_factory_s librdf_digest_factory;
</pre>
<p>
Redland digest factory class.
</p>
</div>
<hr>
<div class="refsect2">
<a name="librdf-new-digest"></a><h3>librdf_new_digest ()</h3>
<pre class="programlisting"><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="returnvalue">librdf_digest</span></a> *     librdf_new_digest                   (<em class="parameter"><code><a class="link" href="redland-world.html#librdf-world" title="librdf_world"><span class="type">librdf_world</span></a> *world</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
<p>
Constructor - create a new <a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> object.
</p>
<p>
After construction, data should be added to the digest using
<a class="link" href="redland-digest.html#librdf-digest-update" title="librdf_digest_update ()"><span class="type">librdf_digest_update</span></a> or <a class="link" href="redland-digest.html#librdf-digest-update-string" title="librdf_digest_update_string ()"><span class="type">librdf_digest_update_string</span></a> with
<a class="link" href="redland-digest.html#librdf-digest-final" title="librdf_digest_final ()"><span class="type">librdf_digest_final</span></a> to signify finishing.  Then the digest
value can be returned directly with <a class="link" href="redland-digest.html#librdf-digest-get-digest" title="librdf_digest_get_digest ()"><span class="type">librdf_digest_get_digest</span></a>
of <a class="link" href="redland-digest.html#librdf-digest-get-digest-length" title="librdf_digest_get_digest_length ()"><span class="type">librdf_digest_get_digest_length</span></a> bytes or as a hex encoded
string with <a class="link" href="redland-digest.html#librdf-digest-to-string" title="librdf_digest_to_string ()"><span class="type">librdf_digest_to_string</span></a>.  The digest can be
re-initialised for new data with <a class="link" href="redland-digest.html#librdf-digest-init" title="librdf_digest_init ()"><span class="type">librdf_digest_init</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>world</code></em> :</span></p></td>
<td>redland world object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the digest name to use to create this digest</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>new <a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> object or NULL</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-free-digest"></a><h3>librdf_free_digest ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                librdf_free_digest                  (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>);</pre>
<p>
Destructor - destroy a <a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td>
<td>the digest</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-digest-init"></a><h3>librdf_digest_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                librdf_digest_init                  (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>);</pre>
<p>
(Re)initialise the librdf_digest object.
</p>
<p>
This is automatically called on construction but can be used to
re-initialise the digest to the initial state for digesting new
data.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td>
<td>the digest</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-digest-update"></a><h3>librdf_digest_update ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                librdf_digest_update                (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>,
                                                         <em class="parameter"><code>const unsigned <span class="type">char</span> *buf</code></em>,
                                                         <em class="parameter"><code><span class="type">size_t</span> length</code></em>);</pre>
<p>
Add more data to the librdf_digest object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td>
<td>the digest</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
<td>the data buffer</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td>the length of the data</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-digest-update-string"></a><h3>librdf_digest_update_string ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                librdf_digest_update_string         (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>,
                                                         <em class="parameter"><code>const unsigned <span class="type">char</span> *string</code></em>);</pre>
<p>
Add a string to the librdf_digest object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td>
<td>the digest</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
<td>string to add</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-digest-final"></a><h3>librdf_digest_final ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                librdf_digest_final                 (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>);</pre>
<p>
Finish the digesting of data.
</p>
<p>
The digest can now be returned via <a class="link" href="redland-digest.html#librdf-digest-get-digest" title="librdf_digest_get_digest ()"><code class="function">librdf_digest_get_digest()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td>
<td>the digest</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-digest-get-digest"></a><h3>librdf_digest_get_digest ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> *              librdf_digest_get_digest            (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>);</pre>
<p>
Get the calculated digested value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td>
<td>the digest</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>pointer to the memory containing the digest.  It will
be <a class="link" href="redland-digest.html#librdf-digest-get-digest-length" title="librdf_digest_get_digest_length ()"><span class="type">librdf_digest_get_digest_length</span></a> bytes in length.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-digest-get-digest-length"></a><h3>librdf_digest_get_digest_length ()</h3>
<pre class="programlisting"><span class="returnvalue">size_t</span>              librdf_digest_get_digest_length     (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>);</pre>
<p>
Get length of the calculated digested.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td>
<td>the digest</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>size of the digest in bytes</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-digest-to-string"></a><h3>librdf_digest_to_string ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *              librdf_digest_to_string             (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>);</pre>
<p>
Get a string representation of the digest object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td>
<td>the digest</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly allocated string that represents the digest.
This must be released by the caller using <a class="link" href="redland-general.html#librdf-free-memory" title="librdf_free_memory ()"><code class="function">librdf_free_memory()</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-digest-print"></a><h3>librdf_digest_print ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                librdf_digest_print                 (<em class="parameter"><code><a class="link" href="redland-digest.html#librdf-digest" title="librdf_digest"><span class="type">librdf_digest</span></a> *digest</code></em>,
                                                         <em class="parameter"><code><span class="type">FILE</span> *fh</code></em>);</pre>
<p>
Print the digest to a FILE handle.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td>
<td>the digest</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fh</code></em> :</span></p></td>
<td>file handle</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.