input_string Class Reference

#include <string.h>

Inheritance diagram for input_string:

input_ty

Public Member Functions

virtual ~input_string ()
 input_string (const nstring &arg)
nstring name ()
long length ()
long read_inner (void *data, size_t nbytes)
long ftell_inner ()

Private Member Functions

 input_string ()
 input_string (const input_string &arg)
input_stringoperator= (const input_string &arg)

Private Attributes

nstring base
size_t pos

Detailed Description

The input_string class is used to represent an input source obtained from a string.

Definition at line 29 of file string.h.


Constructor & Destructor Documentation

virtual input_string::~input_string (  )  [virtual]

The destructor.

input_string::input_string ( const nstring arg  ) 

The constructor.

input_string::input_string (  )  [private]

The default constructor. Do not use.

input_string::input_string ( const input_string arg  )  [private]

The copy constructor. Do not use.


Member Function Documentation

nstring input_string::name (  )  [virtual]

The name method is used to determine the name of the input.

Implements input_ty.

long input_string::length (  )  [virtual]

The length method is used to determine the length of the input. May return -1 if the length is unknown.

Implements input_ty.

long input_string::read_inner ( void *  data,
size_t  nbytes 
) [virtual]

The read_inner method is used to read unbuffered data from the given input stream. At most nbytes bytes will be read into data. The number of bytes actually read will be returned. At end-of-file, a value <= 0 will be returned, and data will be unchanged. All file read errors or format errors are fatal, and will cause the method to not return.

Parameters:
data Where to put the results of the read.
nbytes The maximum number of bytes to read.
Returns:
The actual number of bytes read, or zero for end-of-file.

Implements input_ty.

long input_string::ftell_inner (  )  [virtual]

The ftell_inner method is used to determine the unbuffered current position within the input.

Implements input_ty.

input_string& input_string::operator= ( const input_string arg  )  [private]

The assignment operator. Do not use.


Field Documentation

Definition at line 56 of file string.h.

size_t input_string::pos [private]

Definition at line 57 of file string.h.


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

Generated on Wed Mar 12 23:37:40 2008 for Aegis by  doxygen 1.5.5