Package io.vertx.mutiny.ext.web
Class FileUpload
java.lang.Object
io.vertx.mutiny.ext.web.FileUpload
- All Implemented Interfaces:
MutinyDelegate
Represents a file-upload from an HTTP multipart form submission.
NOTE: This class has been automatically generated from the
original
non Mutiny-ified interface using Vert.x codegen.-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionFileUpload
(io.vertx.ext.web.FileUpload delegate) FileUpload
(Object delegate) -
Method Summary
Modifier and TypeMethodDescriptionboolean
cancel()
charSet()
io.smallrye.mutiny.Uni<Void>
delete()
Delete the uploaded file on the disk.Blocking variant ofdelete()
.void
Variant ofdelete()
that ignores the result of the operation.boolean
fileName()
io.vertx.ext.web.FileUpload
int
hashCode()
name()
static FileUpload
newInstance
(io.vertx.ext.web.FileUpload arg) long
size()
toString()
-
Field Details
-
__TYPE_ARG
-
-
Constructor Details
-
FileUpload
public FileUpload(io.vertx.ext.web.FileUpload delegate) -
FileUpload
-
-
Method Details
-
getDelegate
public io.vertx.ext.web.FileUpload getDelegate()- Specified by:
getDelegate
in interfaceMutinyDelegate
- Returns:
- the delegate used by this Mutiny object of generated type
-
toString
-
equals
-
hashCode
public int hashCode() -
name
- Returns:
- the name of the upload as provided in the form submission
-
uploadedFileName
- Returns:
- the actual temporary file name on the server where the file was uploaded to.
-
fileName
- Returns:
- the file name of the upload as provided in the form submission
-
size
public long size()- Returns:
- the size of the upload, in bytes
-
contentType
- Returns:
- the content type (MIME type) of the upload
-
contentTransferEncoding
- Returns:
- the content transfer encoding of the upload - this describes how the upload was encoded in the form submission.
-
charSet
- Returns:
- the charset of the upload
-
cancel
public boolean cancel()- Returns:
true
when the upload was cancelled,false
when the upload is finished and the file is available
-
delete
Delete the uploaded file on the disk.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
deleteAndAwait
Blocking variant ofdelete()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the Void instance produced by the operation.
-
deleteAndForget
public void deleteAndForget() -
newInstance
-