/usr/include/d/gtkd-3/gio/BufferedInputStream.d is in libgtkd-3-dev 3.7.5-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 | /*
* This file is part of gtkD.
*
* gtkD is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version, with
* some exceptions, please read the COPYING file.
*
* gtkD is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with gtkD; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
*/
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage
module gio.BufferedInputStream;
private import gio.AsyncResultIF;
private import gio.Cancellable;
private import gio.FilterInputStream;
private import gio.InputStream;
private import gio.SeekableIF;
private import gio.SeekableT;
private import gio.c.functions;
public import gio.c.types;
private import glib.ConstructionException;
private import glib.ErrorG;
private import glib.GException;
private import gobject.ObjectG;
public import gtkc.giotypes;
/**
* Buffered input stream implements #GFilterInputStream and provides
* for buffered reads.
*
* By default, #GBufferedInputStream's buffer size is set at 4 kilobytes.
*
* To create a buffered input stream, use g_buffered_input_stream_new(),
* or g_buffered_input_stream_new_sized() to specify the buffer's size at
* construction.
*
* To get the size of a buffer within a buffered input stream, use
* g_buffered_input_stream_get_buffer_size(). To change the size of a
* buffered input stream's buffer, use
* g_buffered_input_stream_set_buffer_size(). Note that the buffer's size
* cannot be reduced below the size of the data within the buffer.
*/
public class BufferedInputStream : FilterInputStream, SeekableIF
{
/** the main Gtk struct */
protected GBufferedInputStream* gBufferedInputStream;
/** Get the main Gtk struct */
public GBufferedInputStream* getBufferedInputStreamStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return gBufferedInputStream;
}
/** the main Gtk struct as a void* */
protected override void* getStruct()
{
return cast(void*)gBufferedInputStream;
}
protected override void setStruct(GObject* obj)
{
gBufferedInputStream = cast(GBufferedInputStream*)obj;
super.setStruct(obj);
}
/**
* Sets our main struct and passes it to the parent class.
*/
public this (GBufferedInputStream* gBufferedInputStream, bool ownedRef = false)
{
this.gBufferedInputStream = gBufferedInputStream;
super(cast(GFilterInputStream*)gBufferedInputStream, ownedRef);
}
// add the Seekable capabilities
mixin SeekableT!(GBufferedInputStream);
/**
* Returns the buffer with the currently available bytes. The returned
* buffer must not be modified and will become invalid when reading from
* the stream or filling the buffer.
*
* Params:
* count = a #gsize to get the number of bytes available in the buffer
*
* Return: read-only buffer
*/
public ubyte[] peekBuffer()
{
size_t count;
auto p = g_buffered_input_stream_peek_buffer(gBufferedInputStream, &count);
return (cast(ubyte*)p)[0 .. count];
}
/**
*/
/** */
public static GType getType()
{
return g_buffered_input_stream_get_type();
}
/**
* Creates a new #GInputStream from the given @base_stream, with
* a buffer set to the default size (4 kilobytes).
*
* Params:
* baseStream = a #GInputStream
*
* Returns: a #GInputStream for the given @base_stream.
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(InputStream baseStream)
{
auto p = g_buffered_input_stream_new((baseStream is null) ? null : baseStream.getInputStreamStruct());
if(p is null)
{
throw new ConstructionException("null returned by new");
}
this(cast(GBufferedInputStream*) p, true);
}
/**
* Creates a new #GBufferedInputStream from the given @base_stream,
* with a buffer set to @size.
*
* Params:
* baseStream = a #GInputStream
* size = a #gsize
*
* Returns: a #GInputStream.
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(InputStream baseStream, size_t size)
{
auto p = g_buffered_input_stream_new_sized((baseStream is null) ? null : baseStream.getInputStreamStruct(), size);
if(p is null)
{
throw new ConstructionException("null returned by new_sized");
}
this(cast(GBufferedInputStream*) p, true);
}
/**
* Tries to read @count bytes from the stream into the buffer.
* Will block during this read.
*
* If @count is zero, returns zero and does nothing. A value of @count
* larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
*
* On success, the number of bytes read into the buffer is returned.
* It is not an error if this is not the same as the requested size, as it
* can happen e.g. near the end of a file. Zero is returned on end of file
* (or if @count is zero), but never otherwise.
*
* If @count is -1 then the attempted read size is equal to the number of
* bytes that are required to fill the buffer.
*
* If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
* operation was partially finished when the operation was cancelled the
* partial result will be returned, without an error.
*
* On error -1 is returned and @error is set accordingly.
*
* For the asynchronous, non-blocking, version of this function, see
* g_buffered_input_stream_fill_async().
*
* Params:
* count = the number of bytes that will be read from the stream
* cancellable = optional #GCancellable object, %NULL to ignore
*
* Returns: the number of bytes read into @stream's buffer, up to @count,
* or -1 on error.
*
* Throws: GException on failure.
*/
public ptrdiff_t fill(ptrdiff_t count, Cancellable cancellable)
{
GError* err = null;
auto p = g_buffered_input_stream_fill(gBufferedInputStream, count, (cancellable is null) ? null : cancellable.getCancellableStruct(), &err);
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Reads data into @stream's buffer asynchronously, up to @count size.
* @io_priority can be used to prioritize reads. For the synchronous
* version of this function, see g_buffered_input_stream_fill().
*
* If @count is -1 then the attempted read size is equal to the number
* of bytes that are required to fill the buffer.
*
* Params:
* count = the number of bytes that will be read from the stream
* ioPriority = the [I/O priority][io-priority] of the request
* cancellable = optional #GCancellable object
* callback = a #GAsyncReadyCallback
* userData = a #gpointer
*/
public void fillAsync(ptrdiff_t count, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)
{
g_buffered_input_stream_fill_async(gBufferedInputStream, count, ioPriority, (cancellable is null) ? null : cancellable.getCancellableStruct(), callback, userData);
}
/**
* Finishes an asynchronous read.
*
* Params:
* result = a #GAsyncResult
*
* Returns: a #gssize of the read stream, or %-1 on an error.
*
* Throws: GException on failure.
*/
public ptrdiff_t fillFinish(AsyncResultIF result)
{
GError* err = null;
auto p = g_buffered_input_stream_fill_finish(gBufferedInputStream, (result is null) ? null : result.getAsyncResultStruct(), &err);
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Gets the size of the available data within the stream.
*
* Returns: size of the available stream.
*/
public size_t getAvailable()
{
return g_buffered_input_stream_get_available(gBufferedInputStream);
}
/**
* Gets the size of the input buffer.
*
* Returns: the current buffer size.
*/
public size_t getBufferSize()
{
return g_buffered_input_stream_get_buffer_size(gBufferedInputStream);
}
/**
* Peeks in the buffer, copying data of size @count into @buffer,
* offset @offset bytes.
*
* Params:
* buffer = a pointer to
* an allocated chunk of memory
* offset = a #gsize
*
* Returns: a #gsize of the number of bytes peeked, or -1 on error.
*/
public size_t peek(ubyte[] buffer, size_t offset)
{
return g_buffered_input_stream_peek(gBufferedInputStream, buffer.ptr, offset, cast(size_t)buffer.length);
}
/**
* Tries to read a single byte from the stream or the buffer. Will block
* during this read.
*
* On success, the byte read from the stream is returned. On end of stream
* -1 is returned but it's not an exceptional error and @error is not set.
*
* If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
* operation was partially finished when the operation was cancelled the
* partial result will be returned, without an error.
*
* On error -1 is returned and @error is set accordingly.
*
* Params:
* cancellable = optional #GCancellable object, %NULL to ignore
*
* Returns: the byte read from the @stream, or -1 on end of stream or error.
*
* Throws: GException on failure.
*/
public int readByte(Cancellable cancellable)
{
GError* err = null;
auto p = g_buffered_input_stream_read_byte(gBufferedInputStream, (cancellable is null) ? null : cancellable.getCancellableStruct(), &err);
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Sets the size of the internal buffer of @stream to @size, or to the
* size of the contents of the buffer. The buffer can never be resized
* smaller than its current contents.
*
* Params:
* size = a #gsize
*/
public void setBufferSize(size_t size)
{
g_buffered_input_stream_set_buffer_size(gBufferedInputStream, size);
}
}
|