.. index:: pair: class; EE::System::IOStreamFileMapped
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped:

class EE::System::IOStreamFileMapped
====================================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	#include <iostreamfilemapped.hpp>
	
	class IOStreamFileMapped: public :ref:`EE::System::IOStream<doxid-class_e_e_1_1_system_1_1_i_o_stream>` {
	public:
		// construction
	
		:target:`IOStreamFileMapped<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1a78a65fa62266f4b119fd0e0a37e9bf83>`();
		:target:`IOStreamFileMapped<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1ada7e7a97b58c7e43bf78015ea1af08e1>`(const std::string& path);
		:target:`IOStreamFileMapped<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1a448c61b0c012c0b979aa18ffdf6a464c>`(:ref:`FileMapped<doxid-class_e_e_1_1_system_1_1_file_mapped>`&& file);
		:target:`IOStreamFileMapped<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1a50ce7be4cdf089b9eedc5acfb36f0bd7>`(const IOStreamFileMapped&);
		:target:`IOStreamFileMapped<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1a354e6b4df8c61f2eeebb1b3daf1a6c84>`(IOStreamFileMapped&&);
		:target:`~IOStreamFileMapped<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1aa79a96de39df7e7c4a4cbcd45831a056>`();

		// methods
	
		IOStreamFileMapped& :target:`operator=<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1aad9000d4956e9da3d5247ce8d7185ddd>`(const IOStreamFileMapped&);
		IOStreamFileMapped& :target:`operator=<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1a2c1b074c8060a621e5cc4d8d97b5ddf9>`(IOStreamFileMapped&&);
		bool :target:`open<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1a81bdd91763d5da89d324b47636f53b31>`(const std::string& path);
		void :target:`close<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1a5d714bfef285892a3992657d81bf3fa8>`();
		virtual :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` :ref:`read<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1a9d8fe3a6734dde989ef04c28c8d9dea5>`(char* data, :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` size);
		virtual :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` :ref:`write<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1af391dede29ffabecf465244311e7413f>`(const char* data, :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` size);
		virtual :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` :ref:`seek<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1a45bbebb6a003f18b70487898a8316f3d>`(:ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` position);
		virtual :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` :ref:`tell<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1a9d3b5d396f8a977b124e1678e50b74cc>`();
		virtual :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` :ref:`getSize<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1acb6cf2bb0b81ea6f4828db632b2b3d28>`();
		virtual bool :ref:`isOpen<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1ac58985f8c77ad33f034756fc38c679f3>`();
		const :ref:`FileMapped<doxid-class_e_e_1_1_system_1_1_file_mapped>`& :target:`getMappedFile<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1ab51aae00b458a558c0679a213e63b3f0>`() const;
		:ref:`FileMapped<doxid-class_e_e_1_1_system_1_1_file_mapped>`& :target:`getMappedFile<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1a56b1adf02d063d2e5423f7108c564cfd>`();
		const std::string& :target:`getLastError<doxid-class_e_e_1_1_system_1_1_i_o_stream_file_mapped_1a9ffdba16afff499ef664aa82a2739360>`() const;
	};

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

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

	public:
		// methods
	
		virtual :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` :ref:`read<doxid-class_e_e_1_1_system_1_1_i_o_stream_1a673723c6ec387b362ff35e7ee28947e6>`(char* data, :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` size) = 0;
		virtual :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` :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_1adbc8ce4db8a03799d9db18e0e7b7ed31>` size) = 0;
		virtual :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` :ref:`seek<doxid-class_e_e_1_1_system_1_1_i_o_stream_1a961402e4701874fef9c276e09798dc2c>`(:ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` position) = 0;
		virtual :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` :ref:`tell<doxid-class_e_e_1_1_system_1_1_i_o_stream_1aeb41a08fa5f58c311192073bd126291b>`() = 0;
		virtual :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` :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_file_mapped:

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



Methods
-------

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

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

	virtual :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` read(char* data, :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` 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_file_mapped_1af391dede29ffabecf465244311e7413f:

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

	virtual :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` write(const char* data, :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` 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 written

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

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

	virtual :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` seek(:ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` 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_file_mapped_1a9d3b5d396f8a977b124e1678e50b74cc:

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

	virtual :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` 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_file_mapped_1acb6cf2bb0b81ea6f4828db632b2b3d28:

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

	virtual :ref:`ios_size<doxid-namespace_e_e_1adbc8ce4db8a03799d9db18e0e7b7ed31>` 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_file_mapped_1ac58985f8c77ad33f034756fc38c679f3:

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

	virtual bool isOpen()



.. rubric:: Returns:

If the virtual stream file is open