wornvirtue
/
premiere-libtorrent
forked from premiere/premiere-libtorrent
1
0
Fork 0
Code Pull Requests Activity

updated torrent_info::remap_files docs

This commit is contained in:
Arvid Norberg 2007-08-25 19:57:32 +00:00
parent 2b0197e810
commit c8cb121587
2 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/manual.html
View File

@ -1072,16 +1072,17 @@ least one tracker url or at least one DHT node.</p>
<h2><a id="remap-files" name="remap-files">remap_files()</a></h2>
<blockquote>
<pre class="literal-block">
bool remap_files(std::vector&lt;std::string, libtorrent::size_type&gt; const&amp; map);
bool remap_files(std::vector&lt;std::pair&lt;std::string, libtorrent::size_type&gt; &gt; const&amp; map);
</pre>
</blockquote>
<p>This call will create a new mapping of the data in this torrent to other files. The
<tt class="docutils literal"><span class="pre">torrent_info</span></tt> maintains 2 views of the file storage. One that is true to the torrent
file, and one that represents what is actually saved on disk. This call will change
what the files on disk are called.</p>
<p>The each entry in the vector <tt class="docutils literal"><span class="pre">map</span></tt> is a pair of a (relative) file path and the file's size.</p>
<p>The return value indicates if the remap was successful or not. True means success and
false means failure. The only reason for failure is if the sum of all the files passed
in through <tt class="docutils literal"><span class="pre">map</span></tt> has to be exactly the same as the total_size of the torrent.</p>
false means failure. The sum of all the files passed in through <tt class="docutils literal"><span class="pre">map</span></tt> has to be exactly
the same as the total_size of the torrent.</p>
</div>
<div class="section">
<h2><a id="begin-files-end-files-rbegin-files-rend-files" name="begin-files-end-files-rbegin-files-rend-files">begin_files() end_files() rbegin_files() rend_files()</a></h2>

8
docs/manual.rst
View File

@ -987,16 +987,18 @@ remap_files()
::
bool remap_files(std::vector<std::string, libtorrent::size_type> const& map);
bool remap_files(std::vector<std::pair<std::string, libtorrent::size_type> > const& map);
This call will create a new mapping of the data in this torrent to other files. The
``torrent_info`` maintains 2 views of the file storage. One that is true to the torrent
file, and one that represents what is actually saved on disk. This call will change
what the files on disk are called.
The each entry in the vector ``map`` is a pair of a (relative) file path and the file's size.
The return value indicates if the remap was successful or not. True means success and
false means failure. The only reason for failure is if the sum of all the files passed
in through ``map`` has to be exactly the same as the total_size of the torrent.
false means failure. The sum of all the files passed in through ``map`` has to be exactly
the same as the total_size of the torrent.
begin_files() end_files() rbegin_files() rend_files()