From a10db6dad7c4ce4c91b8630d4b818ba88ba064ae Mon Sep 17 00:00:00 2001 From: Arvid Norberg Date: Sun, 30 Nov 2008 07:04:21 +0000 Subject: [PATCH] added missing documentation of torrent_handle::rename_file --- docs/manual.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/manual.rst b/docs/manual.rst index 38a0859b1..c96cf26bd 100644 --- a/docs/manual.rst +++ b/docs/manual.rst @@ -1710,6 +1710,7 @@ Its declaration looks like this:: boost::filesystem::path save_path() const; void move_storage(boost::filesystem::path const& save_path) const; + void rename_file(int index, boost::filesystem::path) const; storage_interface* get_storage_impl() const; sha1_hash info_hash() const; @@ -1841,6 +1842,16 @@ Since disk IO is performed in a separate thread, this operation is also asynchro Once the operation completes, the ``storage_moved_alert`` is generated, with the new path as the message. +rename_file() +------------- + + :: + + void rename_file(int index, boost::filesystem::path) const; + +Renames the file with the given index asynchronously. The rename operation is complete +when either a ``file_renamed_alert`` or ``file_rename_failed_alert`` is posted. + get_storage_impl() ------------------