JASSv2
Public Member Functions | Static Public Member Functions | List of all members
JASS::instream_file_star Class Reference

Subclass of the instream_file class used for reading data from a disk file that already exists (e.g. stdin) More...

#include <instream_file_star.h>

Inheritance diagram for JASS::instream_file_star:
Inheritance graph
[legend]
Collaboration diagram for JASS::instream_file_star:
Collaboration graph
[legend]

Public Member Functions

 instream_file_star (FILE *file)
 Constructor. More...
 
virtual ~instream_file_star ()
 Destructior.
 
- Public Member Functions inherited from JASS::instream_file
 instream_file (const std::string &filename)
 Constructor. More...
 
virtual ~instream_file ()
 Destructor.
 
virtual void read (document &buffer)
 Read buffer.contents.size() bytes of data into buffer.contents, resizing on eof. More...
 
- Public Member Functions inherited from JASS::instream
 instream (std::shared_ptr< instream > &source, std::shared_ptr< allocator > &memory)
 Constructor. More...
 
 instream (std::shared_ptr< instream > &source)
 Constructor. More...
 
 instream (void)
 Constructor.
 
virtual ~instream ()
 Destructor. More...
 
size_t fetch (void *buffer, size_t bytes)
 fetch() generates a document object, sets its contents to the passed buffer, calls read() and returns the number of bytes of data read More...
 

Static Public Member Functions

static void unittest (void)
 Unit test this class.
 
- Static Public Member Functions inherited from JASS::instream_file
static void unittest (void)
 Unit test this class.
 

Additional Inherited Members

- Protected Member Functions inherited from JASS::instream_file
 instream_file (FILE *file)
 Constructor. More...
 
- Protected Attributes inherited from JASS::instream_file
file disk_file
 The file to read from.
 
size_t file_length
 The length of the file.
 
size_t bytes_read
 The number of bytes that have been read from the file.
 
- Protected Attributes inherited from JASS::instream
std::shared_ptr< instreamsource
 If this object is reading from another instream then this is that instream.
 
std::shared_ptr< allocatormemory
 Any and all memory allocation must happen using this object.
 

Detailed Description

Subclass of the instream_file class used for reading data from a disk file that already exists (e.g. stdin)

Constructor & Destructor Documentation

◆ instream_file_star()

JASS::instream_file_star::instream_file_star ( FILE *  file)
inline

Constructor.

Parameters
file[in] The FILE * object to use as an instrean.

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