.. index:: pair: namespace; docker_handle
.. _doxid-namespacedocker__handle:

namespace docker_handle
=======================

.. toctree::
	:hidden:

	class_docker_handle_NRPDockerHandle.rst

Overview
~~~~~~~~




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

	
	namespace docker_handle {

	// classes

	class :ref:`NRPDockerHandle<doxid-classdocker__handle_1_1_n_r_p_docker_handle>`;

	// global functions

	(bool, str) :ref:`container_put_archive<doxid-namespacedocker__handle_1acd9d181a2d83c46d07eff197db228e9c>`(
		docker.models.containers.Container container,
		str archive_path,
		str container_path
	);

	(bool, str) :ref:`container_get_archive<doxid-namespacedocker__handle_1ad0ca4b68c4f3f6c7fb8f53b35a4044f1>`(
		docker.models.containers.Container container,
		str archive_path,
		str host_path
	);

	} // namespace docker_handle
.. _details-namespacedocker__handle:

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



Global Functions
----------------

.. index:: pair: function; container_put_archive
.. _doxid-namespacedocker__handle_1acd9d181a2d83c46d07eff197db228e9c:

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

	(bool, str) container_put_archive(
		docker.models.containers.Container container,
		str archive_path,
		str container_path
	)

.. code-block:: cpp

	Put archive in container from host filesystem
	
	:param container: docker container where the archive will be put
	:param archive_path archive path in the host filesystem
	:param container_path path in the container where the archive will be extracted
	:returns a bool indicating whether the operation succeed or not and an error msg if it didn't

.. index:: pair: function; container_get_archive
.. _doxid-namespacedocker__handle_1ad0ca4b68c4f3f6c7fb8f53b35a4044f1:

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

	(bool, str) container_get_archive(
		docker.models.containers.Container container,
		str archive_path,
		str host_path
	)

.. code-block:: cpp

	Get archive from a container and extract it in the host filesystem
	
	   :param container: docker container containing the archive to be retrieved
	   :param archive_path archive path in the container
	   :param host_path path in the host filesystem where the archive will be extracted
	   :returns a bool indicating whether the operation succeed or not and an error msg if it didn't