BufferedInputStream

Buffered input stream implements #GFilterInputStream and provides for buffered reads.

By default, gio.buffered_input_stream.BufferedInputStream's buffer size is set at 4 kilobytes.

To create a buffered input stream, use gio.buffered_input_stream.BufferedInputStream.new_, or gio.buffered_input_stream.BufferedInputStream.newSized to specify the buffer's size at construction.

To get the size of a buffer within a buffered input stream, use gio.buffered_input_stream.BufferedInputStream.getBufferSize. To change the size of a buffered input stream's buffer, use gio.buffered_input_stream.BufferedInputStream.setBufferSize. Note that the buffer's size cannot be reduced below the size of the data within the buffer.

class BufferedInputStream : FilterInputStream , Seekable {

this(gio.input_stream.InputStream baseStream);

static gio.buffered_input_stream.BufferedInputStream newSized(gio.input_stream.InputStream baseStream, size_t size);

ptrdiff_t fill(ptrdiff_t count, gio.cancellable.Cancellable cancellable);

void fillAsync(ptrdiff_t count, int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback);

ptrdiff_t fillFinish(gio.async_result.AsyncResult result);

size_t getAvailable();

size_t getBufferSize();

size_t peek(ubyte[] buffer, size_t offset);

ubyte[] peekBuffer();

int readByte(gio.cancellable.Cancellable cancellable);

void setBufferSize(size_t size);

}

Constructors

this this(gio.input_stream.InputStream baseStream): Creates a new #GInputStream from the given base_stream, with a buffer set to the default size (4 kilobytes).

Members

Functions

fill ptrdiff_t fill(ptrdiff_t count, gio.cancellable.Cancellable cancellable): Tries to read count bytes from the stream into the buffer. Will block during this read.
fillAsync void fillAsync(ptrdiff_t count, int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback): 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 gio.buffered_input_stream.BufferedInputStream.fill.
fillFinish ptrdiff_t fillFinish(gio.async_result.AsyncResult result): Finishes an asynchronous read.
getAvailable size_t getAvailable(): Gets the size of the available data within the stream.
getBufferSize size_t getBufferSize(): Gets the size of the input buffer.
peek size_t peek(ubyte[] buffer, size_t offset): Peeks in the buffer, copying data of size count into buffer, offset offset bytes.
peekBuffer ubyte[] peekBuffer(): 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.
readByte int readByte(gio.cancellable.Cancellable cancellable): Tries to read a single byte from the stream or the buffer. Will block during this read.
setBufferSize void setBufferSize(size_t size): 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.

Static functions

newSized gio.buffered_input_stream.BufferedInputStream newSized(gio.input_stream.InputStream baseStream, size_t size): Creates a new #GBufferedInputStream from the given base_stream, with a buffer set to size.

Mixed In Members

From `mixin SeekableT!()`

canSeek bool canSeek(): Tests if the stream supports the #GSeekableIface.
canTruncate bool canTruncate(): Tests if the length of the stream can be adjusted with gio.seekable.Seekable.truncate.
seek bool seek(long offset, glib.types.SeekType type, gio.cancellable.Cancellable cancellable): Seeks in the stream by the given offset, modified by type.
tell long tell(): Tells the current position within the stream.
truncate bool truncate(long offset, gio.cancellable.Cancellable cancellable): Sets the length of the stream to offset. If the stream was previously larger than offset, the extra data is discarded. If the stream was previously shorter than offset, it is extended with NUL ('\0') bytes.

Inherited Members

From FilterInputStream

getBaseStream gio.input_stream.InputStream getBaseStream(): Gets the base stream for the filter stream.
getCloseBaseStream bool getCloseBaseStream(): Returns whether the base stream will be closed when stream is closed.
setCloseBaseStream void setCloseBaseStream(bool closeBase): Sets whether the base stream will be closed when stream is closed.

From Seekable

canSeek bool canSeek(): Tests if the stream supports the #GSeekableIface.
canTruncate bool canTruncate(): Tests if the length of the stream can be adjusted with gio.seekable.Seekable.truncate.
seek bool seek(long offset, glib.types.SeekType type, gio.cancellable.Cancellable cancellable): Seeks in the stream by the given offset, modified by type.
tell long tell(): Tells the current position within the stream.
truncate bool truncate(long offset, gio.cancellable.Cancellable cancellable): Sets the length of the stream to offset. If the stream was previously larger than offset, the extra data is discarded. If the stream was previously shorter than offset, it is extended with NUL ('\0') bytes.

gio buffered_input_stream classes

BufferedInputStream

BufferedInputStream

From mixin SeekableT!()

From `mixin SeekableT!()`