PST File Format SDK v0.4
Loading...
Searching...
No Matches
pstsdk::hid_stream_device Class Reference

Defines a stream device for a heap allocation for use by boost iostream. More...

#include <heap.h>

+ Inheritance diagram for pstsdk::hid_stream_device:
+ Collaboration diagram for pstsdk::hid_stream_device:

Public Member Functions

 hid_stream_device ()
 
std::streamsize read (char *pbuffer, std::streamsize n)
 Read data from this node into the buffer at the current position.
 
std::streampos seek (boost::iostreams::stream_offset off, std::ios_base::seekdir way)
 Move the current position in the stream.
 

Friends

class heap_impl
 

Detailed Description

Defines a stream device for a heap allocation for use by boost iostream.

The boost iostream library requires that one defines a device, which implements a few key operations. This is the device for streaming out of a heap allocation.

Definition at line 58 of file heap.h.

Constructor & Destructor Documentation

◆ hid_stream_device()

pstsdk::hid_stream_device::hid_stream_device ( )
inline

Definition at line 61 of file heap.h.

Member Function Documentation

◆ read()

std::streamsize pstsdk::hid_stream_device::read ( char pbuffer,
std::streamsize  n 
)
inline

Read data from this node into the buffer at the current position.

Parameters
[out]pbufferThe buffer to store the results into
[in]nThe amount of data to read
Returns
The amount of data read

Definition at line 657 of file heap.h.

◆ seek()

std::streampos pstsdk::hid_stream_device::seek ( boost::iostreams::stream_offset  off,
std::ios_base::seekdir  way 
)
inline

Move the current position in the stream.

Parameters
[in]offThe offset to move the current position
[in]wayThe location to move the current position from
Returns
The new position

Definition at line 675 of file heap.h.

Friends And Related Symbol Documentation

◆ heap_impl

Definition at line 68 of file heap.h.


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