:py:mod:`wfexs_backend.encrypted_fs`
====================================

.. py:module:: wfexs_backend.encrypted_fs

.. autodoc2-docstring:: wfexs_backend.encrypted_fs
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`EncryptedFSType <wfexs_backend.encrypted_fs.EncryptedFSType>`
     -

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`_mountEncFS <wfexs_backend.encrypted_fs._mountEncFS>`
     - .. autodoc2-docstring:: wfexs_backend.encrypted_fs._mountEncFS
          :summary:
   * - :py:obj:`_mountGoCryptFS <wfexs_backend.encrypted_fs._mountGoCryptFS>`
     - .. autodoc2-docstring:: wfexs_backend.encrypted_fs._mountGoCryptFS
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`DEFAULT_ENCRYPTED_FS_TYPE <wfexs_backend.encrypted_fs.DEFAULT_ENCRYPTED_FS_TYPE>`
     - .. autodoc2-docstring:: wfexs_backend.encrypted_fs.DEFAULT_ENCRYPTED_FS_TYPE
          :summary:
   * - :py:obj:`DEFAULT_ENCRYPTED_FS_CMD <wfexs_backend.encrypted_fs.DEFAULT_ENCRYPTED_FS_CMD>`
     - .. autodoc2-docstring:: wfexs_backend.encrypted_fs.DEFAULT_ENCRYPTED_FS_CMD
          :summary:
   * - :py:obj:`DEFAULT_ENCRYPTED_FS_IDLE_TIMEOUT <wfexs_backend.encrypted_fs.DEFAULT_ENCRYPTED_FS_IDLE_TIMEOUT>`
     - .. autodoc2-docstring:: wfexs_backend.encrypted_fs.DEFAULT_ENCRYPTED_FS_IDLE_TIMEOUT
          :summary:
   * - :py:obj:`ENCRYPTED_FS_MOUNT_IMPLEMENTATIONS <wfexs_backend.encrypted_fs.ENCRYPTED_FS_MOUNT_IMPLEMENTATIONS>`
     - .. autodoc2-docstring:: wfexs_backend.encrypted_fs.ENCRYPTED_FS_MOUNT_IMPLEMENTATIONS
          :summary:

API
~~~

.. py:exception:: EncryptedFSException()
   :canonical: wfexs_backend.encrypted_fs.EncryptedFSException

   Bases: :py:obj:`wfexs_backend.common.AbstractWfExSException`

.. py:class:: EncryptedFSType(*args, **kwds)
   :canonical: wfexs_backend.encrypted_fs.EncryptedFSType

   Bases: :py:obj:`enum.Enum`

   .. py:attribute:: EncFS
      :canonical: wfexs_backend.encrypted_fs.EncryptedFSType.EncFS
      :value: 'encfs'

      .. autodoc2-docstring:: wfexs_backend.encrypted_fs.EncryptedFSType.EncFS

   .. py:attribute:: GoCryptFS
      :canonical: wfexs_backend.encrypted_fs.EncryptedFSType.GoCryptFS
      :value: 'gocryptfs'

      .. autodoc2-docstring:: wfexs_backend.encrypted_fs.EncryptedFSType.GoCryptFS

.. py:data:: DEFAULT_ENCRYPTED_FS_TYPE
   :canonical: wfexs_backend.encrypted_fs.DEFAULT_ENCRYPTED_FS_TYPE
   :value: None

   .. autodoc2-docstring:: wfexs_backend.encrypted_fs.DEFAULT_ENCRYPTED_FS_TYPE

.. py:data:: DEFAULT_ENCRYPTED_FS_CMD
   :canonical: wfexs_backend.encrypted_fs.DEFAULT_ENCRYPTED_FS_CMD
   :value: None

   .. autodoc2-docstring:: wfexs_backend.encrypted_fs.DEFAULT_ENCRYPTED_FS_CMD

.. py:data:: DEFAULT_ENCRYPTED_FS_IDLE_TIMEOUT
   :canonical: wfexs_backend.encrypted_fs.DEFAULT_ENCRYPTED_FS_IDLE_TIMEOUT
   :value: 5

   .. autodoc2-docstring:: wfexs_backend.encrypted_fs.DEFAULT_ENCRYPTED_FS_IDLE_TIMEOUT

.. py:function:: _mountEncFS(encfs_cmd: pathlib.Path, encfs_idleMinutes: int, uniqueEncWorkDir: pathlib.Path, uniqueWorkDir: pathlib.Path, uniqueRawWorkDir: pathlib.Path, clearPass: str, allowOther: bool = False) -> None
   :canonical: wfexs_backend.encrypted_fs._mountEncFS

   .. autodoc2-docstring:: wfexs_backend.encrypted_fs._mountEncFS

.. py:function:: _mountGoCryptFS(gocryptfs_cmd: pathlib.Path, gocryptfs_idleMinutes: int, uniqueEncWorkDir: pathlib.Path, uniqueWorkDir: pathlib.Path, uniqueRawWorkDir: pathlib.Path, clearPass: str, allowOther: bool = False) -> None
   :canonical: wfexs_backend.encrypted_fs._mountGoCryptFS

   .. autodoc2-docstring:: wfexs_backend.encrypted_fs._mountGoCryptFS

.. py:data:: ENCRYPTED_FS_MOUNT_IMPLEMENTATIONS
   :canonical: wfexs_backend.encrypted_fs.ENCRYPTED_FS_MOUNT_IMPLEMENTATIONS
   :value: None

   .. autodoc2-docstring:: wfexs_backend.encrypted_fs.ENCRYPTED_FS_MOUNT_IMPLEMENTATIONS