A concrete implementation of InputStream that performs input operations from a stdio FILE*. More...

#include <bond/io/stdioinputstream.h>

Inheritance diagram for Bond::StdioInputStream:

Public Member Functions
	StdioInputStream (FILE *file)
	Constructs a StdioInputStream object.
	StdioInputStream (const char *fileName)
	Constructs a StdioInputStream object that opens and owns the given file.
	StdioInputStream (StdioFileHandle &&handle)
	Constructs a StdioInputStream object.
	StdioInputStream (StdioInputStream &&other)
	Move-constructs a StdioInputStream object.
virtual	~StdioInputStream ()
	Destroys a StdioInputStream object, closing the file if it is owned.
	StdioInputStream (const StdioInputStream &other)=delete
StdioInputStream &	operator= (const StdioInputStream &other)=delete
StdioInputStream &	operator= (StdioInputStream &&other)
	Closes the file if it is owned and takes over the file of another StdioInputStream.
bool	IsBound () const
	Tests whether this stream is currently bound to a FILE object.
virtual void	Close () override
	Closes the FILE object, whether or not it is owned, and unbinds the stream.
virtual void	VScan (const char *format, va_list argList) override
	Reads formatted input from the stream using a variable argument list.
virtual size_t	Read (uint8_t *bytes, size_t numBytes) override
	Reads a sequence of bytes from the stream.
virtual int	Read () override
	Reads a single byte from the stream.
virtual pos_t	GetPosition () const override
	Returns the current position within the stream.
virtual pos_t	GetEndPosition () const override
	Returns the end position of the stream.
virtual void	SetPosition (off_t offset) override
	Sets the current position within the stream.
virtual void	SetPositionFromEnd (off_t offset) override
	Sets the current position relative to the end of the stream.
virtual void	AddOffset (off_t offset) override
	Advances the current position by the given offset.
virtual bool	IsEof () const override
	Tests whether the current position is at or beyond the end of the stream.
virtual bool	HasError () const override
	Tests whether the stream is currently in an error state.
virtual void	ClearError () override
	Clears the current error state of the stream.
Public Member Functions inherited from Bond::InputStream
virtual	~InputStream ()
	Destroys an InputStream object.
virtual void	Scan (const char *format,...)
	Reads formatted input from the stream.
size_t	Read (char *bytes, size_t numBytes)
	Reads a sequence of bytes from the stream into a character buffer.
Public Member Functions inherited from Bond::Stream
virtual	~Stream ()
	Destroys a Stream object.

Additional Inherited Members
Public Types inherited from Bond::Stream
typedef long	pos_t
	A type used to represent absolute positions within a stream.
typedef long	off_t
	A type used to represent relative offsets within a stream.
Static Public Attributes inherited from Bond::Stream
static const int	Eof = -1
	A special value returned by single-byte input functions to indicate end of stream.

Detailed Description

A concrete implementation of InputStream that performs input operations from a stdio FILE*.

StdioInputStream adapts a C stdio FILE object to the InputStream interface. The stream may be bound either to an existing FILE pointer or to a file opened and owned through a StdioFileHandle.

See also: InputStream, StdioOutputStream

Constructor & Destructor Documentation

◆ StdioInputStream() [1/5]

Bond::StdioInputStream::StdioInputStream ( FILE * file )

inlineexplicit

Constructs a StdioInputStream object.

Parameters

file	The stdio FILE object from which input will be read. The file is not owned by the StdioInputStream, so it is not closed when the StdioInputStream is destroyed, but it is closed by Close().

◆ StdioInputStream() [2/5]

Bond::StdioInputStream::StdioInputStream ( const char * fileName )

explicit

Constructs a StdioInputStream object that opens and owns the given file.

Throws a Bond::Exception if the file fails to open.

Parameters

fileName The name of the file to open for reading in binary mode, encoded in UTF-8.

◆ StdioInputStream() [3/5]

Bond::StdioInputStream::StdioInputStream ( StdioFileHandle && handle )

inlineexplicit

Constructs a StdioInputStream object.

Parameters

handle An owning file handle whose FILE object will be used for input operations.

◆ StdioInputStream() [4/5]

Bond::StdioInputStream::StdioInputStream ( StdioInputStream && other )

inline

Move-constructs a StdioInputStream object.

Parameters

other The StdioInputStream object from which resources will be moved.

◆ ~StdioInputStream()

virtual Bond::StdioInputStream::~StdioInputStream ( )

inlinevirtual

Destroys a StdioInputStream object, closing the file if it is owned.

◆ StdioInputStream() [5/5]

Bond::StdioInputStream::StdioInputStream ( const StdioInputStream & other )

delete

Member Function Documentation

◆ AddOffset()

virtual void Bond::StdioInputStream::AddOffset ( off_t offset )

inlineoverridevirtual

Advances the current position by the given offset.

Parameters

offset The signed amount by which the current position should be adjusted.

Implements Bond::Stream.

◆ ClearError()

virtual void Bond::StdioInputStream::ClearError ( )

inlineoverridevirtual

Clears the current error state of the stream.

Implements Bond::Stream.

◆ Close()

virtual void Bond::StdioInputStream::Close ( )

overridevirtual

Closes the FILE object, whether or not it is owned, and unbinds the stream.

Reimplemented from Bond::Stream.

◆ GetEndPosition()

virtual pos_t Bond::StdioInputStream::GetEndPosition ( ) const

overridevirtual

Returns the end position of the stream.

Returns: The absolute position one past the last byte in the stream.

Implements Bond::Stream.

◆ GetPosition()

virtual pos_t Bond::StdioInputStream::GetPosition ( ) const

inlineoverridevirtual

Returns the current position within the stream.

Returns: The current absolute stream position.

Implements Bond::Stream.

◆ HasError()

virtual bool Bond::StdioInputStream::HasError ( ) const

inlineoverridevirtual

Tests whether the stream is currently in an error state.

Returns: True if an error has occurred on the underlying stream.

Implements Bond::Stream.

◆ IsBound()

bool Bond::StdioInputStream::IsBound ( ) const

inline

Tests whether this stream is currently bound to a FILE object.

Returns: True if this stream is bound to a FILE object.

◆ IsEof()

virtual bool Bond::StdioInputStream::IsEof ( ) const

inlineoverridevirtual

Tests whether the current position is at or beyond the end of the stream.

Returns: True if no more data can be read or written at the current position.

Implements Bond::Stream.

◆ operator=() [1/2]

StdioInputStream & Bond::StdioInputStream::operator= ( const StdioInputStream & other )

delete

◆ operator=() [2/2]

StdioInputStream & Bond::StdioInputStream::operator= ( StdioInputStream && other )

Closes the file if it is owned and takes over the file of another StdioInputStream.

Parameters

other The StdioInputStream object from which resources will be moved.

Returns: A reference to this StdioInputStream.

◆ Read() [1/2]

virtual int Bond::StdioInputStream::Read ( )

inlineoverridevirtual

Reads a single byte from the stream.

Returns: The next byte in the stream, or Stream::Eof if the end of the stream is reached.

Implements Bond::InputStream.

◆ Read() [2/2]

virtual size_t Bond::StdioInputStream::Read	(	uint8_t *	bytes,
		size_t	numBytes )

inlineoverridevirtual

Reads a sequence of bytes from the stream.

Parameters

bytes	The destination buffer where the bytes will be written.
numBytes	The maximum number of bytes to read.

Returns: The number of bytes actually read from the stream.

Reimplemented from Bond::InputStream.

◆ SetPosition()

virtual void Bond::StdioInputStream::SetPosition ( off_t offset )

inlineoverridevirtual

Sets the current position within the stream.

Parameters

offset The absolute position to which the stream should be moved.

Implements Bond::Stream.

◆ SetPositionFromEnd()

virtual void Bond::StdioInputStream::SetPositionFromEnd ( off_t offset )

inlineoverridevirtual

Sets the current position relative to the end of the stream.

Parameters

offset The offset from the end position to which the stream should be moved, i.e. the new position is GetEndPosition() + offset, so offset is normally zero or negative.

Implements Bond::Stream.

◆ VScan()

virtual void Bond::StdioInputStream::VScan	(	const char *	format,
		va_list	argList )

inlineoverridevirtual

Reads formatted input from the stream using a variable argument list.

Parameters

format	A scanf-style format string describing the values to be read.
argList	A variable argument list containing pointers to storage for the parsed values.

Implements Bond::InputStream.

The documentation for this class was generated from the following file:

include/bond/io/stdioinputstream.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StdioInputStream() [1/5]

◆ StdioInputStream() [2/5]

◆ StdioInputStream() [3/5]

◆ StdioInputStream() [4/5]

◆ ~StdioInputStream()

◆ StdioInputStream() [5/5]

Member Function Documentation

◆ AddOffset()

◆ ClearError()

◆ Close()

◆ GetEndPosition()

◆ GetPosition()

◆ HasError()

◆ IsBound()

◆ IsEof()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Read() [1/2]

◆ Read() [2/2]

◆ SetPosition()

◆ SetPositionFromEnd()

◆ VScan()