-
Notifications
You must be signed in to change notification settings - Fork 1
/
api_whole.html
99 lines (99 loc) · 5.09 KB
/
api_whole.html
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
<!-- HTML header for doxygen 1.8.10-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<title>librsync: Whole-file API</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- ad -->
<script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
<!-- librsync -->
<ins class="adsbygoogle"
style="display:block"
data-ad-client="ca-pub-3547096055927362"
data-ad-slot="8322976738"
data-ad-format="auto"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">librsync
 <span id="projectnumber">2.3.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div><div class="header">
<div class="headertitle"><div class="title">Whole-file API </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p ><a class="anchor" id="md_doc_whole"></a> Some applications do not require the fine-grained control over IO, but rather just want to process a whole file with a single call. librsync provides whole-file APIs to do exactly that.</p>
<p >These functions open files, process the entire contents, and return an overall result. The whole-file operations are the core of the <a class="el" href="page_rdiff.html">rdiff command</a>.</p>
<p >This interface is implemented on top of the <a class="el" href="api_streaming.html">Streaming API</a>. Processing of a whole file begins with creation of a <a class="el" href="librsync_8h.html#add6622b38e3fa557301a190876d5ed4a" title="Job of work to be done.">rs_job_t</a> object for the appropriate operation, just as if the application was going to do buffering itself. After creation, the job may be passed to <a class="el" href="whole_8h.html#afd9c4b5694a88c0a835f0b3b0f8cbf91" title="Run a job continuously, with input to/from the two specified files.">rs_whole_run()</a>, which will feed it to and from two FILEs as necessary until end of file is reached or the operation completes.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="librsync_8h.html#a3c4c3fcea2814610109536f3ae029c5e" title="Get or check signature arguments for a given file size.">rs_sig_args()</a> </dd>
<dd>
<a class="el" href="librsync_8h.html#a2e111b9ef4acef02f812ec58b8217c8c" title="Generate the signature of a basis file, and write it out to another.">rs_sig_file()</a> </dd>
<dd>
<a class="el" href="librsync_8h.html#a69a679a66bcf4b35b3e22ca0e9791c02" title="Load signatures from a signature file into memory.">rs_loadsig_file()</a> </dd>
<dd>
<a class="el" href="librsync_8h.html#a633e49044273bd2b7c1ce568b52b7e91" title="Generate a delta between a signature and a new file into a delta file.">rs_delta_file()</a> </dd>
<dd>
<a class="el" href="librsync_8h.html#a76f5d5851aaad2c17bfd9256e344626d" title="Apply a patch, relative to a basis, into a new file.">rs_patch_file()</a> </dd></dl>
</div></div><!-- contents -->
</div><!-- PageDoc -->
<!-- HTML footer for doxygen 1.8.10-->
<!-- start footer part -->
<!-- ad -->
<script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
<!-- librsync -->
<ins class="adsbygoogle"
style="display:block"
data-ad-client="ca-pub-3547096055927362"
data-ad-slot="8322976738"
data-ad-format="auto"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>
<!-- analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-71109100-1', 'auto');
ga('send', 'pageview');
</script>
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 19 2023 16:26:51 for librsync by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.9.4
</small></address>
</body>
</html>