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