id3lib  3.8.3
Public Member Functions | List of all members
dami::io::BStringReader Class Reference

#include <io_strings.h>

Inheritance diagram for dami::io::BStringReader:
ID3_Reader

Public Member Functions

 BStringReader (const BString &string)
 
virtual ~BStringReader ()
 
virtual void close ()
 Close the reader. More...
 
virtual int_type peekChar ()
 Return the next character to be read without advancing the internal position. More...
 
size_type readChars (char buf[], size_type len)
 Read up to len chars into buf and advance the internal position accordingly. More...
 
virtual size_type readChars (char_type buf[], size_type len)
 Read up to len characters into buf and advance the internal position accordingly. More...
 
virtual pos_type getCur ()
 Return the current position in the reader. More...
 
virtual pos_type getBeg ()
 Return the beginning position in the reader. More...
 
virtual pos_type getEnd ()
 Return the ending position in the reader. More...
 
virtual pos_type setCur (pos_type pos)
 Set the value of the internal position for reading. More...
 
virtual bool atEnd ()
 
virtual size_type skipChars (size_type len)
 Skip up to len chars in the stream and advance the internal position accordingly. More...
 
- Public Member Functions inherited from ID3_Reader
virtual int_type readChar ()
 Read a single character and advance the internal position. More...
 
virtual size_type remainingBytes ()
 

Additional Inherited Members

- Public Types inherited from ID3_Reader
typedef uint32 size_type
 
typedef uint8 char_type
 
typedef uint32 pos_type
 
typedef int32 off_type
 
typedef int16 int_type
 
- Static Public Attributes inherited from ID3_Reader
static const int_type END_OF_READER = -1
 

Detailed Description

Definition at line 113 of file io_strings.h.

Constructor & Destructor Documentation

dami::io::BStringReader::BStringReader ( const BString &  string)
inline

Definition at line 118 of file io_strings.h.

virtual dami::io::BStringReader::~BStringReader ( )
inlinevirtual

Definition at line 119 of file io_strings.h.

Member Function Documentation

virtual bool dami::io::BStringReader::atEnd ( )
inlinevirtual

Reimplemented from ID3_Reader.

Definition at line 170 of file io_strings.h.

virtual void dami::io::BStringReader::close ( )
inlinevirtual

Close the reader.

Any further actions on the reader should fail.

Implements ID3_Reader.

Definition at line 121 of file io_strings.h.

virtual pos_type dami::io::BStringReader::getBeg ( )
inlinevirtual

Return the beginning position in the reader.

Reimplemented from ID3_Reader.

Definition at line 151 of file io_strings.h.

virtual pos_type dami::io::BStringReader::getCur ( )
inlinevirtual

Return the current position in the reader.

Implements ID3_Reader.

Definition at line 146 of file io_strings.h.

virtual pos_type dami::io::BStringReader::getEnd ( )
inlinevirtual

Return the ending position in the reader.

Reimplemented from ID3_Reader.

Definition at line 156 of file io_strings.h.

virtual int_type dami::io::BStringReader::peekChar ( )
inlinevirtual

Return the next character to be read without advancing the internal position.

Returns END_OF_READER if there isn't a character to read.

Implements ID3_Reader.

Definition at line 122 of file io_strings.h.

size_type dami::io::BStringReader::readChars ( char  buf[],
size_type  len 
)
inlinevirtual

Read up to len chars into buf and advance the internal position accordingly.

Returns the number of characters read into buf.

Reimplemented from ID3_Reader.

Definition at line 134 of file io_strings.h.

virtual size_type dami::io::BStringReader::readChars ( char_type  buf[],
size_type  len 
)
inlinevirtual

Read up to len characters into buf and advance the internal position accordingly.

Returns the number of characters read into buf. Note that the value returned may be less than the number of bytes that the internal position advances, due to multi-byte characters.

Implements ID3_Reader.

Definition at line 138 of file io_strings.h.

virtual pos_type dami::io::BStringReader::setCur ( pos_type  pos)
inlinevirtual

Set the value of the internal position for reading.

Implements ID3_Reader.

Definition at line 163 of file io_strings.h.

virtual size_type dami::io::BStringReader::skipChars ( size_type  len)
inlinevirtual

Skip up to len chars in the stream and advance the internal position accordingly.

Returns the number of characters actually skipped (may be less than requested).

Reimplemented from ID3_Reader.

Definition at line 175 of file io_strings.h.


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