trait FileUploadDirectives extends AnyRef

Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. FileUploadDirectives
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

File upload directives

  1. def fileUpload(fieldName: String): Directive1[(FileInfo, Source[ByteString, Any])]

    Collects each body part that is a multipart file as a tuple containing metadata and a Source for streaming the file contents somewhere.

    Collects each body part that is a multipart file as a tuple containing metadata and a Source for streaming the file contents somewhere. If there is no such field the request will be rejected, if there are multiple file parts with the same name, the first one will be used and the subsequent ones ignored.

  2. def fileUploadAll(fieldName: String): Directive1[Seq[(FileInfo, Source[ByteString, Any])]]

    Collects each body part that is a multipart file as a tuple containing metadata and a Source for streaming the file contents somewhere.

    Collects each body part that is a multipart file as a tuple containing metadata and a Source for streaming the file contents somewhere. If there is no such field the request will be rejected. Files are buffered into temporary files on disk so in-memory buffers don't overflow. The temporary files are cleaned up once materialized, or on exit if the stream is not consumed.

    Annotations
    @ApiMayChange()
  3. def storeUploadedFile(fieldName: String, destFn: (FileInfo) ⇒ File): Directive[(FileInfo, File)]

    Streams the bytes of the file submitted using multipart with the given file name into a designated file on disk.

    Streams the bytes of the file submitted using multipart with the given file name into a designated file on disk. If there is an error writing to disk the request will be failed with the thrown exception, if there is no such field the request will be rejected, if there are multiple file parts with the same name, the first one will be used and the subsequent ones ignored.

    Annotations
    @ApiMayChange()
  4. def storeUploadedFiles(fieldName: String, destFn: (FileInfo) ⇒ File): Directive1[Seq[(FileInfo, File)]]

    Streams the bytes of the file submitted using multipart with the given field name into designated files on disk.

    Streams the bytes of the file submitted using multipart with the given field name into designated files on disk. If there is an error writing to disk the request will be failed with the thrown exception, if there is no such field the request will be rejected. Stored files are cleaned up on exit but not on failure.

    Annotations
    @ApiMayChange()
  5. def uploadedFile(fieldName: String): Directive1[(FileInfo, File)]

    Streams the bytes of the file submitted using multipart with the given file name into a temporary file on disk.

    Streams the bytes of the file submitted using multipart with the given file name into a temporary file on disk. If there is an error writing to disk the request will be failed with the thrown exception, if there is no such field the request will be rejected, if there are multiple file parts with the same name, the first one will be used and the subsequent ones ignored.

    Annotations
    @deprecated
    Deprecated

    (Since version 10.0.11) Deprecated in favor of storeUploadedFile which allows to specify a file to store the upload in.