/* Copyright (C) 2007 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <giomm/outputstream.h>
#include <giomm/seekable.h>
#include <giomm/fileinfo.h>
#include <glibmm/object.h>
#include <glibmm/iochannel.h>
_DEFS(giomm,gio)
_PINCLUDE(giomm/private/outputstream_p.h)
namespace Gio
{
/** FileOutputStream provides output streams that write their content to a file.
*
* FileOutputStream implements Seekable, which allows the output stream to jump
* to arbitrary positions in the file and to truncate the file, provided the
* file system of the file supports these operations.
* Use the methods of the Seekable base class for seeking and positioning.
*
* @ingroup Streams
*
* @newin{2,16}
*/
class FileOutputStream
: public OutputStream,
public Seekable
{
_CLASS_GOBJECT(FileOutputStream, GFileOutputStream, G_FILE_OUTPUT_STREAM, Gio::OutputStream, GOutputStream)
_IMPLEMENTS_INTERFACE(Seekable)
public:
/** Queries a file output stream for the given @a attributes .
* This function blocks while querying the stream. For the asynchronous
* version of this function, see query_info_async().
* While the stream is blocked, the stream will set the pending flag
* internally, and any other operations on the stream will throw a Gio::Error with
* PENDING.
*
* Can fail if the stream was already closed (with a
* CLOSED error), the stream has pending operations (with a PENDING error),
* or if querying info is not supported for
* the stream's interface (with a NOT_SUPPORTED error). In
* all cases of failure, an empty RefPtr will be returned.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED may be thrown, and an empty RefPtr will
* be returned.
*
* @param cancellable A Cancellable object.
* @param attributes A file attribute query string.
* @return A FileInfo for the stream, or an empty RefPtr on error.
*/
Glib::RefPtr<FileInfo> query_info(const Glib::RefPtr<Cancellable>& cancellable, const std::string& attributes = "*");
/** Queries a file output stream for the given @a attributes .
* This function blocks while querying the stream. For the asynchronous
* version of this function, see query_info_async().
* While the stream is blocked, the stream will set the pending flag
* internally, and any other operations on the stream will throw a Gio::Error with
* PENDING.
*
* Can fail if the stream was already closed (with a CLOSED error),
* the stream has pending operations (with an PENDING error),
* or if querying info is not supported for
* the stream's interface (with a NOT_SUPPORTED error). In
* all cases of failure, an empty RefPtr will be returned.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED may be thrown, and an empty RefPtr will
* be returned.
*
* @param attributes A file attribute query string.
* @return A FileInfo for the stream, or an empty RefPtr on error.
*/
Glib::RefPtr<FileInfo> query_info(const std::string& attributes = "*");
_IGNORE(g_file_output_stream_query_info)
/** Queries the stream information asynchronously.
* When the operation is finished @a slot will be called.
* You can then call query_info_finish()
* to get the result of the operation.
*
* For the synchronous version of this function,
* see query_info().
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED may be thrown
*
* @param slot Callback to call when the request is satisfied.
* @param cancellable A Cancellable object.
* @param attributes A file attribute query string.
* @param io_priority The <io-priority of the request.
*/
void query_info_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, const std::string& attributes = "*", int io_priority = Glib::PRIORITY_DEFAULT);
/** Queries the stream information asynchronously.
* When the operation is finished @a slot will be called.
* You can then call query_info_finish()
* to get the result of the operation.
*
* For the synchronous version of this function,
* see query_info().
*
* @param slot Callback to call when the request is satisfied.
* @param attributes A file attribute query string.
* @param io_priority The <io-priority of the request.
*/
void query_info_async(const SlotAsyncReady& slot, const std::string& attributes = "*", int io_priority = Glib::PRIORITY_DEFAULT);
_IGNORE(g_file_output_stream_query_info_async)
_WRAP_METHOD(Glib::RefPtr<FileInfo> query_info_finish(const Glib::RefPtr<AsyncResult>& result),
g_file_output_stream_query_info_finish,
refreturn, errthrow)
_WRAP_METHOD(std::string get_etag() const, g_file_output_stream_get_etag)
};
} // namespace Gio