1 /* 2 * This file is part of gtkD. 3 * 4 * gtkD is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU Lesser General Public License 6 * as published by the Free Software Foundation; either version 3 7 * of the License, or (at your option) any later version, with 8 * some exceptions, please read the COPYING file. 9 * 10 * gtkD 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 13 * GNU Lesser General Public License for more details. 14 * 15 * You should have received a copy of the GNU Lesser General Public License 16 * along with gtkD; if not, write to the Free Software 17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA 18 */ 19 20 // generated automatically - do not change 21 // find conversion definition on APILookup.txt 22 // implement new conversion functionalities on the wrap.utils pakage 23 24 25 module gio.FileOutputStream; 26 27 private import gio.AsyncResultIF; 28 private import gio.Cancellable; 29 private import gio.FileInfo; 30 private import gio.OutputStream; 31 private import gio.SeekableIF; 32 private import gio.SeekableT; 33 private import glib.ErrorG; 34 private import glib.GException; 35 private import glib.Str; 36 private import gobject.ObjectG; 37 private import gtkc.gio; 38 public import gtkc.giotypes; 39 40 41 /** 42 * GFileOutputStream provides output streams that write their 43 * content to a file. 44 * 45 * GFileOutputStream implements #GSeekable, which allows the output 46 * stream to jump to arbitrary positions in the file and to truncate 47 * the file, provided the filesystem of the file supports these 48 * operations. 49 * 50 * To find the position of a file output stream, use g_seekable_tell(). 51 * To find out if a file output stream supports seeking, use 52 * g_seekable_can_seek().To position a file output stream, use 53 * g_seekable_seek(). To find out if a file output stream supports 54 * truncating, use g_seekable_can_truncate(). To truncate a file output 55 * stream, use g_seekable_truncate(). 56 */ 57 public class FileOutputStream : OutputStream, SeekableIF 58 { 59 /** the main Gtk struct */ 60 protected GFileOutputStream* gFileOutputStream; 61 62 /** Get the main Gtk struct */ 63 public GFileOutputStream* getFileOutputStreamStruct(bool transferOwnership = false) 64 { 65 if (transferOwnership) 66 ownedRef = false; 67 return gFileOutputStream; 68 } 69 70 /** the main Gtk struct as a void* */ 71 protected override void* getStruct() 72 { 73 return cast(void*)gFileOutputStream; 74 } 75 76 protected override void setStruct(GObject* obj) 77 { 78 gFileOutputStream = cast(GFileOutputStream*)obj; 79 super.setStruct(obj); 80 } 81 82 /** 83 * Sets our main struct and passes it to the parent class. 84 */ 85 public this (GFileOutputStream* gFileOutputStream, bool ownedRef = false) 86 { 87 this.gFileOutputStream = gFileOutputStream; 88 super(cast(GOutputStream*)gFileOutputStream, ownedRef); 89 } 90 91 // add the Seekable capabilities 92 mixin SeekableT!(GFileOutputStream); 93 94 95 /** */ 96 public static GType getType() 97 { 98 return g_file_output_stream_get_type(); 99 } 100 101 /** 102 * Gets the entity tag for the file when it has been written. 103 * This must be called after the stream has been written 104 * and closed, as the etag can change while writing. 105 * 106 * Returns: the entity tag for the stream. 107 */ 108 public string getEtag() 109 { 110 auto retStr = g_file_output_stream_get_etag(gFileOutputStream); 111 112 scope(exit) Str.freeString(retStr); 113 return Str.toString(retStr); 114 } 115 116 /** 117 * Queries a file output stream for the given @attributes. 118 * This function blocks while querying the stream. For the asynchronous 119 * version of this function, see g_file_output_stream_query_info_async(). 120 * While the stream is blocked, the stream will set the pending flag 121 * internally, and any other operations on the stream will fail with 122 * %G_IO_ERROR_PENDING. 123 * 124 * Can fail if the stream was already closed (with @error being set to 125 * %G_IO_ERROR_CLOSED), the stream has pending operations (with @error being 126 * set to %G_IO_ERROR_PENDING), or if querying info is not supported for 127 * the stream's interface (with @error being set to %G_IO_ERROR_NOT_SUPPORTED). In 128 * all cases of failure, %NULL will be returned. 129 * 130 * If @cancellable is not %NULL, then the operation can be cancelled by 131 * triggering the cancellable object from another thread. If the operation 132 * was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will 133 * be returned. 134 * 135 * Params: 136 * attributes = a file attribute query string. 137 * cancellable = optional #GCancellable object, %NULL to ignore. 138 * 139 * Returns: a #GFileInfo for the @stream, or %NULL on error. 140 * 141 * Throws: GException on failure. 142 */ 143 public FileInfo queryInfo(string attributes, Cancellable cancellable) 144 { 145 GError* err = null; 146 147 auto p = g_file_output_stream_query_info(gFileOutputStream, Str.toStringz(attributes), (cancellable is null) ? null : cancellable.getCancellableStruct(), &err); 148 149 if (err !is null) 150 { 151 throw new GException( new ErrorG(err) ); 152 } 153 154 if(p is null) 155 { 156 return null; 157 } 158 159 return ObjectG.getDObject!(FileInfo)(cast(GFileInfo*) p, true); 160 } 161 162 /** 163 * Asynchronously queries the @stream for a #GFileInfo. When completed, 164 * @callback will be called with a #GAsyncResult which can be used to 165 * finish the operation with g_file_output_stream_query_info_finish(). 166 * 167 * For the synchronous version of this function, see 168 * g_file_output_stream_query_info(). 169 * 170 * Params: 171 * attributes = a file attribute query string. 172 * ioPriority = the [I/O priority][gio-GIOScheduler] of the request 173 * cancellable = optional #GCancellable object, %NULL to ignore. 174 * callback = callback to call when the request is satisfied 175 * userData = the data to pass to callback function 176 */ 177 public void queryInfoAsync(string attributes, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData) 178 { 179 g_file_output_stream_query_info_async(gFileOutputStream, Str.toStringz(attributes), ioPriority, (cancellable is null) ? null : cancellable.getCancellableStruct(), callback, userData); 180 } 181 182 /** 183 * Finalizes the asynchronous query started 184 * by g_file_output_stream_query_info_async(). 185 * 186 * Params: 187 * result = a #GAsyncResult. 188 * 189 * Returns: A #GFileInfo for the finished query. 190 * 191 * Throws: GException on failure. 192 */ 193 public FileInfo queryInfoFinish(AsyncResultIF result) 194 { 195 GError* err = null; 196 197 auto p = g_file_output_stream_query_info_finish(gFileOutputStream, (result is null) ? null : result.getAsyncResultStruct(), &err); 198 199 if (err !is null) 200 { 201 throw new GException( new ErrorG(err) ); 202 } 203 204 if(p is null) 205 { 206 return null; 207 } 208 209 return ObjectG.getDObject!(FileInfo)(cast(GFileInfo*) p, true); 210 } 211 }