Package io.vertx.rxjava3.core.http
Class HttpServerFileUpload
- java.lang.Object
-
- io.vertx.rxjava3.core.http.HttpServerFileUpload
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate,ReadStream<Buffer>,StreamBase
public class HttpServerFileUpload extends Object implements io.vertx.lang.rx.RxDelegate, ReadStream<Buffer>
Represents an file upload from an HTML FORM.NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<HttpServerFileUpload>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description HttpServerFileUpload(HttpServerFileUpload delegate)HttpServerFileUpload(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancancelStreamToFileSystem()Try to cancel the file system streaming, the streamed file will be deleted.Stringcharset()StringcontentTransferEncoding()StringcontentType()HttpServerFileUploadendHandler(Handler<Void> endHandler)Set an end handler.booleanequals(Object o)HttpServerFileUploadexceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.HttpServerFileUploadfetch(long amount)Fetch the specifiedamountof elements.AsyncFilefile()Stringfilename()HttpServerFileUploadgetDelegate()HttpServerFileUploadhandler(Handler<Buffer> handler)Set a data handler.inthashCode()booleanisSizeAvailable()Stringname()static HttpServerFileUploadnewInstance(HttpServerFileUpload arg)HttpServerFileUploadpause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.Pipe<Buffer>pipe()Pause this stream and return a to transfer the elements of this stream to a destination .CompletablepipeTo(WriteStream<Buffer> dst)Pipe thisReadStreamto theWriteStream.HttpServerFileUploadresume()Resume reading, and sets the buffer inflowingmode.CompletablerxPipeTo(WriteStream<Buffer> dst)Pipe thisReadStreamto theWriteStream.CompletablerxStreamToFileSystem(String filename)Stream the content of this upload to the given file on storage.longsize()The size of the upload may not be available until it is all read.CompletablestreamToFileSystem(String filename)Stream the content of this upload to the given file on storage.Flowable<Buffer>toFlowable()Observable<Buffer>toObservable()StringtoString()
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<HttpServerFileUpload> __TYPE_ARG
-
-
Constructor Detail
-
HttpServerFileUpload
public HttpServerFileUpload(HttpServerFileUpload delegate)
-
HttpServerFileUpload
public HttpServerFileUpload(Object delegate)
-
-
Method Detail
-
getDelegate
public HttpServerFileUpload getDelegate()
- Specified by:
getDelegatein interfaceReadStream<Buffer>- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate- Specified by:
getDelegatein interfaceStreamBase
-
toObservable
public Observable<Buffer> toObservable()
- Specified by:
toObservablein interfaceReadStream<Buffer>
-
toFlowable
public Flowable<Buffer> toFlowable()
- Specified by:
toFlowablein interfaceReadStream<Buffer>
-
pipe
public Pipe<Buffer> pipe()
Pause this stream and return a to transfer the elements of this stream to a destination . The stream will be resumed when the pipe will be wired to aWriteStream.- Specified by:
pipein interfaceReadStream<Buffer>- Returns:
- a pipe
-
pipeTo
public Completable pipeTo(WriteStream<Buffer> dst)
Pipe thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
pipeToin interfaceReadStream<Buffer>- Parameters:
dst- the destination write stream- Returns:
- a future notified when the write stream will be ended with the outcome
-
rxPipeTo
public Completable rxPipeTo(WriteStream<Buffer> dst)
Pipe thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
rxPipeToin interfaceReadStream<Buffer>- Parameters:
dst- the destination write stream- Returns:
- a future notified when the write stream will be ended with the outcome
-
exceptionHandler
public HttpServerFileUpload exceptionHandler(Handler<Throwable> handler)
Description copied from interface:ReadStreamSet an exception handler on the read stream.- Specified by:
exceptionHandlerin interfaceReadStream<Buffer>- Specified by:
exceptionHandlerin interfaceStreamBase- Parameters:
handler- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
handler
public HttpServerFileUpload handler(Handler<Buffer> handler)
Description copied from interface:ReadStreamSet a data handler. As data is read, the handler will be called with the data.- Specified by:
handlerin interfaceReadStream<Buffer>- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
public HttpServerFileUpload endHandler(Handler<Void> endHandler)
Description copied from interface:ReadStreamSet an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.- Specified by:
endHandlerin interfaceReadStream<Buffer>- Returns:
- a reference to this, so the API can be used fluently
-
pause
public HttpServerFileUpload pause()
Description copied from interface:ReadStreamPause theReadStream, it sets the buffer infetchmode and clears the actual demand.While it's paused, no data will be sent to the data
handler.- Specified by:
pausein interfaceReadStream<Buffer>- Returns:
- a reference to this, so the API can be used fluently
-
resume
public HttpServerFileUpload resume()
Description copied from interface:ReadStreamResume reading, and sets the buffer inflowingmode. If theReadStreamhas been paused, reading will recommence on it.- Specified by:
resumein interfaceReadStream<Buffer>- Returns:
- a reference to this, so the API can be used fluently
-
fetch
public HttpServerFileUpload fetch(long amount)
Description copied from interface:ReadStreamFetch the specifiedamountof elements. If theReadStreamhas been paused, reading will recommence with the specifiedamountof items, otherwise the specifiedamountwill be added to the current stream demand.- Specified by:
fetchin interfaceReadStream<Buffer>- Returns:
- a reference to this, so the API can be used fluently
-
streamToFileSystem
public Completable streamToFileSystem(String filename)
Stream the content of this upload to the given file on storage.If the stream has a failure or is cancelled the created file will be deleted.
- Parameters:
filename- the name of the file- Returns:
-
rxStreamToFileSystem
public Completable rxStreamToFileSystem(String filename)
Stream the content of this upload to the given file on storage.If the stream has a failure or is cancelled the created file will be deleted.
- Parameters:
filename- the name of the file- Returns:
-
cancelStreamToFileSystem
public boolean cancelStreamToFileSystem()
Try to cancel the file system streaming, the streamed file will be deleted.- Returns:
truewhen the stream is cancelled, otherwise it means that stream is finished
-
filename
public String filename()
- Returns:
- the filename which was used when upload the file.
-
name
public String name()
- Returns:
- the name of the attribute
-
contentType
public String contentType()
- Returns:
- the content type for the upload
-
contentTransferEncoding
public String contentTransferEncoding()
- Returns:
- the contentTransferEncoding for the upload
-
charset
public String charset()
- Returns:
- the charset for the upload
-
size
public long size()
The size of the upload may not be available until it is all read. CheckisSizeAvailable()to determine this- Returns:
- the size of the upload (in bytes)
-
isSizeAvailable
public boolean isSizeAvailable()
- Returns:
trueif the size of the upload can be retrieved viasize().
-
file
public AsyncFile file()
- Returns:
- the async uploaded file when
streamToFileSystem(java.lang.String)has been used and the file is available
-
newInstance
public static HttpServerFileUpload newInstance(HttpServerFileUpload arg)
-
-