glib/gio/gfileoutputstream.h

/* GIO - GLib Input, Output and Streaming Library
 * 
 * Copyright (C) 2006-2007 Red Hat, Inc.
 *
 * 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 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, write to the
 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Author: Alexander Larsson <alexl@redhat.com>
 */

#ifndef __G_FILE_OUTPUT_STREAM_H__
#define __G_FILE_OUTPUT_STREAM_H__

#include <gio/goutputstream.h>
#include <gio/gfileinfo.h>

G_BEGIN_DECLS

#define G_TYPE_FILE_OUTPUT_STREAM         (g_file_output_stream_get_type ())
#define G_FILE_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStream))
#define G_FILE_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStreamClass))
#define G_IS_FILE_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_OUTPUT_STREAM))
#define G_IS_FILE_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_OUTPUT_STREAM))
#define G_FILE_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStreamClass))

/**
 * GFileOutputStream:
 *
 * A subclass of GOutputStream for opened files. This adds
 * a few file-specific operations and seeking and truncating.
 *
 * #GFileOutputStream implements GSeekable.
 **/
typedef struct _GFileOutputStream         GFileOutputStream;
typedef struct _GFileOutputStreamClass    GFileOutputStreamClass;
typedef struct _GFileOutputStreamPrivate  GFileOutputStreamPrivate;

struct _GFileOutputStream
{
  GOutputStream parent;
  
  /*< private >*/
  GFileOutputStreamPrivate *priv;
};

struct _GFileOutputStreamClass
{
  GOutputStreamClass parent_class;

  goffset    (*tell)          (GFileOutputStream     *stream);
  gboolean   (*can_seek)      (GFileOutputStream     *stream);
  gboolean   (*seek)	      (GFileOutputStream     *stream,
			       goffset               offset,
			       GSeekType             type,
			       GCancellable         *cancellable,
			       GError              **error);
  gboolean   (*can_truncate)  (GFileOutputStream    *stream);
  gboolean   (*truncate_fn)   (GFileOutputStream    *stream,
			       goffset               size,
			       GCancellable         *cancellable,
			       GError              **error);
  GFileInfo *(*query_info)    (GFileOutputStream    *stream,
			       char                 *attributes,
			       GCancellable         *cancellable,
			       GError              **error);
  void       (*query_info_async)  (GFileOutputStream     *stream,
				   char                 *attributes,
				   int                   io_priority,
				   GCancellable         *cancellable,
				   GAsyncReadyCallback   callback,
				   gpointer              user_data);
  GFileInfo *(*query_info_finish) (GFileOutputStream     *stream,
				   GAsyncResult         *res,
				   GError              **error);
  char      *(*get_etag)      (GFileOutputStream    *stream);
    
  /* Padding for future expansion */
  void (*_g_reserved1) (void);
  void (*_g_reserved2) (void);
  void (*_g_reserved3) (void);
  void (*_g_reserved4) (void);
  void (*_g_reserved5) (void);
};

GType g_file_output_stream_get_type (void) G_GNUC_CONST;


GFileInfo *g_file_output_stream_query_info (GFileOutputStream  *stream,
					    char               *attributes,
					    GCancellable       *cancellable,
					    GError            **error);
void       g_file_output_stream_query_info_async  (GFileOutputStream     *stream,
						   char                 *attributes,
						   int                   io_priority,
						   GCancellable         *cancellable,
						   GAsyncReadyCallback   callback,
						   gpointer              user_data);
GFileInfo *g_file_output_stream_query_info_finish (GFileOutputStream     *stream,
						   GAsyncResult         *result,
						   GError              **error);
char *     g_file_output_stream_get_etag      (GFileOutputStream  *stream);
goffset    g_file_output_stream_tell          (GFileOutputStream  *stream);
gboolean   g_file_output_stream_can_seek      (GFileOutputStream  *stream);
gboolean   g_file_output_stream_seek          (GFileOutputStream  *stream,
					       goffset             offset,
					       GSeekType           type,
					       GCancellable       *cancellable,
					       GError            **error);
gboolean   g_file_output_stream_can_truncate  (GFileOutputStream  *stream);
gboolean   g_file_output_stream_truncate      (GFileOutputStream  *stream,
					       goffset             size,
					       GCancellable       *cancellable,
					       GError            **error);

G_END_DECLS

#endif /* __G_FILE_FILE_OUTPUT_STREAM_H__ */