AFileInputStream Class Reference

Opens a file for a binary read.

#include <AUI/IO/AFileInputStream.h>

Public Member Functions#
	AFileInputStream (const AString &path)
	AFileInputStream (AFileInputStream &&rhs) noexcept
AFileInputStream &	operator= (AFileInputStream &&rhs) noexcept
FILE *	nativeHandle () const
void	seek (std::streamoff offset, ASeekDir seekDir) noexcept override
	change reading position, a way of changing depends on seekDir parameter
std::streampos	tell () noexcept override
	return current reading position
bool	isEof () override
	returns true if end of stream has been reached
std::size_t	read (char *dst, size_t size) override
	Reads up to size bytes from stream. Blocking (waiting for new data) is allowed.
Public Member Functions inherited from ISeekableInputStream
size_t	fileSize ()
	return size of the stream
Public Member Functions inherited from IInputStream
size_t	read (std::span< std::byte > destination)
	Reads up to destination.size() bytes from stream. Blocking (waiting for new data) is allowed.
void	readExact (char *dst, size_t size)
	Reads exact size bytes from stream. Blocking (waiting for new data) is allowed.
template<typename T>
T	deserialize ()
template<typename T>
IInputStream &	operator>> (T &dst)
template<typename T>
IInputStream &	operator>> (T &&dst)

Member Function Documentation#

isEof()#

bool AFileInputStream::isEof ( )

overridevirtual

Returns

true if end of stream has been reached

Implements ISeekableInputStream.

read()#

std::size_t AFileInputStream::read ( char * dst, size_t size )

overridevirtual

Sneaky exceptions

An implementation can throw any exception that subclasses AIOException.

Parameters

dst	destination buffer
size	destination buffer's size. > 0

Returns

number of read bytes (including 0)

Implements IInputStream.

seek()#

void AFileInputStream::seek ( std::streamoff offset, ASeekDir seekDir )

overridevirtualnoexcept

Implements ISeekableInputStream.

tell()#

std::streampos AFileInputStream::tell ( )

nodiscardoverridevirtualnoexcept

Returns

current reading pos

Implements ISeekableInputStream.

© 2025 AUI Framework Contributors. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. All trademarks are property of their respective owners.

Contents

Public Member Functions

View Page SourceEdit Page Source