org.apache.pekko.http.scaladsl.server.directives
FileUploadDirectives
Companion object FileUploadDirectives
trait FileUploadDirectives extends AnyRef
- Grouped
- Alphabetic
- By Inheritance
- FileUploadDirectives
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from FileUploadDirectives toany2stringadd[FileUploadDirectives] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (FileUploadDirectives, B)
- Implicit
- This member is added by an implicit conversion from FileUploadDirectives toArrowAssoc[FileUploadDirectives] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (FileUploadDirectives) => Boolean, msg: => Any): FileUploadDirectives
- Implicit
- This member is added by an implicit conversion from FileUploadDirectives toEnsuring[FileUploadDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (FileUploadDirectives) => Boolean): FileUploadDirectives
- Implicit
- This member is added by an implicit conversion from FileUploadDirectives toEnsuring[FileUploadDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): FileUploadDirectives
- Implicit
- This member is added by an implicit conversion from FileUploadDirectives toEnsuring[FileUploadDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): FileUploadDirectives
- Implicit
- This member is added by an implicit conversion from FileUploadDirectives toEnsuring[FileUploadDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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. - 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()
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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()
- 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()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from FileUploadDirectives toStringFormat[FileUploadDirectives] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (FileUploadDirectives, B)
- Implicit
- This member is added by an implicit conversion from FileUploadDirectives toArrowAssoc[FileUploadDirectives] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.