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.SeekableIF;
26 
27 private import gio.Cancellable;
28 private import glib.ErrorG;
29 private import glib.GException;
30 private import gtkc.gio;
31 public  import gtkc.giotypes;
32 
33 
34 /**
35  * #GSeekable is implemented by streams (implementations of
36  * #GInputStream or #GOutputStream) that support seeking.
37  * 
38  * Seekable streams largely fall into two categories: resizable and
39  * fixed-size.
40  * 
41  * #GSeekable on fixed-sized streams is approximately the same as POSIX
42  * lseek() on a block device (for example: attmepting to seek past the
43  * end of the device is an error).  Fixed streams typically cannot be
44  * truncated.
45  * 
46  * #GSeekable on resizable streams is approximately the same as POSIX
47  * lseek() on a normal file.  Seeking past the end and writing data will
48  * usually cause the stream to resize by introducing zero bytes.
49  */
50 public interface SeekableIF{
51 	/** Get the main Gtk struct */
52 	public GSeekable* getSeekableStruct(bool transferOwnership = false);
53 
54 	/** the main Gtk struct as a void* */
55 	protected void* getStruct();
56 
57 
58 	/**
59 	 * Tests if the stream supports the #GSeekableIface.
60 	 *
61 	 * Returns: %TRUE if @seekable can be seeked. %FALSE otherwise.
62 	 */
63 	public bool canSeek();
64 
65 	/**
66 	 * Tests if the stream can be truncated.
67 	 *
68 	 * Returns: %TRUE if the stream can be truncated, %FALSE otherwise.
69 	 */
70 	public bool canTruncate();
71 
72 	/**
73 	 * Seeks in the stream by the given @offset, modified by @type.
74 	 *
75 	 * Attempting to seek past the end of the stream will have different
76 	 * results depending on if the stream is fixed-sized or resizable.  If
77 	 * the stream is resizable then seeking past the end and then writing
78 	 * will result in zeros filling the empty space.  Seeking past the end
79 	 * of a resizable stream and reading will result in EOF.  Seeking past
80 	 * the end of a fixed-sized stream will fail.
81 	 *
82 	 * Any operation that would result in a negative offset will fail.
83 	 *
84 	 * If @cancellable is not %NULL, then the operation can be cancelled by
85 	 * triggering the cancellable object from another thread. If the operation
86 	 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
87 	 *
88 	 * Params:
89 	 *     offset = a #goffset.
90 	 *     type = a #GSeekType.
91 	 *     cancellable = optional #GCancellable object, %NULL to ignore.
92 	 *
93 	 * Returns: %TRUE if successful. If an error
94 	 *     has occurred, this function will return %FALSE and set @error
95 	 *     appropriately if present.
96 	 *
97 	 * Throws: GException on failure.
98 	 */
99 	public bool seek(long offset, GSeekType type, Cancellable cancellable);
100 
101 	/**
102 	 * Tells the current position within the stream.
103 	 *
104 	 * Returns: the offset from the beginning of the buffer.
105 	 */
106 	public long tell();
107 
108 	/**
109 	 * Truncates a stream with a given #offset.
110 	 *
111 	 * If @cancellable is not %NULL, then the operation can be cancelled by
112 	 * triggering the cancellable object from another thread. If the operation
113 	 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
114 	 * operation was partially finished when the operation was cancelled the
115 	 * partial result will be returned, without an error.
116 	 *
117 	 * Params:
118 	 *     offset = a #goffset.
119 	 *     cancellable = optional #GCancellable object, %NULL to ignore.
120 	 *
121 	 * Returns: %TRUE if successful. If an error
122 	 *     has occurred, this function will return %FALSE and set @error
123 	 *     appropriately if present.
124 	 *
125 	 * Throws: GException on failure.
126 	 */
127 	public bool truncate(long offset, Cancellable cancellable);
128 }