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 gio.c.functions;
29 public  import gio.c.types;
30 private import glib.ErrorG;
31 private import glib.GException;
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: attempting 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 	public static GType getType()
60 	{
61 		return g_seekable_get_type();
62 	}
63 
64 	/**
65 	 * Tests if the stream supports the #GSeekableIface.
66 	 *
67 	 * Returns: %TRUE if @seekable can be seeked. %FALSE otherwise.
68 	 */
69 	public bool canSeek();
70 
71 	/**
72 	 * Tests if the length of the stream can be adjusted with
73 	 * g_seekable_truncate().
74 	 *
75 	 * Returns: %TRUE if the stream can be truncated, %FALSE otherwise.
76 	 */
77 	public bool canTruncate();
78 
79 	/**
80 	 * Seeks in the stream by the given @offset, modified by @type.
81 	 *
82 	 * Attempting to seek past the end of the stream will have different
83 	 * results depending on if the stream is fixed-sized or resizable.  If
84 	 * the stream is resizable then seeking past the end and then writing
85 	 * will result in zeros filling the empty space.  Seeking past the end
86 	 * of a resizable stream and reading will result in EOF.  Seeking past
87 	 * the end of a fixed-sized stream will fail.
88 	 *
89 	 * Any operation that would result in a negative offset will fail.
90 	 *
91 	 * If @cancellable is not %NULL, then the operation can be cancelled by
92 	 * triggering the cancellable object from another thread. If the operation
93 	 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
94 	 *
95 	 * Params:
96 	 *     offset = a #goffset.
97 	 *     type = a #GSeekType.
98 	 *     cancellable = optional #GCancellable object, %NULL to ignore.
99 	 *
100 	 * Returns: %TRUE if successful. If an error
101 	 *     has occurred, this function will return %FALSE and set @error
102 	 *     appropriately if present.
103 	 *
104 	 * Throws: GException on failure.
105 	 */
106 	public bool seek(long offset, GSeekType type, Cancellable cancellable);
107 
108 	/**
109 	 * Tells the current position within the stream.
110 	 *
111 	 * Returns: the offset from the beginning of the buffer.
112 	 */
113 	public long tell();
114 
115 	/**
116 	 * Sets the length of the stream to @offset. If the stream was previously
117 	 * larger than @offset, the extra data is discarded. If the stream was
118 	 * previously shorter than @offset, it is extended with NUL ('\0') bytes.
119 	 *
120 	 * If @cancellable is not %NULL, then the operation can be cancelled by
121 	 * triggering the cancellable object from another thread. If the operation
122 	 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
123 	 * operation was partially finished when the operation was cancelled the
124 	 * partial result will be returned, without an error.
125 	 *
126 	 * Params:
127 	 *     offset = new length for @seekable, in bytes.
128 	 *     cancellable = optional #GCancellable object, %NULL to ignore.
129 	 *
130 	 * Returns: %TRUE if successful. If an error
131 	 *     has occurred, this function will return %FALSE and set @error
132 	 *     appropriately if present.
133 	 *
134 	 * Throws: GException on failure.
135 	 */
136 	public bool truncate(long offset, Cancellable cancellable);
137 }