Package io.vertx.mutiny.core.file

Class AsyncFile

java.lang.Object
io.vertx.mutiny.core.file.AsyncFile
All Implemented Interfaces:
MutinyDelegate, ReadStream<io.vertx.core.buffer.Buffer>, StreamBase, WriteStream<io.vertx.core.buffer.Buffer>
public class AsyncFile extends Object implements ReadStream<io.vertx.core.buffer.Buffer>, WriteStream<io.vertx.core.buffer.Buffer>, MutinyDelegate
Represents a file on the file-system which can be read from, or written to asynchronously.

This class also implements ReadStream and WriteStream. This allows the data to be piped to and from other streams, e.g. an HttpClientRequest instance, using the Pipe class

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:
Tim Fox
See Also:
  • AsyncFile

  • Field Details

  • Constructor Details

    • AsyncFile

      public AsyncFile(io.vertx.core.file.AsyncFile delegate)
      Create a new instance of AsyncFile delegating to the given (non-null) instance of AsyncFile.

    • AsyncFile

      public AsyncFile(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.core.file.AsyncFile getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface MutinyDelegate
      Specified by:
      getDelegate in interface ReadStream<io.vertx.core.buffer.Buffer>
      Specified by:
      getDelegate in interface StreamBase
      Specified by:
      getDelegate in interface WriteStream<io.vertx.core.buffer.Buffer>
      Returns:
      the delegate instance

    • close

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> close()
      Close the file. The actual close happens asynchronously.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • AsyncFile.close()

    • closeAndAwait

      public void closeAndAwait()
      Close the file. The actual close happens asynchronously.

      Unlike the bare Vert.x variant, this method returns a Void. This method awaits indefinitely 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).

      See Also:
      • AsyncFile.close()

    • closeAndForget

      public AsyncFile closeAndForget()
      Close the file. The actual close happens asynchronously.

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • AsyncFile.close()

    • write

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> write(io.vertx.core.buffer.Buffer buffer, long position)
      Write a Buffer to the file at position position in the file, asynchronously.

      If position lies outside of the current size of the file, the file will be enlarged to encompass it.

      When multiple writes are invoked on the same file there are no guarantees as to order in which those writes actually occur

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      buffer - the buffer to write
      position - the position in the file to write it at
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • AsyncFile.write(Buffer, long)

    • writeAndAwait

      public void writeAndAwait(io.vertx.core.buffer.Buffer buffer, long position)
      Write a Buffer to the file at position position in the file, asynchronously.

      If position lies outside of the current size of the file, the file will be enlarged to encompass it.

      When multiple writes are invoked on the same file there are no guarantees as to order in which those writes actually occur

      Unlike the bare Vert.x variant, this method returns a Void. This method awaits indefinitely 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).

      Parameters:
      buffer - the buffer to write
      position - the position in the file to write it at
      See Also:
      • AsyncFile.write(Buffer, long)

    • writeAndForget

      public AsyncFile writeAndForget(io.vertx.core.buffer.Buffer buffer, long position)
      Write a Buffer to the file at position position in the file, asynchronously.

      If position lies outside of the current size of the file, the file will be enlarged to encompass it.

      When multiple writes are invoked on the same file there are no guarantees as to order in which those writes actually occur

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Parameters:
      buffer - the buffer to write
      position - the position in the file to write it at
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • AsyncFile.write(Buffer, long)

    • read

      @CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.core.buffer.Buffer> read(io.vertx.core.buffer.Buffer buffer, int offset, long position, int length)
      Reads length bytes of data from the file at position position in the file, asynchronously.

      The read data will be written into the specified Buffer buffer at position offset.

      If data is read past the end of the file then zero bytes will be read.

      When multiple reads are invoked on the same file there are no guarantees as to order in which those reads actually occur.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      buffer - the buffer to read into
      offset - the offset into the buffer where the data will be read
      position - the position in the file where to start reading
      length - the number of bytes to read
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • AsyncFile.read(Buffer, int, long, int)

    • readAndAwait

      public io.vertx.core.buffer.Buffer readAndAwait(io.vertx.core.buffer.Buffer buffer, int offset, long position, int length)
      Reads length bytes of data from the file at position position in the file, asynchronously.

      The read data will be written into the specified Buffer buffer at position offset.

      If data is read past the end of the file then zero bytes will be read.

      When multiple reads are invoked on the same file there are no guarantees as to order in which those reads actually occur.

      Unlike the bare Vert.x variant, this method returns a Buffer. This method awaits indefinitely 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).

      Parameters:
      buffer - the buffer to read into
      offset - the offset into the buffer where the data will be read
      position - the position in the file where to start reading
      length - the number of bytes to read
      Returns:
      The operation result
      See Also:
      • AsyncFile.read(Buffer, int, long, int)

    • readAndForget

      public AsyncFile readAndForget(io.vertx.core.buffer.Buffer buffer, int offset, long position, int length)
      Reads length bytes of data from the file at position position in the file, asynchronously.

      The read data will be written into the specified Buffer buffer at position offset.

      If data is read past the end of the file then zero bytes will be read.

      When multiple reads are invoked on the same file there are no guarantees as to order in which those reads actually occur.

      Unlike the bare Vert.x variant, this method ignores the Buffer result or any failure.

      Parameters:
      buffer - the buffer to read into
      offset - the offset into the buffer where the data will be read
      position - the position in the file where to start reading
      length - the number of bytes to read
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • AsyncFile.read(Buffer, int, long, int)

    • flush

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> flush()
      Flush any writes made to this file to underlying persistent storage.

      If the file was opened with flush set to true then calling this method will have no effect.

      The actual flush will happen asynchronously.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • AsyncFile.flush()

    • flushAndAwait

      public void flushAndAwait()
      Flush any writes made to this file to underlying persistent storage.

      If the file was opened with flush set to true then calling this method will have no effect.

      The actual flush will happen asynchronously.

      Unlike the bare Vert.x variant, this method returns a Void. This method awaits indefinitely 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).

      See Also:
      • AsyncFile.flush()

    • flushAndForget

      public AsyncFile flushAndForget()
      Flush any writes made to this file to underlying persistent storage.

      If the file was opened with flush set to true then calling this method will have no effect.

      The actual flush will happen asynchronously.

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • AsyncFile.flush()

    • size

      @CheckReturnValue public io.smallrye.mutiny.Uni<Long> size()

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • AsyncFile.size()

    • sizeAndAwait

      public Long sizeAndAwait()

      Unlike the bare Vert.x variant, this method returns a Long. This method awaits indefinitely 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 operation result
      See Also:
      • AsyncFile.size()

    • sizeAndForget

      public AsyncFile sizeAndForget()

      Unlike the bare Vert.x variant, this method ignores the Long result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • AsyncFile.size()

    • lock

      @CheckReturnValue public io.smallrye.mutiny.Uni<AsyncFileLock> lock()
      Acquire a non-shared lock on the entire file.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • AsyncFile.lock()

    • lockAndAwait

      public AsyncFileLock lockAndAwait()
      Acquire a non-shared lock on the entire file.

      Unlike the bare Vert.x variant, this method returns a AsyncFileLock. This method awaits indefinitely 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 operation result
      See Also:
      • AsyncFile.lock()

    • lockAndForget

      public AsyncFile lockAndForget()
      Acquire a non-shared lock on the entire file.

      Unlike the bare Vert.x variant, this method ignores the AsyncFileLock result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • AsyncFile.lock()

    • lock

      @CheckReturnValue public io.smallrye.mutiny.Uni<AsyncFileLock> lock(long position, long size, boolean shared)
      Acquire a lock on a portion of this file.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      position - where the region starts
      size - the size of the region
      shared - whether the lock should be shared
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • AsyncFile.lock(long, long, boolean)

    • lockAndAwait

      public AsyncFileLock lockAndAwait(long position, long size, boolean shared)
      Acquire a lock on a portion of this file.

      Unlike the bare Vert.x variant, this method returns a AsyncFileLock. This method awaits indefinitely 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).

      Parameters:
      position - where the region starts
      size - the size of the region
      shared - whether the lock should be shared
      Returns:
      The operation result
      See Also:
      • AsyncFile.lock(long, long, boolean)

    • lockAndForget

      public AsyncFile lockAndForget(long position, long size, boolean shared)
      Acquire a lock on a portion of this file.

      Unlike the bare Vert.x variant, this method ignores the AsyncFileLock result or any failure.

      Parameters:
      position - where the region starts
      size - the size of the region
      shared - whether the lock should be shared
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • AsyncFile.lock(long, long, boolean)

    • withLock

      @CheckReturnValue public <T> io.smallrye.mutiny.Uni<T> withLock(Supplier<io.smallrye.mutiny.Uni<T>> block)
      Acquire a non-shared lock on the entire file.

      When the block is called, the lock is already acquired, it will be released when the Future<T> returned by the block completes.

      When the block fails, the lock is released and the returned uni is failed with the cause of the failure.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      block - the code block called after lock acquisition
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • AsyncFile.withLock(Supplier)

    • withLockAndAwait

      public <T> T withLockAndAwait(Supplier<io.smallrye.mutiny.Uni<T>> block)
      Acquire a non-shared lock on the entire file.

      When the block is called, the lock is already acquired, it will be released when the Future<T> returned by the block completes.

      When the block fails, the lock is released and the returned underlying uni is failed with the cause of the failure.

      Unlike the bare Vert.x variant, this method returns a AsyncFile. This method awaits indefinitely 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).

      Parameters:
      block - the code block called after lock acquisition
      Returns:
      The operation result
      See Also:
      • AsyncFile.withLock(Supplier)

    • withLockAndForget

      public <T> AsyncFile withLockAndForget(Supplier<io.smallrye.mutiny.Uni<T>> block)
      Acquire a non-shared lock on the entire file.

      When the block is called, the lock is already acquired, it will be released when the Future<T> returned by the block completes.

      When the block fails, the lock is released and the returned underlying uni is failed with the cause of the failure.

      Unlike the bare Vert.x variant, this method ignores the AsyncFile result or any failure.

      Parameters:
      block - the code block called after lock acquisition
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • AsyncFile.withLock(Supplier)

    • withLock

      @CheckReturnValue public <T> io.smallrye.mutiny.Uni<T> withLock(long position, long size, boolean shared, Supplier<io.smallrye.mutiny.Uni<T>> block)
      Acquire a lock on a portion of this file.

      When the block is called, the lock is already acquired , it will be released when the Future<T> returned by the block completes.

      When the block fails, the lock is released and the returned uni is failed with the cause of the failure.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      position - where the region starts
      size - the size of the region
      shared - whether the lock should be shared
      block - the code block called after lock acquisition
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • AsyncFile.withLock(long, long, boolean, Supplier)

    • withLockAndAwait

      public <T> T withLockAndAwait(long position, long size, boolean shared, Supplier<io.smallrye.mutiny.Uni<T>> block)
      Acquire a lock on a portion of this file.

      When the block is called, the lock is already acquired , it will be released when the Future<T> returned by the block completes.

      When the block fails, the lock is released and the returned underlying uni is failed with the cause of the failure.

      Unlike the bare Vert.x variant, this method returns a AsyncFile. This method awaits indefinitely 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).

      Parameters:
      position - where the region starts
      size - the size of the region
      shared - whether the lock should be shared
      block - the code block called after lock acquisition
      Returns:
      The operation result
      See Also:
      • AsyncFile.withLock(long, long, boolean, Supplier)

    • withLockAndForget

      public <T> AsyncFile withLockAndForget(long position, long size, boolean shared, Supplier<io.smallrye.mutiny.Uni<T>> block)
      Acquire a lock on a portion of this file.

      When the block is called, the lock is already acquired , it will be released when the Future<T> returned by the block completes.

      When the block fails, the lock is released and the returned underlying uni is failed with the cause of the failure.

      Unlike the bare Vert.x variant, this method ignores the AsyncFile result or any failure.

      Parameters:
      position - where the region starts
      size - the size of the region
      shared - whether the lock should be shared
      block - the code block called after lock acquisition
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • AsyncFile.withLock(long, long, boolean, Supplier)

    • end

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> end()
      Ends the stream.

      Once the stream has ended, it cannot be used any more.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Specified by:
      end in interface WriteStream<io.vertx.core.buffer.Buffer>
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WriteStream.end()

    • endAndAwait

      public void endAndAwait()
      Ends the stream.

      Once the stream has ended, it cannot be used any more.

      Unlike the bare Vert.x variant, this method returns a Void. This method awaits indefinitely 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).

      See Also:
      • WriteStream.end()

    • endAndForget

      public AsyncFile endAndForget()
      Ends the stream.

      Once the stream has ended, it cannot be used any more.

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WriteStream.end()

    • end

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> end(io.vertx.core.buffer.Buffer arg0)
      Same as end() but writes some data to the stream before ending.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Specified by:
      end in interface WriteStream<io.vertx.core.buffer.Buffer>
      Parameters:
      data - the data to write
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WriteStream.end(T)

    • endAndAwait

      public void endAndAwait(io.vertx.core.buffer.Buffer arg0)
      Same as end() but writes some data to the stream before ending.

      Unlike the bare Vert.x variant, this method returns a Void. This method awaits indefinitely 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).

      Parameters:
      data - the data to write
      See Also:
      • WriteStream.end(T)

    • endAndForget

      public AsyncFile endAndForget(io.vertx.core.buffer.Buffer arg0)
      Same as end() but writes some data to the stream before ending.

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Parameters:
      data - the data to write
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WriteStream.end(T)

    • write

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> write(io.vertx.core.buffer.Buffer arg0)
      Write some data to the stream.

      The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the writeQueueFull() method before writing. This is done automatically if using a Pipe.

      When the data is moved from the queue to the actual medium, the returned Future will be completed with the write result, e.g the uni is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Specified by:
      write in interface WriteStream<io.vertx.core.buffer.Buffer>
      Parameters:
      data - the data to write
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WriteStream.write(T)

    • writeAndAwait

      public void writeAndAwait(io.vertx.core.buffer.Buffer arg0)
      Write some data to the stream.

      The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the writeQueueFull() method before writing. This is done automatically if using a Pipe.

      When the data is moved from the queue to the actual medium, the returned Future will be completed with the write result, e.g the underlying uni is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.

      Unlike the bare Vert.x variant, this method returns a Void. This method awaits indefinitely 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).

      Parameters:
      data - the data to write
      See Also:
      • WriteStream.write(T)

    • writeAndForget

      public AsyncFile writeAndForget(io.vertx.core.buffer.Buffer arg0)
      Write some data to the stream.

      The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the writeQueueFull() method before writing. This is done automatically if using a Pipe.

      When the data is moved from the queue to the actual medium, the returned Future will be completed with the write result, e.g the underlying uni is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Parameters:
      data - the data to write
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WriteStream.write(T)

    • pipeTo

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> pipeTo(WriteStream<io.vertx.core.buffer.Buffer> arg0)
      Pipe this ReadStream to the WriteStream.

      Elements emitted by this stream will be written to the write stream until this stream ends or fails.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Specified by:
      pipeTo in interface ReadStream<io.vertx.core.buffer.Buffer>
      Parameters:
      dst - the destination write stream
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.core.file.AsyncFile#pipeTo(WriteStream)

    • pipeToAndAwait

      public void pipeToAndAwait(WriteStream<io.vertx.core.buffer.Buffer> arg0)
      Pipe this ReadStream to the WriteStream.

      Elements emitted by this stream will be written to the write stream until this stream ends or fails.

      Unlike the bare Vert.x variant, this method returns a Void. This method awaits indefinitely 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).

      Parameters:
      dst - the destination write stream
      See Also:
      • io.vertx.core.file.AsyncFile#pipeTo(WriteStream)

    • pipeToAndForget

      public AsyncFile pipeToAndForget(WriteStream<io.vertx.core.buffer.Buffer> arg0)
      Pipe this ReadStream to the WriteStream.

      Elements emitted by this stream will be written to the write stream until this stream ends or fails.

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Parameters:
      dst - the destination write stream
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • io.vertx.core.file.AsyncFile#pipeTo(WriteStream)

    • handler

      public AsyncFile handler(Consumer<io.vertx.core.buffer.Buffer> handler)
      Description copied from interface: ReadStream
      Set a data handler. As data is read, the handler will be called with the data.
      Specified by:
      handler in interface ReadStream<io.vertx.core.buffer.Buffer>
      Returns:
      a reference to this, so the API can be used fluently

    • pause

      public AsyncFile pause()
      Description copied from interface: ReadStream
      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.

      Specified by:
      pause in interface ReadStream<io.vertx.core.buffer.Buffer>
      Returns:
      a reference to this, so the API can be used fluently

    • resume

      public AsyncFile resume()
      Description copied from interface: ReadStream
      Resume reading, and sets the buffer in flowing mode.

      If the ReadStream has been paused, reading will recommence on it.

      Specified by:
      resume in interface ReadStream<io.vertx.core.buffer.Buffer>
      Returns:
      a reference to this, so the API can be used fluently

    • endHandler

      public AsyncFile endHandler(Runnable endHandler)
      Description copied from interface: ReadStream
      Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.
      Specified by:
      endHandler in interface ReadStream<io.vertx.core.buffer.Buffer>
      Returns:
      a reference to this, so the API can be used fluently

    • setWriteQueueMaxSize

      public AsyncFile setWriteQueueMaxSize(int maxSize)
      Description copied from interface: WriteStream
      Set the maximum size of the write queue to maxSize. You will still be able to write to the stream even if there is more than maxSize items in the write queue. This is used as an indicator by classes such as Pipe to provide flow control.

      The value is defined by the implementation of the stream, e.g in bytes for a NetSocket, etc...

      Specified by:
      setWriteQueueMaxSize in interface WriteStream<io.vertx.core.buffer.Buffer>
      Parameters:
      maxSize - the max size of the write stream
      Returns:
      a reference to this, so the API can be used fluently

    • drainHandler

      public AsyncFile drainHandler(Runnable handler)
      Description copied from interface: WriteStream
      Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue is ready to accept buffers again. See Pipe for an example of this being used.

      The stream implementation defines when the drain handler, for example it could be when the queue size has been reduced to maxSize / 2.

      Specified by:
      drainHandler in interface WriteStream<io.vertx.core.buffer.Buffer>
      Parameters:
      handler - the handler. Can be null.
      Returns:
      a reference to this, so the API can be used fluently

    • exceptionHandler

      public AsyncFile exceptionHandler(Consumer<Throwable> handler)
      Set an exception handler on the read stream and on the write stream.
      Specified by:
      exceptionHandler in interface ReadStream<io.vertx.core.buffer.Buffer>
      Specified by:
      exceptionHandler in interface StreamBase
      Specified by:
      exceptionHandler in interface WriteStream<io.vertx.core.buffer.Buffer>
      Parameters:
      handler - the handler
      Returns:
      a reference to this, so the API can be used fluently

    • fetch

      public AsyncFile fetch(long amount)
      Description copied from interface: ReadStream
      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.
      Specified by:
      fetch in interface ReadStream<io.vertx.core.buffer.Buffer>
      Returns:
      a reference to this, so the API can be used fluently

    • setReadPos

      public AsyncFile setReadPos(long readPos)
      Sets the position from which data will be read from when using the file as a ReadStream.
      Parameters:
      readPos - the position in the file
      Returns:
      a reference to this, so the API can be used fluently

    • setReadLength

      public AsyncFile setReadLength(long readLength)
      Sets the number of bytes that will be read when using the file as a ReadStream.
      Parameters:
      readLength - the bytes that will be read from the file
      Returns:
      a reference to this, so the API can be used fluently

    • getReadLength

      public long getReadLength()
      Returns:
      the number of bytes that will be read when using the file as a ReadStream

    • setWritePos

      public AsyncFile setWritePos(long writePos)
      Sets the position from which data will be written when using the file as a WriteStream.
      Parameters:
      writePos - the position in the file
      Returns:
      a reference to this, so the API can be used fluently

    • getWritePos

      public long getWritePos()
      Returns:
      the current write position the file is at

    • setReadBufferSize

      public AsyncFile setReadBufferSize(int readBufferSize)
      Sets the buffer size that will be used to read the data from the file. Changing this value will impact how much the data will be read at a time from the file system.
      Parameters:
      readBufferSize - the buffer size
      Returns:
      a reference to this, so the API can be used fluently

    • sizeBlocking

      public long sizeBlocking()
      Like size() but blocking.

    • tryLock

      public AsyncFileLock tryLock()
      Try to acquire a non-shared lock on the entire file.
      Returns:
      the lock if it can be acquired immediately, otherwise null

    • tryLock

      public AsyncFileLock tryLock(long position, long size, boolean shared)
      Try to acquire a lock on a portion of this file.
      Parameters:
      position - where the region starts
      size - the size of the region
      shared - whether the lock should be shared
      Returns:
      the lock if it can be acquired immediately, otherwise null

    • pipe

      public Pipe<io.vertx.core.buffer.Buffer> pipe()
      Pause this stream and return a Pipe to transfer the elements of this stream to a destination WriteStream.

      The stream will be resumed when the pipe will be wired to a WriteStream.

      Specified by:
      pipe in interface ReadStream<io.vertx.core.buffer.Buffer>
      Returns:
      a pipe

    • writeQueueFull

      public boolean writeQueueFull()
      This will return true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int)
      Specified by:
      writeQueueFull in interface WriteStream<io.vertx.core.buffer.Buffer>
      Returns:
      true if write queue is full

    • newInstance

      public static AsyncFile newInstance(io.vertx.core.file.AsyncFile delegate)
      Creates a new instance of the AsyncFile.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toMulti

      @CheckReturnValue public io.smallrye.mutiny.Multi<io.vertx.core.buffer.Buffer> toMulti()

    • toBlockingIterable

      public Iterable<io.vertx.core.buffer.Buffer> toBlockingIterable()

    • toBlockingStream

      public Stream<io.vertx.core.buffer.Buffer> toBlockingStream()

    • toSubscriber

      @CheckReturnValue public Flow.Subscriber<io.vertx.core.buffer.Buffer> toSubscriber()
      Converts the current write stream to a subscriber.