Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

os::ResStream Class Reference

Data stream helper class for os::Resources. More...

#include <resources.h>

Inheritance diagram for os::ResStream::

os::SeekableIO os::StreamableIO List of all members.

Public Methods

 ~ResStream ()
std::string GetName () const
 Get the resource name. More...

std::string GetType () const
 Get the resource mime-type. More...

ssize_t GetSize () const
 Get the size of the resource. More...

virtual ssize_t Read (void *pBuffer, ssize_t nSize)
virtual ssize_t Write (const void *pBuffer, ssize_t nSize)
virtual ssize_t ReadPos (off_t nPos, void *pBuffer, ssize_t nSize)
virtual ssize_t WritePos (off_t nPos, const void *pBuffer, ssize_t nSize)
virtual off_t Seek (off_t nPos, int nMode)

Friends

class Resources

Detailed Description

Description:
Instances of this class is returned by various members of the os::Resources class to give access to data inside the resource archive.

As the private constructor indicate you should never create instances of this class yourself.

Since:
0.3.7
See also:
os::Resources
Author:
Kurt Skauen (kurt@atheos.cx)


Constructor & Destructor Documentation

ResStream::~ResStream
 


Member Function Documentation

std::string ResStream::GetName const
 

Description:
Get the resource name.
Returns:
An STL string containing the resource name.
See also:
GetType(), GetSize()
Author:
Kurt Skauen (kurt@atheos.cx)

ssize_t ResStream::GetSize const
 

Description:
Get the size of the resource.
Returns:
The resource size in bytes.
See also:
GetName(), GetType()
Author:
Kurt Skauen (kurt@atheos.cx)

std::string ResStream::GetType const
 

Description:
Get the resource mime-type.
Returns:
An STL string containing the resource mime-type.
See also:
GetName(), GetSize()
Author:
Kurt Skauen (kurt@atheos.cx)

ssize_t ResStream::Read void * pBuffer,
ssize_t nSize
[virtual]
 

Reimplemented from os::StreamableIO.

ssize_t ResStream::ReadPos off_t nPos,
void * pBuffer,
ssize_t nSize
[virtual]
 

Reimplemented from os::SeekableIO.

off_t ResStream::Seek off_t nPos,
int nMode
[virtual]
 

Reimplemented from os::SeekableIO.

ssize_t ResStream::Write const void * pBuffer,
ssize_t nSize
[virtual]
 

Reimplemented from os::StreamableIO.

ssize_t ResStream::WritePos off_t nPos,
const void * pBuffer,
ssize_t nSize
[virtual]
 

Reimplemented from os::SeekableIO.


Friends And Related Function Documentation

friend class Resources [friend]
 


Generated at Mon Oct 8 23:38:00 2001 for AtheOS higlevel API by doxygen1.2.9.1 written by Dimitri van Heesch, © 1997-2001