Rosetta
Public Member Functions | Private Member Functions | Private Attributes | List of all members
basic::resource_manager::locator::StringResourceStream Class Reference

The StringResourceStream is a wrapper class for a std::stringstream that can be used to construct a resource. Useful when reading the resource stream in to memory (e.g. from a database or from multiple files) before trying to construct the resource. More...

#include <StringResourceStream.hh>

Inheritance diagram for basic::resource_manager::locator::StringResourceStream:
Inheritance graph
[legend]

Public Member Functions

 StringResourceStream ()
 
 StringResourceStream (std::string const &contents)
 
template<class InputSource >
 StringResourceStream (InputSource &in_stream)
 Append a piece of data to the internal stringstream. More...
 
 ~StringResourceStream () override
 
virtual void fill (std::string const &contents)
 Construct the stringstream from the given input string. More...
 
std::istream & stream () override
 Give non-const access to the internal stringstream so that it can be used to construct a resource. More...
 
- Public Member Functions inherited from basic::resource_manager::ResourceStream
 ~ResourceStream () override
 
- Public Member Functions inherited from utility::VirtualBase
 VirtualBase ()=default
 Default constructor. More...
 
virtual ~VirtualBase ()=default
 The virtual destructor is one of the main reasons for the VirtualBase class. More...
 
 VirtualBase (VirtualBase const &)=default
 
 VirtualBase (VirtualBase &&)=default
 
VirtualBaseoperator= (VirtualBase const &)=default
 
VirtualBaseoperator= (VirtualBase &&)=default
 

Private Member Functions

 StringResourceStream (StringResourceStream const &src)
 This is private. The StringResourceStream shouldn't be copied. More...
 

Private Attributes

std::stringstream stream_
 

Detailed Description

The StringResourceStream is a wrapper class for a std::stringstream that can be used to construct a resource. Useful when reading the resource stream in to memory (e.g. from a database or from multiple files) before trying to construct the resource.

Constructor & Destructor Documentation

◆ StringResourceStream() [1/4]

basic::resource_manager::locator::StringResourceStream::StringResourceStream ( )

@detail If you use this constructor be sure to set the string before accessing the stream

◆ StringResourceStream() [2/4]

basic::resource_manager::locator::StringResourceStream::StringResourceStream ( std::string const &  contents)

◆ StringResourceStream() [3/4]

template<class InputSource >
basic::resource_manager::locator::StringResourceStream::StringResourceStream ( InputSource &  in_stream)
inline

Append a piece of data to the internal stringstream.

References stream_.

◆ StringResourceStream() [4/4]

basic::resource_manager::locator::StringResourceStream::StringResourceStream ( StringResourceStream const &  src)
private

This is private. The StringResourceStream shouldn't be copied.

@detail This is private. The StringResourceStream shouldn't be copied

◆ ~StringResourceStream()

basic::resource_manager::locator::StringResourceStream::~StringResourceStream ( )
overridedefault

Member Function Documentation

◆ fill()

void basic::resource_manager::locator::StringResourceStream::fill ( std::string const &  contents)
virtual

Construct the stringstream from the given input string.

References stream_.

◆ stream()

istream & basic::resource_manager::locator::StringResourceStream::stream ( )
overridevirtual

Give non-const access to the internal stringstream so that it can be used to construct a resource.

Implements basic::resource_manager::ResourceStream.

References stream_.

Member Data Documentation

◆ stream_

std::stringstream basic::resource_manager::locator::StringResourceStream::stream_
private

Referenced by fill(), stream(), and StringResourceStream().


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