← Back to branch summary

~dernils/duplicity/documentation

« back to all changes in this revision

Viewing changes to docs/_build/html/duplicity.librsync.html

  • Committer: Kenneth Loafman
  • Date: 2017-03-06 12:26:12 UTC
  • Revision ID: kenneth@loafman.com-20170306122612-2fb02i3x2jeqd8u9
Refresh docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/_build/html/duplicity.librsync.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
2
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
3
 
 
4
 
 
5
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
 
6
  <head>
 
7
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
8
    
 
9
    <title>duplicity.librsync module &#8212; duplicity  documentation</title>
 
10
    
 
11
    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
 
12
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
13
    
 
14
    <script type="text/javascript">
 
15
      var DOCUMENTATION_OPTIONS = {
 
16
        URL_ROOT:    './',
 
17
        VERSION:     '',
 
18
        COLLAPSE_INDEX: false,
 
19
        FILE_SUFFIX: '.html',
 
20
        HAS_SOURCE:  true,
 
21
        SOURCELINK_SUFFIX: '.txt'
 
22
      };
 
23
    </script>
 
24
    <script type="text/javascript" src="_static/jquery.js"></script>
 
25
    <script type="text/javascript" src="_static/underscore.js"></script>
 
26
    <script type="text/javascript" src="_static/doctools.js"></script>
 
27
    <link rel="index" title="Index" href="genindex.html" />
 
28
    <link rel="search" title="Search" href="search.html" />
 
29
    <link rel="next" title="duplicity.log module" href="duplicity.log.html" />
 
30
    <link rel="prev" title="duplicity.lazy module" href="duplicity.lazy.html" />
 
31
   
 
32
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
 
33
  
 
34
  
 
35
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
36
 
 
37
  </head>
 
38
  <body role="document">
 
39
  
 
40
 
 
41
    <div class="document">
 
42
      <div class="documentwrapper">
 
43
        <div class="bodywrapper">
 
44
          <div class="body" role="main">
 
45
            
 
46
  <div class="section" id="module-duplicity.librsync">
 
47
<span id="duplicity-librsync-module"></span><h1>duplicity.librsync module<a class="headerlink" href="#module-duplicity.librsync" title="Permalink to this headline">¶</a></h1>
 
48
<p>Provides a high-level interface to some librsync functions</p>
 
49
<p>This is a python wrapper around the lower-level _librsync module,
 
50
which is written in C.  The goal was to use C as little as possible...</p>
 
51
<dl class="class">
 
52
<dt id="duplicity.librsync.DeltaFile">
 
53
<em class="property">class </em><code class="descclassname">duplicity.librsync.</code><code class="descname">DeltaFile</code><span class="sig-paren">(</span><em>signature</em>, <em>new_file</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/duplicity/librsync.html#DeltaFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#duplicity.librsync.DeltaFile" title="Permalink to this definition">¶</a></dt>
 
54
<dd><p>Bases: <a class="reference internal" href="#duplicity.librsync.LikeFile" title="duplicity.librsync.LikeFile"><code class="xref py py-class docutils literal"><span class="pre">duplicity.librsync.LikeFile</span></code></a></p>
 
55
<p>File-like object which incrementally generates a librsync delta</p>
 
56
</dd></dl>
 
57
 
 
58
<dl class="class">
 
59
<dt id="duplicity.librsync.LikeFile">
 
60
<em class="property">class </em><code class="descclassname">duplicity.librsync.</code><code class="descname">LikeFile</code><span class="sig-paren">(</span><em>infile</em>, <em>need_seek=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/duplicity/librsync.html#LikeFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#duplicity.librsync.LikeFile" title="Permalink to this definition">¶</a></dt>
 
61
<dd><p>File-like object used by SigFile, DeltaFile, and PatchFile</p>
 
62
<dl class="method">
 
63
<dt id="duplicity.librsync.LikeFile.check_file">
 
64
<code class="descname">check_file</code><span class="sig-paren">(</span><em>file</em>, <em>need_seek=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/duplicity/librsync.html#LikeFile.check_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#duplicity.librsync.LikeFile.check_file" title="Permalink to this definition">¶</a></dt>
 
65
<dd><p>Raise type error if file doesn&#8217;t have necessary attributes</p>
 
66
</dd></dl>
 
67
 
 
68
<dl class="method">
 
69
<dt id="duplicity.librsync.LikeFile.close">
 
70
<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/duplicity/librsync.html#LikeFile.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#duplicity.librsync.LikeFile.close" title="Permalink to this definition">¶</a></dt>
 
71
<dd><p>Close infile</p>
 
72
</dd></dl>
 
73
 
 
74
<dl class="attribute">
 
75
<dt id="duplicity.librsync.LikeFile.maker">
 
76
<code class="descname">maker</code><em class="property"> = None</em><a class="headerlink" href="#duplicity.librsync.LikeFile.maker" title="Permalink to this definition">¶</a></dt>
 
77
<dd></dd></dl>
 
78
 
 
79
<dl class="attribute">
 
80
<dt id="duplicity.librsync.LikeFile.mode">
 
81
<code class="descname">mode</code><em class="property"> = 'rb'</em><a class="headerlink" href="#duplicity.librsync.LikeFile.mode" title="Permalink to this definition">¶</a></dt>
 
82
<dd></dd></dl>
 
83
 
 
84
<dl class="method">
 
85
<dt id="duplicity.librsync.LikeFile.read">
 
86
<code class="descname">read</code><span class="sig-paren">(</span><em>length=-1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/duplicity/librsync.html#LikeFile.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#duplicity.librsync.LikeFile.read" title="Permalink to this definition">¶</a></dt>
 
87
<dd><p>Build up self.outbuf, return first length bytes</p>
 
88
</dd></dl>
 
89
 
 
90
</dd></dl>
 
91
 
 
92
<dl class="class">
 
93
<dt id="duplicity.librsync.PatchedFile">
 
94
<em class="property">class </em><code class="descclassname">duplicity.librsync.</code><code class="descname">PatchedFile</code><span class="sig-paren">(</span><em>basis_file</em>, <em>delta_file</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/duplicity/librsync.html#PatchedFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#duplicity.librsync.PatchedFile" title="Permalink to this definition">¶</a></dt>
 
95
<dd><p>Bases: <a class="reference internal" href="#duplicity.librsync.LikeFile" title="duplicity.librsync.LikeFile"><code class="xref py py-class docutils literal"><span class="pre">duplicity.librsync.LikeFile</span></code></a></p>
 
96
<p>File-like object which applies a librsync delta incrementally</p>
 
97
</dd></dl>
 
98
 
 
99
<dl class="class">
 
100
<dt id="duplicity.librsync.SigFile">
 
101
<em class="property">class </em><code class="descclassname">duplicity.librsync.</code><code class="descname">SigFile</code><span class="sig-paren">(</span><em>infile</em>, <em>blocksize=2048</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/duplicity/librsync.html#SigFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#duplicity.librsync.SigFile" title="Permalink to this definition">¶</a></dt>
 
102
<dd><p>Bases: <a class="reference internal" href="#duplicity.librsync.LikeFile" title="duplicity.librsync.LikeFile"><code class="xref py py-class docutils literal"><span class="pre">duplicity.librsync.LikeFile</span></code></a></p>
 
103
<p>File-like object which incrementally generates a librsync signature</p>
 
104
</dd></dl>
 
105
 
 
106
<dl class="class">
 
107
<dt id="duplicity.librsync.SigGenerator">
 
108
<em class="property">class </em><code class="descclassname">duplicity.librsync.</code><code class="descname">SigGenerator</code><span class="sig-paren">(</span><em>blocksize=2048</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/duplicity/librsync.html#SigGenerator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#duplicity.librsync.SigGenerator" title="Permalink to this definition">¶</a></dt>
 
109
<dd><p>Calculate signature.</p>
 
110
<p>Input and output is same as SigFile, but the interface is like md5
 
111
module, not filelike object</p>
 
112
<dl class="method">
 
113
<dt id="duplicity.librsync.SigGenerator.getsig">
 
114
<code class="descname">getsig</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/duplicity/librsync.html#SigGenerator.getsig"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#duplicity.librsync.SigGenerator.getsig" title="Permalink to this definition">¶</a></dt>
 
115
<dd><p>Return signature over given data</p>
 
116
</dd></dl>
 
117
 
 
118
<dl class="method">
 
119
<dt id="duplicity.librsync.SigGenerator.process_buffer">
 
120
<code class="descname">process_buffer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/duplicity/librsync.html#SigGenerator.process_buffer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#duplicity.librsync.SigGenerator.process_buffer" title="Permalink to this definition">¶</a></dt>
 
121
<dd><p>Run self.buffer through sig_maker, add to self.sig_string</p>
 
122
</dd></dl>
 
123
 
 
124
<dl class="method">
 
125
<dt id="duplicity.librsync.SigGenerator.update">
 
126
<code class="descname">update</code><span class="sig-paren">(</span><em>buf</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/duplicity/librsync.html#SigGenerator.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#duplicity.librsync.SigGenerator.update" title="Permalink to this definition">¶</a></dt>
 
127
<dd><p>Add buf to data that signature will be calculated over</p>
 
128
</dd></dl>
 
129
 
 
130
</dd></dl>
 
131
 
 
132
<dl class="exception">
 
133
<dt id="duplicity.librsync.librsyncError">
 
134
<em class="property">exception </em><code class="descclassname">duplicity.librsync.</code><code class="descname">librsyncError</code><a class="reference internal" href="_modules/duplicity/librsync.html#librsyncError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#duplicity.librsync.librsyncError" title="Permalink to this definition">¶</a></dt>
 
135
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></code></p>
 
136
<p>Signifies error in internal librsync processing (bad signature, etc.)</p>
 
137
<p>underlying _librsync.librsyncError&#8217;s are regenerated using this
 
138
class because the C-created exceptions are by default
 
139
unPickleable.  There is probably a way to fix this in _librsync,
 
140
but this scheme was easier.</p>
 
141
</dd></dl>
 
142
 
 
143
</div>
 
144
 
 
145
 
 
146
          </div>
 
147
        </div>
 
148
      </div>
 
149
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 
150
        <div class="sphinxsidebarwrapper"><div class="relations">
 
151
<h3>Related Topics</h3>
 
152
<ul>
 
153
  <li><a href="index.html">Documentation overview</a><ul>
 
154
  <li><a href="duplicity.html">duplicity package</a><ul>
 
155
      <li>Previous: <a href="duplicity.lazy.html" title="previous chapter">duplicity.lazy module</a></li>
 
156
      <li>Next: <a href="duplicity.log.html" title="next chapter">duplicity.log module</a></li>
 
157
  </ul></li>
 
158
  </ul></li>
 
159
</ul>
 
160
</div>
 
161
  <div role="note" aria-label="source link">
 
162
    <h3>This Page</h3>
 
163
    <ul class="this-page-menu">
 
164
      <li><a href="_sources/duplicity.librsync.rst.txt"
 
165
            rel="nofollow">Show Source</a></li>
 
166
    </ul>
 
167
   </div>
 
168
<div id="searchbox" style="display: none" role="search">
 
169
  <h3>Quick search</h3>
 
170
    <form class="search" action="search.html" method="get">
 
171
      <div><input type="text" name="q" /></div>
 
172
      <div><input type="submit" value="Go" /></div>
 
173
      <input type="hidden" name="check_keywords" value="yes" />
 
174
      <input type="hidden" name="area" value="default" />
 
175
    </form>
 
176
</div>
 
177
<script type="text/javascript">$('#searchbox').show(0);</script>
 
178
        </div>
 
179
      </div>
 
180
      <div class="clearer"></div>
 
181
    </div>
 
182
    <div class="footer">
 
183
      &copy;2016, Kenneth Loafman and Duplicity Team.
 
184
      
 
185
      |
 
186
      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.2</a>
 
187
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
 
188
      
 
189
      |
 
190
      <a href="_sources/duplicity.librsync.rst.txt"
 
191
          rel="nofollow">Page source</a>
 
192
    </div>
 
193
 
 
194
    
 
195
 
 
196
    
 
197
  </body>
 
198
</html>
 
 
b'\\ No newline at end of file'