.. index:: pair: class; EE::System::IOStreamZip
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_zip:

class EE::System::IOStreamZip
=============================

.. toctree::
	:hidden:

Overview
~~~~~~~~

An implementation for a zip file steam. :ref:`More...<details-class_e_e_1_1_system_1_1_i_o_stream_zip>`


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

	#include <iostreamzip.hpp>
	
	class IOStreamZip: public :ref:`EE::System::IOStream<doxid-class_e_e_1_1_system_1_1_i_o_stream>` {
	public:
		// construction
	
		:ref:`IOStreamZip<doxid-class_e_e_1_1_system_1_1_i_o_stream_zip_1aa1928a97f50b5c6c903c7e0fabfd7f66>`(:ref:`Zip<doxid-class_e_e_1_1_system_1_1_zip>`* pack, const std::string& path);
		virtual :target:`~IOStreamZip<doxid-class_e_e_1_1_system_1_1_i_o_stream_zip_1ae5d12e681abdd27988f3a3e632cd8183>`();

		// methods
	
		static IOStreamZip* :target:`New<doxid-class_e_e_1_1_system_1_1_i_o_stream_zip_1a40169fb427d6785e9d6bcbf741b1c54e>`(:ref:`Zip<doxid-class_e_e_1_1_system_1_1_zip>`* pack, const std::string& path);
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`read<doxid-class_e_e_1_1_system_1_1_i_o_stream_zip_1af61c22d4b301b9e366ded1d33973cc0c>`(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_zip_1a50865f8015824d833f8affeac66ada94>`(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_zip_1a514faca586d29aa1efb98ba740799254>`(: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_zip_1ac685f283aa3dd2885b4862832a89c9d9>`();
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`getSize<doxid-class_e_e_1_1_system_1_1_i_o_stream_zip_1a54eec6027fa9f23f13214fd39cc7b446>`();
		virtual bool :ref:`isOpen<doxid-class_e_e_1_1_system_1_1_i_o_stream_zip_1afa30edea8f1f80340ad506d8838775c3>`();
	};

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_zip:

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

An implementation for a zip file steam.

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

.. index:: pair: function; IOStreamZip
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_zip_1aa1928a97f50b5c6c903c7e0fabfd7f66:

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

	IOStreamZip(:ref:`Zip<doxid-class_e_e_1_1_system_1_1_zip>`* pack, const std::string& path)

Open a file from a zip file.



.. rubric:: Parameters:

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

	*
		- pack

		- :ref:`Pack <doxid-class_e_e_1_1_system_1_1_pack>` to open from path

	*
		- path

		- Path of the file in the pack file

Methods
-------

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

.. 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_zip_1a50865f8015824d833f8affeac66ada94:

.. 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_zip_1a514faca586d29aa1efb98ba740799254:

.. 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_zip_1ac685f283aa3dd2885b4862832a89c9d9:

.. 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_zip_1a54eec6027fa9f23f13214fd39cc7b446:

.. 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_zip_1afa30edea8f1f80340ad506d8838775c3:

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

	virtual bool isOpen()



.. rubric:: Returns:

If the virtual stream file is open