.. index:: pair: class; EE::System::IOStreamMemory
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_memory:

class EE::System::IOStreamMemory
================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Implementation of a memory stream file. :ref:`More...<details-class_e_e_1_1_system_1_1_i_o_stream_memory>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <iostreammemory.hpp>
	
	class IOStreamMemory: public :ref:`EE::System::IOStream<doxid-class_e_e_1_1_system_1_1_i_o_stream>` {
	public:
		// construction
	
		:ref:`IOStreamMemory<doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1a7c7c4f7b617442853b7fd6c4abb22cf6>`(const char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size);
		:ref:`IOStreamMemory<doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1a3ab3928d827a69704d8f71c0df0cac11>`(char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size);
		virtual :target:`~IOStreamMemory<doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1aa032aa214e7c3f05bb9c956a16e06e93>`();

		// methods
	
		static IOStreamMemory* :target:`New<doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1a04deb058a307b5f0da8cbdb81d106f0b>`(const char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size);
		static IOStreamMemory* :target:`New<doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1ab092baaa21bed692272d9da3cd279a0c>`(char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size);
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`read<doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1a4d65bd4759dede4d54b0c24fb44475f3>`(char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size);
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`write<doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1afce19d4897158b81be5ac9b17b7658c1>`(const char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size);
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`seek<doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1a7c4f5895eb00253118a58385253eb849>`(:ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` position);
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`tell<doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1a4af7adc777c535738ddcdd27cbff9cdd>`();
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`getSize<doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1a0811f2791bc174c799c7d4459c1ef4b9>`();
		virtual bool :ref:`isOpen<doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1a2fe0e7abc2d957f70305b42450fbeaa7>`();
	};

Inherited Members
-----------------

.. ref-code-block:: cpp
	:class: doxyrest-overview-inherited-code-block

	public:
		// methods
	
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`read<doxid-class_e_e_1_1_system_1_1_i_o_stream_1a673723c6ec387b362ff35e7ee28947e6>`(char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size) = 0;
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`write<doxid-class_e_e_1_1_system_1_1_i_o_stream_1a1c3860c1fe8b8387203c0912b0d222c6>`(const char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size) = 0;
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`seek<doxid-class_e_e_1_1_system_1_1_i_o_stream_1a961402e4701874fef9c276e09798dc2c>`(:ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` position) = 0;
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`tell<doxid-class_e_e_1_1_system_1_1_i_o_stream_1aeb41a08fa5f58c311192073bd126291b>`() = 0;
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`getSize<doxid-class_e_e_1_1_system_1_1_i_o_stream_1af2b9d259a0eeb4e839417f7f71b1c117>`() = 0;
		virtual bool :ref:`isOpen<doxid-class_e_e_1_1_system_1_1_i_o_stream_1a1c6877dde5607fe00591ad4b4ce0bbf2>`() = 0;

.. _details-class_e_e_1_1_system_1_1_i_o_stream_memory:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Implementation of a memory stream file.

Construction
------------

.. index:: pair: function; IOStreamMemory
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1a7c7c4f7b617442853b7fd6c4abb22cf6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	IOStreamMemory(const char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size)

Use the data buffer for reading.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- data

		- The buffer to read from

	*
		- size

		- The size of the buffer

.. index:: pair: function; IOStreamMemory
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1a3ab3928d827a69704d8f71c0df0cac11:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	IOStreamMemory(char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size)

Use the data buffer for writing.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- data

		- The buffer to write to

	*
		- size

		- The size of the buffer

Methods
-------

.. index:: pair: function; read
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1a4d65bd4759dede4d54b0c24fb44475f3:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` read(char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size)

Read data from the stream.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- data

		- Buffer where to copy the read data

	*
		- size

		- Desired number of bytes to read



.. rubric:: Returns:

The number of bytes actually read

.. index:: pair: function; write
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1afce19d4897158b81be5ac9b17b7658c1:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` write(const char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size)

Write data to the virtual file.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- data

		- Data to write in the file

	*
		- size

		- Size of the data that needs to be writed

.. index:: pair: function; seek
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1a7c4f5895eb00253118a58385253eb849:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` seek(:ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` position)

Change the current reading position.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- position

		- The position to seek to, from the beginning



.. rubric:: Returns:

The position actually sought to.

.. index:: pair: function; tell
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1a4af7adc777c535738ddcdd27cbff9cdd:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` tell()

Get the current reading position in the stream.



.. rubric:: Returns:

The current position, or -1 on error.

.. index:: pair: function; getSize
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1a0811f2791bc174c799c7d4459c1ef4b9:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` getSize()

Return the size of the stream.



.. rubric:: Returns:

The total number of bytes available in the stream

.. index:: pair: function; isOpen
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_memory_1a2fe0e7abc2d957f70305b42450fbeaa7:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual bool isOpen()



.. rubric:: Returns:

If the virtual stream file is open