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

Set a window on the buffer. More...

#include <io_decorators.h>

Inheritance diagram for dami::io::WindowedReader:
ID3_Reader

Public Member Functions

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

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

Set a window on the buffer.

Characters can only be read within this window.

Definition at line 43 of file io_decorators.h.

Constructor & Destructor Documentation

dami::io::WindowedReader::WindowedReader ( ID3_Reader reader)
inlineexplicit

Definition at line 54 of file io_decorators.h.

dami::io::WindowedReader::WindowedReader ( ID3_Reader reader,
size_type  size 
)
inline

Definition at line 57 of file io_decorators.h.

dami::io::WindowedReader::WindowedReader ( ID3_Reader reader,
pos_type  beg,
size_type  size 
)
inline

Definition at line 61 of file io_decorators.h.

Member Function Documentation

void dami::io::WindowedReader::close ( )
inlinevirtual

Close the reader.

Any further actions on the reader should fail.

Implements ID3_Reader.

Definition at line 89 of file io_decorators.h.

pos_type dami::io::WindowedReader::getBeg ( )
inlinevirtual

Return the beginning position in the reader.

Reimplemented from ID3_Reader.

Definition at line 75 of file io_decorators.h.

pos_type dami::io::WindowedReader::getCur ( )
inlinevirtual

Return the current position in the reader.

Implements ID3_Reader.

Definition at line 74 of file io_decorators.h.

pos_type dami::io::WindowedReader::getEnd ( )
inlinevirtual

Return the ending position in the reader.

Reimplemented from ID3_Reader.

Definition at line 76 of file io_decorators.h.

bool dami::io::WindowedReader::inWindow ( )
inline

Definition at line 78 of file io_decorators.h.

ID3_Reader::int_type io::WindowedReader::peekChar ( )
virtual

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 126 of file io_decorators.cpp.

ID3_Reader::int_type io::WindowedReader::readChar ( )
virtual

Read a single character and advance the internal position.

Note that the interal position may advance more than one byte for a single character read. Returns END_OF_READER if there isn't a character to read.

Reimplemented from ID3_Reader.

Definition at line 110 of file io_decorators.cpp.

ID3_Reader::size_type io::WindowedReader::readChars ( char_type  buf[],
size_type  len 
)
virtual

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 136 of file io_decorators.cpp.

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

Reimplemented from ID3_Reader.

Definition at line 84 of file io_decorators.h.

ID3_Reader::pos_type io::WindowedReader::setBeg ( pos_type  beg)

Definition at line 69 of file io_decorators.cpp.

pos_type dami::io::WindowedReader::setCur ( pos_type  pos)
inlinevirtual

Set the value of the current position for reading.

Implements ID3_Reader.

Definition at line 68 of file io_decorators.h.

ID3_Reader::pos_type io::WindowedReader::setEnd ( pos_type  end)

Definition at line 90 of file io_decorators.cpp.

void io::WindowedReader::setWindow ( pos_type  beg,
size_type  size 
)

Definition at line 38 of file io_decorators.cpp.


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