gfileoutputstream.h 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. /* GIO - GLib Input, Output and Streaming Library
  2. *
  3. * Copyright (C) 2006-2007 Red Hat, Inc.
  4. *
  5. * This library is free software; you can redistribute it and/or
  6. * modify it under the terms of the GNU Lesser General Public
  7. * License as published by the Free Software Foundation; either
  8. * version 2 of the License, or (at your option) any later version.
  9. *
  10. * This library is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  13. * Lesser General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU Lesser General
  16. * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  17. *
  18. * Author: Alexander Larsson <[email protected]>
  19. */
  20. #ifndef __G_FILE_OUTPUT_STREAM_H__
  21. #define __G_FILE_OUTPUT_STREAM_H__
  22. #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  23. #error "Only <gio/gio.h> can be included directly."
  24. #endif
  25. #include <gio/goutputstream.h>
  26. G_BEGIN_DECLS
  27. #define G_TYPE_FILE_OUTPUT_STREAM (g_file_output_stream_get_type ())
  28. #define G_FILE_OUTPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStream))
  29. #define G_FILE_OUTPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStreamClass))
  30. #define G_IS_FILE_OUTPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_OUTPUT_STREAM))
  31. #define G_IS_FILE_OUTPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_OUTPUT_STREAM))
  32. #define G_FILE_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStreamClass))
  33. /**
  34. * GFileOutputStream:
  35. *
  36. * A subclass of GOutputStream for opened files. This adds
  37. * a few file-specific operations and seeking and truncating.
  38. *
  39. * #GFileOutputStream implements GSeekable.
  40. **/
  41. typedef struct _GFileOutputStreamClass GFileOutputStreamClass;
  42. typedef struct _GFileOutputStreamPrivate GFileOutputStreamPrivate;
  43. struct _GFileOutputStream
  44. {
  45. GOutputStream parent_instance;
  46. /*< private >*/
  47. GFileOutputStreamPrivate *priv;
  48. };
  49. struct _GFileOutputStreamClass
  50. {
  51. GOutputStreamClass parent_class;
  52. goffset (* tell) (GFileOutputStream *stream);
  53. gboolean (* can_seek) (GFileOutputStream *stream);
  54. gboolean (* seek) (GFileOutputStream *stream,
  55. goffset offset,
  56. GSeekType type,
  57. GCancellable *cancellable,
  58. GError **error);
  59. gboolean (* can_truncate) (GFileOutputStream *stream);
  60. gboolean (* truncate_fn) (GFileOutputStream *stream,
  61. goffset size,
  62. GCancellable *cancellable,
  63. GError **error);
  64. GFileInfo * (* query_info) (GFileOutputStream *stream,
  65. const char *attributes,
  66. GCancellable *cancellable,
  67. GError **error);
  68. void (* query_info_async) (GFileOutputStream *stream,
  69. const char *attributes,
  70. int io_priority,
  71. GCancellable *cancellable,
  72. GAsyncReadyCallback callback,
  73. gpointer user_data);
  74. GFileInfo * (* query_info_finish) (GFileOutputStream *stream,
  75. GAsyncResult *result,
  76. GError **error);
  77. char * (* get_etag) (GFileOutputStream *stream);
  78. /* Padding for future expansion */
  79. void (*_g_reserved1) (void);
  80. void (*_g_reserved2) (void);
  81. void (*_g_reserved3) (void);
  82. void (*_g_reserved4) (void);
  83. void (*_g_reserved5) (void);
  84. };
  85. GLIB_AVAILABLE_IN_ALL
  86. GType g_file_output_stream_get_type (void) G_GNUC_CONST;
  87. GLIB_AVAILABLE_IN_ALL
  88. GFileInfo *g_file_output_stream_query_info (GFileOutputStream *stream,
  89. const char *attributes,
  90. GCancellable *cancellable,
  91. GError **error);
  92. GLIB_AVAILABLE_IN_ALL
  93. void g_file_output_stream_query_info_async (GFileOutputStream *stream,
  94. const char *attributes,
  95. int io_priority,
  96. GCancellable *cancellable,
  97. GAsyncReadyCallback callback,
  98. gpointer user_data);
  99. GLIB_AVAILABLE_IN_ALL
  100. GFileInfo *g_file_output_stream_query_info_finish (GFileOutputStream *stream,
  101. GAsyncResult *result,
  102. GError **error);
  103. GLIB_AVAILABLE_IN_ALL
  104. char * g_file_output_stream_get_etag (GFileOutputStream *stream);
  105. G_END_DECLS
  106. #endif /* __G_FILE_FILE_OUTPUT_STREAM_H__ */