pekko/akka-docs-dev/rst/scala/http/directives/file-and-resource-directives/getFromResource.rst

23 lines
No EOL
800 B
ReStructuredText

.. _-getFromResource-:
getFromResource
===============
Completes GET requests with the content of the given classpath resource.
Signature
---------
.. includecode2:: /../../akka-http/src/main/scala/akka/http/server/directives/FileAndResourceDirectives.scala
:snippet: getFromResource
Description
-----------
The actual I/O operation is running detached in a `Future`, so it doesn't block the current thread (but potentially
some other thread !). If the file cannot be found or read the request is rejected.
To serve files from a classpath directory use ``getFromResourceDirectory`` instead. To serve files from a filesystem
directory use ``getFromDirectory``, instead.
Note that it's not required to wrap this directive with ``get`` as this directive will only respond to ``GET`` requests.