pekko/akka-docs/rst/scala/http/routing-dsl/directives/file-and-resource-directives/getFromDirectory.rst

.. _-getFromDirectory-:

getFromDirectory
================

Signature
---------

.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/FileAndResourceDirectives.scala
   :snippet: getFromDirectory

Description
-----------

Allows exposing a directory's files for GET requests for its contents.

The ``unmatchedPath`` (see :ref:`-extractUnmatchedPath-`) of the ``RequestContext`` is first transformed by
the given ``pathRewriter`` function, before being appended to the given directory name to build the final file name.

To serve a single file use :ref:`-getFromFile-`.
To serve browsable directory listings use :ref:`-getFromBrowseableDirectories-`.
To serve files from a classpath directory use :ref:`-getFromResourceDirectory-` instead.

Note that it's not required to wrap this directive with ``get`` as this directive will only respond to ``GET`` requests.

.. note::
  The file's contents will be read using an Akka Streams `Source` which *automatically uses
  a pre-configured dedicated blocking io dispatcher*, which separates the blocking file operations from the rest of the stream.

  Note also that thanks to using Akka Streams internally, the file will be served at the highest speed reachable by
  the client, and not faster – i.e. the file will *not* end up being loaded in full into memory before writing it to
  the client.

Example
-------

.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/FileAndResourceDirectivesExamplesSpec.scala
   :snippet: getFromDirectory-examples