class HttpServerFileUpload extends ReadStream[Buffer]

Represents an file upload from an HTML FORM.

Linear Supertypes
ReadStream[Buffer], StreamBase, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpServerFileUpload
  2. ReadStream
  3. StreamBase
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HttpServerFileUpload(_asJava: AnyRef)

Value Members

  1. def asJava: AnyRef
    Definition Classes
    HttpServerFileUpload → ReadStream → StreamBase
  2. def charset(): String

    returns

    the charset for the upload

  3. def contentTransferEncoding(): String

    returns

    the contentTransferEncoding for the upload

  4. def contentType(): String

    returns

    the content type for the upload

  5. def endHandler(endHandler: Handler[Unit]): HttpServerFileUpload

    Set an end handler.

    Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called. * @return a reference to this, so the API can be used fluently

    Definition Classes
    HttpServerFileUpload → ReadStream
  6. def exceptionHandler(handler: Handler[Throwable]): HttpServerFileUpload

    Set an exception handler on the read stream.

    Set an exception handler on the read stream. * @param handler the exception handler

    returns

    a reference to this, so the API can be used fluently

    Definition Classes
    HttpServerFileUpload → ReadStream → StreamBase
  7. def fetch(amount: Long): HttpServerFileUpload

    Fetch the specified amount of elements.

    Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand. * @return a reference to this, so the API can be used fluently

    Definition Classes
    HttpServerFileUpload → ReadStream
  8. def filename(): String

    returns

    the filename which was used when upload the file.

  9. def handler(handler: Handler[Buffer]): HttpServerFileUpload

    Set a data handler.

    Set a data handler. As data is read, the handler will be called with the data. * @return a reference to this, so the API can be used fluently

    Definition Classes
    HttpServerFileUpload → ReadStream
  10. def isSizeAvailable(): Boolean

    returns

    true if the size of the upload can be retrieved via #size().

  11. def name(): String

    returns

    the name of the attribute

  12. def pause(): HttpServerFileUpload

    Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.

    Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.

    While it's paused, no data will be sent to the data handler. * @return a reference to this, so the API can be used fluently

    Definition Classes
    HttpServerFileUpload → ReadStream
  13. def resume(): HttpServerFileUpload

    Resume reading, and sets the buffer in flowing mode.

    Resume reading, and sets the buffer in flowing mode.

    If the ReadStream has been paused, reading will recommence on it. * @return a reference to this, so the API can be used fluently

    Definition Classes
    HttpServerFileUpload → ReadStream
  14. def size(): Long

    The size of the upload may not be available until it is all read.

    The size of the upload may not be available until it is all read. Check io.vertx.scala.core.http.HttpServerFileUpload#isSizeAvailable to determine this * @return the size of the upload (in bytes)

  15. def streamToFileSystem(filename: String): HttpServerFileUpload

    Stream the content of this upload to the given file on storage.

    Stream the content of this upload to the given file on storage. * @param filename the name of the file