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.SeekableT;
26 
27 public  import gio.Cancellable;
28 public  import glib.ErrorG;
29 public  import glib.GException;
30 public  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 template SeekableT(TStruct)
51 {
52 	/** Get the main Gtk struct */
53 	public GSeekable* getSeekableStruct()
54 	{
55 		return cast(GSeekable*)getStruct();
56 	}
57 
58 
59 	/**
60 	 * Tests if the stream supports the #GSeekableIface.
61 	 *
62 	 * Return: %TRUE if @seekable can be seeked. %FALSE otherwise.
63 	 */
64 	public bool canSeek()
65 	{
66 		return g_seekable_can_seek(getSeekableStruct()) != 0;
67 	}
68 
69 	/**
70 	 * Tests if the stream can be truncated.
71 	 *
72 	 * Return: %TRUE if the stream can be truncated, %FALSE otherwise.
73 	 */
74 	public bool canTruncate()
75 	{
76 		return g_seekable_can_truncate(getSeekableStruct()) != 0;
77 	}
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 	 * Return: %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 		GError* err = null;
109 		
110 		auto p = g_seekable_seek(getSeekableStruct(), offset, type, (cancellable is null) ? null : cancellable.getCancellableStruct(), &err) != 0;
111 		
112 		if (err !is null)
113 		{
114 			throw new GException( new ErrorG(err) );
115 		}
116 		
117 		return p;
118 	}
119 
120 	/**
121 	 * Tells the current position within the stream.
122 	 *
123 	 * Return: the offset from the beginning of the buffer.
124 	 */
125 	public long tell()
126 	{
127 		return g_seekable_tell(getSeekableStruct());
128 	}
129 
130 	/**
131 	 * Truncates a stream with a given #offset.
132 	 *
133 	 * If @cancellable is not %NULL, then the operation can be cancelled by
134 	 * triggering the cancellable object from another thread. If the operation
135 	 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
136 	 * operation was partially finished when the operation was cancelled the
137 	 * partial result will be returned, without an error.
138 	 *
139 	 * Params:
140 	 *     offset = a #goffset.
141 	 *     cancellable = optional #GCancellable object, %NULL to ignore.
142 	 *
143 	 * Return: %TRUE if successful. If an error
144 	 *     has occurred, this function will return %FALSE and set @error
145 	 *     appropriately if present.
146 	 *
147 	 * Throws: GException on failure.
148 	 */
149 	public bool truncate(long offset, Cancellable cancellable)
150 	{
151 		GError* err = null;
152 		
153 		auto p = g_seekable_truncate(getSeekableStruct(), offset, (cancellable is null) ? null : cancellable.getCancellableStruct(), &err) != 0;
154 		
155 		if (err !is null)
156 		{
157 			throw new GException( new ErrorG(err) );
158 		}
159 		
160 		return p;
161 	}
162 }