Class FileSystem
- All Implemented Interfaces:
MutinyDelegate
A (potential) blocking and non blocking version of each operation is provided.
The non blocking versions take a handler which is called when the operation completes or an error occurs.
The blocking versions are named xxxBlocking and return the results, or throw exceptions directly.
In many cases, depending on the operating system and file system some of the potentially blocking operations
can return quickly, which is why we provide them, but it's highly recommended that you test how long they take to
return in your particular application before using them on an event loop.
Please consult the documentation for more information on file system support.
NOTE: This class has been automatically generated from the original non Mutiny-ified interface.
- Author:
- Tim Fox
- See Also:
-
FileSystem
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionFileSystem(io.vertx.core.file.FileSystem delegate) Create a new instance ofFileSystemdelegating to the given (non-null) instance ofFileSystem.FileSystem(Object delegate) -
Method Summary
Modifier and TypeMethodDescriptionio.smallrye.mutiny.Uni<Void>Change the permissions on the file represented bypathtoperms, asynchronously.voidchmodAndAwait(String path, String perms) Change the permissions on the file represented bypathtoperms, asynchronously.chmodAndForget(String path, String perms) Change the permissions on the file represented bypathtoperms, asynchronously.chmodBlocking(String path, String perms) Blocking version ofchmod(String, String)io.smallrye.mutiny.Uni<Void>chmodRecursive(String path, String perms, String dirPerms) Change the permissions on the file represented bypathtoperms, asynchronously.voidchmodRecursiveAndAwait(String path, String perms, String dirPerms) Change the permissions on the file represented bypathtoperms, asynchronously.chmodRecursiveAndForget(String path, String perms, String dirPerms) Change the permissions on the file represented bypathtoperms, asynchronously.chmodRecursiveBlocking(String path, String perms, String dirPerms) Blocking version ofchmodRecursive(String, String, String)io.smallrye.mutiny.Uni<Void>Change the ownership on the file represented bypathtouserand {code group}, asynchronously.voidchownAndAwait(String path, String user, String group) Change the ownership on the file represented bypathtouserand {code group}, asynchronously.chownAndForget(String path, String user, String group) Change the ownership on the file represented bypathtouserand {code group}, asynchronously.chownBlocking(String path, String user, String group) Blocking version ofchown(String, String, String)io.smallrye.mutiny.Uni<Void>Copy a file from the pathfromto pathto, asynchronously.io.smallrye.mutiny.Uni<Void>Copy a file from the pathfromto pathto, asynchronously.voidcopyAndAwait(String from, String to) Copy a file from the pathfromto pathto, asynchronously.voidcopyAndAwait(String from, String to, io.vertx.core.file.CopyOptions options) Copy a file from the pathfromto pathto, asynchronously.copyAndForget(String from, String to) Copy a file from the pathfromto pathto, asynchronously.copyAndForget(String from, String to, io.vertx.core.file.CopyOptions options) Copy a file from the pathfromto pathto, asynchronously.copyBlocking(String from, String to) Blocking version ofcopy(String, String)io.smallrye.mutiny.Uni<Void>copyRecursive(String from, String to, boolean recursive) Copy a file from the pathfromto pathto, asynchronously.voidcopyRecursiveAndAwait(String from, String to, boolean recursive) Copy a file from the pathfromto pathto, asynchronously.copyRecursiveAndForget(String from, String to, boolean recursive) Copy a file from the pathfromto pathto, asynchronously.copyRecursiveBlocking(String from, String to, boolean recursive) Blocking version ofcopyRecursive(String, String, boolean)io.smallrye.mutiny.Uni<Void>createFile(String path) Creates an empty file with the specifiedpath, asynchronously.io.smallrye.mutiny.Uni<Void>createFile(String path, String perms) Creates an empty file with the specifiedpathand permissionsperms, asynchronously.voidcreateFileAndAwait(String path) Creates an empty file with the specifiedpath, asynchronously.voidcreateFileAndAwait(String path, String perms) Creates an empty file with the specifiedpathand permissionsperms, asynchronously.createFileAndForget(String path) Creates an empty file with the specifiedpath, asynchronously.createFileAndForget(String path, String perms) Creates an empty file with the specifiedpathand permissionsperms, asynchronously.createFileBlocking(String path) Blocking version ofcreateFile(String)createFileBlocking(String path, String perms) Blocking version ofcreateFile(String, String)io.smallrye.mutiny.Uni<String>createTempDirectory(String prefix) Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.io.smallrye.mutiny.Uni<String>createTempDirectory(String prefix, String perms) Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.io.smallrye.mutiny.Uni<String>createTempDirectory(String dir, String prefix, String perms) Creates a new directory in the directory provided by the pathpath, using the given prefix to generate its name, asynchronously.createTempDirectoryAndAwait(String prefix) Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.createTempDirectoryAndAwait(String prefix, String perms) Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.createTempDirectoryAndAwait(String dir, String prefix, String perms) Creates a new directory in the directory provided by the pathpath, using the given prefix to generate its name, asynchronously.createTempDirectoryAndForget(String prefix) Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.createTempDirectoryAndForget(String prefix, String perms) Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.createTempDirectoryAndForget(String dir, String prefix, String perms) Creates a new directory in the directory provided by the pathpath, using the given prefix to generate its name, asynchronously.createTempDirectoryBlocking(String prefix) Blocking version ofcreateTempDirectory(String)createTempDirectoryBlocking(String prefix, String perms) Blocking version ofcreateTempDirectory(String, String)createTempDirectoryBlocking(String dir, String prefix, String perms) Blocking version ofcreateTempDirectory(String, String, String)io.smallrye.mutiny.Uni<String>createTempFile(String prefix, String suffix) Creates a new file in the default temporary-file directory, using the given prefix and suffix to generate its name, asynchronously.io.smallrye.mutiny.Uni<String>createTempFile(String prefix, String suffix, String perms) Creates a new file in the directory provided by the pathdir, using the given prefix and suffix to generate its name, asynchronously.io.smallrye.mutiny.Uni<String>createTempFile(String dir, String prefix, String suffix, String perms) Creates a new file in the directory provided by the pathdir, using the given prefix and suffix to generate its name, asynchronously.createTempFileAndAwait(String prefix, String suffix) Creates a new file in the default temporary-file directory, using the given prefix and suffix to generate its name, asynchronously.createTempFileAndAwait(String prefix, String suffix, String perms) Creates a new file in the directory provided by the pathdir, using the given prefix and suffix to generate its name, asynchronously.createTempFileAndAwait(String dir, String prefix, String suffix, String perms) Creates a new file in the directory provided by the pathdir, using the given prefix and suffix to generate its name, asynchronously.createTempFileAndForget(String prefix, String suffix) Creates a new file in the default temporary-file directory, using the given prefix and suffix to generate its name, asynchronously.createTempFileAndForget(String prefix, String suffix, String perms) Creates a new file in the directory provided by the pathdir, using the given prefix and suffix to generate its name, asynchronously.createTempFileAndForget(String dir, String prefix, String suffix, String perms) Creates a new file in the directory provided by the pathdir, using the given prefix and suffix to generate its name, asynchronously.createTempFileBlocking(String prefix, String suffix) Blocking version ofcreateTempFile(String, String)createTempFileBlocking(String prefix, String suffix, String perms) Blocking version ofcreateTempFile(String, String, String)createTempFileBlocking(String dir, String prefix, String suffix, String perms) Blocking version ofcreateTempFile(String, String, String, String)io.smallrye.mutiny.Uni<Void>Deletes the file represented by the specifiedpath, asynchronously.voiddeleteAndAwait(String path) Deletes the file represented by the specifiedpath, asynchronously.deleteAndForget(String path) Deletes the file represented by the specifiedpath, asynchronously.deleteBlocking(String path) Blocking version ofdelete(String)io.smallrye.mutiny.Uni<Void>deleteRecursive(String path) Deletes the file represented by the specifiedpath, asynchronously.voidDeletes the file represented by the specifiedpath, asynchronously.Deletes the file represented by the specifiedpath, asynchronously.Blocking version ofdeleteRecursive(String)booleanio.smallrye.mutiny.Uni<Boolean>Determines whether the file as specified by the pathpathexists, asynchronously.existsAndAwait(String path) Determines whether the file as specified by the pathpathexists, asynchronously.existsAndForget(String path) Determines whether the file as specified by the pathpathexists, asynchronously.booleanexistsBlocking(String path) Blocking version ofexists(String)io.smallrye.mutiny.Uni<io.vertx.core.file.FileSystemProps>Returns properties of the file-system being used by the specifiedpath, asynchronously.io.vertx.core.file.FileSystemPropsfsPropsAndAwait(String path) Returns properties of the file-system being used by the specifiedpath, asynchronously.fsPropsAndForget(String path) Returns properties of the file-system being used by the specifiedpath, asynchronously.io.vertx.core.file.FileSystemPropsfsPropsBlocking(String path) Blocking version offsProps(String)io.vertx.core.file.FileSystemGet the delegate instance.inthashCode()io.smallrye.mutiny.Uni<Void>Create a hard link on the file system fromlinktoexisting, asynchronously.voidlinkAndAwait(String link, String existing) Create a hard link on the file system fromlinktoexisting, asynchronously.linkAndForget(String link, String existing) Create a hard link on the file system fromlinktoexisting, asynchronously.linkBlocking(String link, String existing) Blocking version oflink(String, String)io.smallrye.mutiny.Uni<io.vertx.core.file.FileProps>Obtain properties for the link represented bypath, asynchronously.io.vertx.core.file.FilePropslpropsAndAwait(String path) Obtain properties for the link represented bypath, asynchronously.lpropsAndForget(String path) Obtain properties for the link represented bypath, asynchronously.io.vertx.core.file.FilePropslpropsBlocking(String path) Blocking version oflprops(String)io.smallrye.mutiny.Uni<Void>Create the directory represented bypath, asynchronously.io.smallrye.mutiny.Uni<Void>Create the directory represented bypath, asynchronously.voidmkdirAndAwait(String path) Create the directory represented bypath, asynchronously.voidmkdirAndAwait(String path, String perms) Create the directory represented bypath, asynchronously.mkdirAndForget(String path) Create the directory represented bypath, asynchronously.mkdirAndForget(String path, String perms) Create the directory represented bypath, asynchronously.mkdirBlocking(String path) Blocking version ofmkdir(String)mkdirBlocking(String path, String perms) Blocking version ofmkdir(String, String)io.smallrye.mutiny.Uni<Void>Create the directory represented bypathand any non existent parents, asynchronously.io.smallrye.mutiny.Uni<Void>Create the directory represented bypathand any non existent parents, asynchronously.voidmkdirsAndAwait(String path) Create the directory represented bypathand any non existent parents, asynchronously.voidmkdirsAndAwait(String path, String perms) Create the directory represented bypathand any non existent parents, asynchronously.mkdirsAndForget(String path) Create the directory represented bypathand any non existent parents, asynchronously.mkdirsAndForget(String path, String perms) Create the directory represented bypathand any non existent parents, asynchronously.mkdirsBlocking(String path) Blocking version ofmkdirs(String)mkdirsBlocking(String path, String perms) Blocking version ofmkdirs(String, String)io.smallrye.mutiny.Uni<Void>Move a file from the pathfromto pathto, asynchronously.io.smallrye.mutiny.Uni<Void>Move a file from the pathfromto pathto, asynchronously.voidmoveAndAwait(String from, String to) Move a file from the pathfromto pathto, asynchronously.voidmoveAndAwait(String from, String to, io.vertx.core.file.CopyOptions options) Move a file from the pathfromto pathto, asynchronously.moveAndForget(String from, String to) Move a file from the pathfromto pathto, asynchronously.moveAndForget(String from, String to, io.vertx.core.file.CopyOptions options) Move a file from the pathfromto pathto, asynchronously.moveBlocking(String from, String to) Blocking version ofmove(String, String)static FileSystemnewInstance(io.vertx.core.file.FileSystem delegate) Creates a new instance of theFileSystem.io.smallrye.mutiny.Uni<AsyncFile>Open the file represented bypath, asynchronously.openAndAwait(String path, io.vertx.core.file.OpenOptions options) Open the file represented bypath, asynchronously.openAndForget(String path, io.vertx.core.file.OpenOptions options) Open the file represented bypath, asynchronously.openBlocking(String path, io.vertx.core.file.OpenOptions options) Blocking version ofopen(String, io.vertx.core.file.OpenOptions)io.smallrye.mutiny.Uni<io.vertx.core.file.FileProps>Obtain properties for the file represented bypath, asynchronously.io.vertx.core.file.FilePropspropsAndAwait(String path) Obtain properties for the file represented bypath, asynchronously.propsAndForget(String path) Obtain properties for the file represented bypath, asynchronously.io.vertx.core.file.FilePropspropsBlocking(String path) Blocking version ofprops(String)Read the contents of the directory specified bypath, asynchronously.Read the contents of the directory specified bypath, asynchronously.readDirAndAwait(String path) Read the contents of the directory specified bypath, asynchronously.readDirAndAwait(String path, String filter) Read the contents of the directory specified bypath, asynchronously.readDirAndForget(String path) Read the contents of the directory specified bypath, asynchronously.readDirAndForget(String path, String filter) Read the contents of the directory specified bypath, asynchronously.readDirBlocking(String path) Blocking version ofreadDir(String)readDirBlocking(String path, String filter) Blocking version ofreadDir(String, String)io.smallrye.mutiny.Uni<io.vertx.core.buffer.Buffer>Reads the entire file as represented by the pathpathas aBuffer, asynchronously.io.vertx.core.buffer.BufferreadFileAndAwait(String path) Reads the entire file as represented by the pathpathas aBuffer, asynchronously.readFileAndForget(String path) Reads the entire file as represented by the pathpathas aBuffer, asynchronously.io.vertx.core.buffer.BufferreadFileBlocking(String path) Blocking version ofreadFile(String)io.smallrye.mutiny.Uni<String>readSymlink(String link) Returns the path representing the file that the symbolic link specified bylinkpoints to, asynchronously.readSymlinkAndAwait(String link) Returns the path representing the file that the symbolic link specified bylinkpoints to, asynchronously.readSymlinkAndForget(String link) Returns the path representing the file that the symbolic link specified bylinkpoints to, asynchronously.readSymlinkBlocking(String link) Blocking version ofreadSymlink(String)io.smallrye.mutiny.Uni<Void>Create a symbolic link on the file system fromlinktoexisting, asynchronously.voidsymlinkAndAwait(String link, String existing) Create a symbolic link on the file system fromlinktoexisting, asynchronously.symlinkAndForget(String link, String existing) Create a symbolic link on the file system fromlinktoexisting, asynchronously.symlinkBlocking(String link, String existing) Blocking version oflink(String, String)toString()io.smallrye.mutiny.Uni<Void>Truncate the file represented bypathto lengthlenin bytes, asynchronously.voidtruncateAndAwait(String path, long len) Truncate the file represented bypathto lengthlenin bytes, asynchronously.truncateAndForget(String path, long len) Truncate the file represented bypathto lengthlenin bytes, asynchronously.truncateBlocking(String path, long len) Blocking version oftruncate(String, long)io.smallrye.mutiny.Uni<Void>Unlinks the link on the file system represented by the pathlink, asynchronously.voidunlinkAndAwait(String link) Unlinks the link on the file system represented by the pathlink, asynchronously.unlinkAndForget(String link) Unlinks the link on the file system represented by the pathlink, asynchronously.unlinkBlocking(String link) Blocking version ofunlink(String)io.smallrye.mutiny.Uni<Void>Creates the file, and writes the specifiedBuffer datato the file represented by the pathpath, asynchronously.voidwriteFileAndAwait(String path, io.vertx.core.buffer.Buffer data) Creates the file, and writes the specifiedBuffer datato the file represented by the pathpath, asynchronously.writeFileAndForget(String path, io.vertx.core.buffer.Buffer data) Creates the file, and writes the specifiedBuffer datato the file represented by the pathpath, asynchronously.writeFileBlocking(String path, io.vertx.core.buffer.Buffer data) Blocking version ofwriteFile(String, Buffer)
-
Field Details
-
__TYPE_ARG
-
-
Constructor Details
-
FileSystem
public FileSystem(io.vertx.core.file.FileSystem delegate) Create a new instance ofFileSystemdelegating to the given (non-null) instance ofFileSystem. -
FileSystem
-
-
Method Details
-
getDelegate
public io.vertx.core.file.FileSystem 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:
getDelegatein interfaceMutinyDelegate- Returns:
- the delegate instance
-
copy
Copy a file from the pathfromto pathto, asynchronously.The copy will fail if the destination already exists.
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:
from- the path to copy fromto- the path to copy to- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.copy(String, String)
-
copyAndAwait
Copy a file from the pathfromto pathto, asynchronously.The copy will fail if the destination already exists.
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 aRuntimeException).- Parameters:
from- the path to copy fromto- the path to copy to- See Also:
-
FileSystem.copy(String, String)
-
copyAndForget
Copy a file from the pathfromto pathto, asynchronously.The copy will fail if the destination already exists.
Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
from- the path to copy fromto- the path to copy to- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.copy(String, String)
-
copy
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> copy(String from, String to, io.vertx.core.file.CopyOptions options) Copy a file from the pathfromto pathto, 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.
- Parameters:
from- the path to copy fromto- the path to copy tooptions- options describing how the file should be copied- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.copy(String, String, CopyOptions)
-
copyAndAwait
Copy a file from the pathfromto pathto, 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 aRuntimeException).- Parameters:
from- the path to copy fromto- the path to copy tooptions- options describing how the file should be copied- See Also:
-
FileSystem.copy(String, String, CopyOptions)
-
copyAndForget
Copy a file from the pathfromto pathto, asynchronously.Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
from- the path to copy fromto- the path to copy tooptions- options describing how the file should be copied- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.copy(String, String, CopyOptions)
-
copyRecursive
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> copyRecursive(String from, String to, boolean recursive) Copy a file from the pathfromto pathto, asynchronously.If
recursiveistrueandfromrepresents a directory, then the directory and its contents will be copied recursively to the destinationto.The copy will fail if the destination if the destination already exists.
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:
from- the path to copy fromto- the path to copy torecursive-- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.copyRecursive(String, String, boolean)
-
copyRecursiveAndAwait
Copy a file from the pathfromto pathto, asynchronously.If
recursiveistrueandfromrepresents a directory, then the directory and its contents will be copied recursively to the destinationto.The copy will fail if the destination if the destination already exists.
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 aRuntimeException).- Parameters:
from- the path to copy fromto- the path to copy torecursive-- See Also:
-
FileSystem.copyRecursive(String, String, boolean)
-
copyRecursiveAndForget
Copy a file from the pathfromto pathto, asynchronously.If
recursiveistrueandfromrepresents a directory, then the directory and its contents will be copied recursively to the destinationto.The copy will fail if the destination if the destination already exists.
Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
from- the path to copy fromto- the path to copy torecursive-- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.copyRecursive(String, String, boolean)
-
move
Move a file from the pathfromto pathto, asynchronously.The move will fail if the destination already exists.
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:
from- the path to copy fromto- the path to copy to- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.move(String, String)
-
moveAndAwait
Move a file from the pathfromto pathto, asynchronously.The move will fail if the destination already exists.
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 aRuntimeException).- Parameters:
from- the path to copy fromto- the path to copy to- See Also:
-
FileSystem.move(String, String)
-
moveAndForget
Move a file from the pathfromto pathto, asynchronously.The move will fail if the destination already exists.
Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
from- the path to copy fromto- the path to copy to- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.move(String, String)
-
move
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> move(String from, String to, io.vertx.core.file.CopyOptions options) Move a file from the pathfromto pathto, 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.
- Parameters:
from- the path to copy fromto- the path to copy tooptions- options describing how the file should be copied- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.move(String, String, CopyOptions)
-
moveAndAwait
Move a file from the pathfromto pathto, 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 aRuntimeException).- Parameters:
from- the path to copy fromto- the path to copy tooptions- options describing how the file should be copied- See Also:
-
FileSystem.move(String, String, CopyOptions)
-
moveAndForget
Move a file from the pathfromto pathto, asynchronously.Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
from- the path to copy fromto- the path to copy tooptions- options describing how the file should be copied- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.move(String, String, CopyOptions)
-
truncate
Truncate the file represented bypathto lengthlenin bytes, asynchronously.The operation will fail if the file does not exist or
lenis less thanzero.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:
path- the path to the filelen- the length to truncate it to- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.truncate(String, long)
-
truncateAndAwait
Truncate the file represented bypathto lengthlenin bytes, asynchronously.The operation will fail if the file does not exist or
lenis less thanzero.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 aRuntimeException).- Parameters:
path- the path to the filelen- the length to truncate it to- See Also:
-
FileSystem.truncate(String, long)
-
truncateAndForget
Truncate the file represented bypathto lengthlenin bytes, asynchronously.The operation will fail if the file does not exist or
lenis less thanzero.Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
path- the path to the filelen- the length to truncate it to- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.truncate(String, long)
-
chmod
Change the permissions on the file represented bypathtoperms, asynchronously.The permission String takes the form rwxr-x--- as specified here.
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:
path- the path to the fileperms- the permissions string- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.chmod(String, String)
-
chmodAndAwait
Change the permissions on the file represented bypathtoperms, asynchronously.The permission String takes the form rwxr-x--- as specified here.
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 aRuntimeException).- Parameters:
path- the path to the fileperms- the permissions string- See Also:
-
FileSystem.chmod(String, String)
-
chmodAndForget
Change the permissions on the file represented bypathtoperms, asynchronously.The permission String takes the form rwxr-x--- as specified here.
Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
path- the path to the fileperms- the permissions string- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.chmod(String, String)
-
chmodRecursive
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> chmodRecursive(String path, String perms, String dirPerms) Change the permissions on the file represented bypathtoperms, asynchronously.The permission String takes the form rwxr-x--- as specified in {here}.
If the file is directory then all contents will also have their permissions changed recursively. Any directory permissions will be set to
dirPerms, whilst any normal file permissions will be set toperms.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:
path- the path to the fileperms- the permissions stringdirPerms- the directory permissions- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.chmodRecursive(String, String, String)
-
chmodRecursiveAndAwait
Change the permissions on the file represented bypathtoperms, asynchronously.The permission String takes the form rwxr-x--- as specified in {here}.
If the file is directory then all contents will also have their permissions changed recursively. Any directory permissions will be set to
dirPerms, whilst any normal file permissions will be set toperms.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 aRuntimeException).- Parameters:
path- the path to the fileperms- the permissions stringdirPerms- the directory permissions- See Also:
-
FileSystem.chmodRecursive(String, String, String)
-
chmodRecursiveAndForget
Change the permissions on the file represented bypathtoperms, asynchronously.The permission String takes the form rwxr-x--- as specified in {here}.
If the file is directory then all contents will also have their permissions changed recursively. Any directory permissions will be set to
dirPerms, whilst any normal file permissions will be set toperms.Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
path- the path to the fileperms- the permissions stringdirPerms- the directory permissions- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.chmodRecursive(String, String, String)
-
chown
Change the ownership on the file represented bypathtouserand {code group}, 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.
- Parameters:
path- the path to the fileuser- the user name,nullwill not change the user namegroup- the user group,nullwill not change the user group name- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.chown(String, String, String)
-
chownAndAwait
Change the ownership on the file represented bypathtouserand {code group}, 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 aRuntimeException).- Parameters:
path- the path to the fileuser- the user name,nullwill not change the user namegroup- the user group,nullwill not change the user group name- See Also:
-
FileSystem.chown(String, String, String)
-
chownAndForget
Change the ownership on the file represented bypathtouserand {code group}, asynchronously.Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
path- the path to the fileuser- the user name,nullwill not change the user namegroup- the user group,nullwill not change the user group name- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.chown(String, String, String)
-
props
Obtain properties for the file represented bypath, asynchronously.If the file is a link, the link will be followed.
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:
path- the path to the file- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.props(String)
-
propsAndAwait
Obtain properties for the file represented bypath, asynchronously.If the file is a link, the link will be followed.
Unlike the bare Vert.x variant, this method returns a
FileProps. 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 aRuntimeException).- Parameters:
path- the path to the file- Returns:
- The operation result
- See Also:
-
FileSystem.props(String)
-
propsAndForget
Obtain properties for the file represented bypath, asynchronously.If the file is a link, the link will be followed.
Unlike the bare Vert.x variant, this method ignores the
FilePropsresult or any failure.- Parameters:
path- the path to the file- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.props(String)
-
lprops
Obtain properties for the link represented bypath, asynchronously.The link will not be followed.
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:
path- the path to the file- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.lprops(String)
-
lpropsAndAwait
Obtain properties for the link represented bypath, asynchronously.The link will not be followed.
Unlike the bare Vert.x variant, this method returns a
FileProps. 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 aRuntimeException).- Parameters:
path- the path to the file- Returns:
- The operation result
- See Also:
-
FileSystem.lprops(String)
-
lpropsAndForget
Obtain properties for the link represented bypath, asynchronously.The link will not be followed.
Unlike the bare Vert.x variant, this method ignores the
FilePropsresult or any failure.- Parameters:
path- the path to the file- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.lprops(String)
-
link
Create a hard link on the file system fromlinktoexisting, 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.
- Parameters:
link- the linkexisting- the link destination- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.link(String, String)
-
linkAndAwait
Create a hard link on the file system fromlinktoexisting, 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 aRuntimeException).- Parameters:
link- the linkexisting- the link destination- See Also:
-
FileSystem.link(String, String)
-
linkAndForget
Create a hard link on the file system fromlinktoexisting, asynchronously.Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
link- the linkexisting- the link destination- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.link(String, String)
-
symlink
Create a symbolic link on the file system fromlinktoexisting, 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.
- Parameters:
link- the linkexisting- the link destination- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.symlink(String, String)
-
symlinkAndAwait
Create a symbolic link on the file system fromlinktoexisting, 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 aRuntimeException).- Parameters:
link- the linkexisting- the link destination- See Also:
-
FileSystem.symlink(String, String)
-
symlinkAndForget
Create a symbolic link on the file system fromlinktoexisting, asynchronously.Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
link- the linkexisting- the link destination- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.symlink(String, String)
-
unlink
Unlinks the link on the file system represented by the pathlink, 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.
- Parameters:
link- the link- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.unlink(String)
-
unlinkAndAwait
Unlinks the link on the file system represented by the pathlink, 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 aRuntimeException).- Parameters:
link- the link- See Also:
-
FileSystem.unlink(String)
-
unlinkAndForget
Unlinks the link on the file system represented by the pathlink, asynchronously.Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
link- the link- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.unlink(String)
-
readSymlink
Returns the path representing the file that the symbolic link specified bylinkpoints to, 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.
- Parameters:
link- the link- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.readSymlink(String)
-
readSymlinkAndAwait
Returns the path representing the file that the symbolic link specified bylinkpoints to, asynchronously.Unlike the bare Vert.x variant, this method returns a
String. 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 aRuntimeException).- Parameters:
link- the link- Returns:
- The operation result
- See Also:
-
FileSystem.readSymlink(String)
-
readSymlinkAndForget
Returns the path representing the file that the symbolic link specified bylinkpoints to, asynchronously.Unlike the bare Vert.x variant, this method ignores the
Stringresult or any failure.- Parameters:
link- the link- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.readSymlink(String)
-
delete
Deletes the file represented by the specifiedpath, 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.
- Parameters:
path- path to the file- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.delete(String)
-
deleteAndAwait
Deletes the file represented by the specifiedpath, 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 aRuntimeException).- Parameters:
path- path to the file- See Also:
-
FileSystem.delete(String)
-
deleteAndForget
Deletes the file represented by the specifiedpath, asynchronously.Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
path- path to the file- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.delete(String)
-
deleteRecursive
Deletes the file represented by the specifiedpath, asynchronously.If the path represents a directory and
recursive = truethen the directory and its contents will be deleted recursively.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:
path- path to the file- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.deleteRecursive(String)
-
deleteRecursiveAndAwait
Deletes the file represented by the specifiedpath, asynchronously.If the path represents a directory and
recursive = truethen the directory and its contents will be deleted recursively.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 aRuntimeException).- Parameters:
path- path to the file- See Also:
-
FileSystem.deleteRecursive(String)
-
deleteRecursiveAndForget
Deletes the file represented by the specifiedpath, asynchronously.If the path represents a directory and
recursive = truethen the directory and its contents will be deleted recursively.Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
path- path to the file- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.deleteRecursive(String)
-
mkdir
Create the directory represented bypath, asynchronously.The operation will fail if the directory already exists.
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:
path- path to the file- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.mkdir(String)
-
mkdirAndAwait
Create the directory represented bypath, asynchronously.The operation will fail if the directory already exists.
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 aRuntimeException).- Parameters:
path- path to the file- See Also:
-
FileSystem.mkdir(String)
-
mkdirAndForget
Create the directory represented bypath, asynchronously.The operation will fail if the directory already exists.
Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
path- path to the file- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.mkdir(String)
-
mkdir
Create the directory represented bypath, asynchronously.The new directory will be created with permissions as specified by
perms.The permission String takes the form rwxr-x--- as specified in here.
The operation will fail if the directory already exists.
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:
path- path to the fileperms- the permissions string- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.mkdir(String, String)
-
mkdirAndAwait
Create the directory represented bypath, asynchronously.The new directory will be created with permissions as specified by
perms.The permission String takes the form rwxr-x--- as specified in here.
The operation will fail if the directory already exists.
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 aRuntimeException).- Parameters:
path- path to the fileperms- the permissions string- See Also:
-
FileSystem.mkdir(String, String)
-
mkdirAndForget
Create the directory represented bypath, asynchronously.The new directory will be created with permissions as specified by
perms.The permission String takes the form rwxr-x--- as specified in here.
The operation will fail if the directory already exists.
Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
path- path to the fileperms- the permissions string- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.mkdir(String, String)
-
mkdirs
Create the directory represented bypathand any non existent parents, asynchronously.The operation will fail if the
pathalready exists but is not a directory.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:
path- path to the file- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.mkdirs(String)
-
mkdirsAndAwait
Create the directory represented bypathand any non existent parents, asynchronously.The operation will fail if the
pathalready exists but is not a directory.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 aRuntimeException).- Parameters:
path- path to the file- See Also:
-
FileSystem.mkdirs(String)
-
mkdirsAndForget
Create the directory represented bypathand any non existent parents, asynchronously.The operation will fail if the
pathalready exists but is not a directory.Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
path- path to the file- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.mkdirs(String)
-
mkdirs
Create the directory represented bypathand any non existent parents, asynchronously.The new directory will be created with permissions as specified by
perms.The permission String takes the form rwxr-x--- as specified in here.
The operation will fail if the
pathalready exists but is not a directory.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:
path- path to the fileperms- the permissions string- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.mkdirs(String, String)
-
mkdirsAndAwait
Create the directory represented bypathand any non existent parents, asynchronously.The new directory will be created with permissions as specified by
perms.The permission String takes the form rwxr-x--- as specified in here.
The operation will fail if the
pathalready exists but is not a directory.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 aRuntimeException).- Parameters:
path- path to the fileperms- the permissions string- See Also:
-
FileSystem.mkdirs(String, String)
-
mkdirsAndForget
Create the directory represented bypathand any non existent parents, asynchronously.The new directory will be created with permissions as specified by
perms.The permission String takes the form rwxr-x--- as specified in here.
The operation will fail if the
pathalready exists but is not a directory.Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
path- path to the fileperms- the permissions string- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.mkdirs(String, String)
-
readDir
Read the contents of the directory specified bypath, asynchronously.The result is an array of String representing the paths of the files inside the directory.
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:
path- path to the file- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.readDir(String)
-
readDirAndAwait
Read the contents of the directory specified bypath, asynchronously.The result is an array of String representing the paths of the files inside the directory.
Unlike the bare Vert.x variant, this method returns a
List<String>. 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 aRuntimeException).- Parameters:
path- path to the file- Returns:
- The operation result
- See Also:
-
FileSystem.readDir(String)
-
readDirAndForget
Read the contents of the directory specified bypath, asynchronously.The result is an array of String representing the paths of the files inside the directory.
Unlike the bare Vert.x variant, this method ignores the
List<String>result or any failure.- Parameters:
path- path to the file- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.readDir(String)
-
readDir
Read the contents of the directory specified bypath, asynchronously.The parameter
filteris a regular expression. Iffilteris specified then only the paths that match @{filter}will be returned.The result is an array of String representing the paths of the files inside the directory.
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:
path- path to the directoryfilter- the filter expression- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.readDir(String, String)
-
readDirAndAwait
Read the contents of the directory specified bypath, asynchronously.The parameter
filteris a regular expression. Iffilteris specified then only the paths that match @{filter}will be returned.The result is an array of String representing the paths of the files inside the directory.
Unlike the bare Vert.x variant, this method returns a
List<String>. 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 aRuntimeException).- Parameters:
path- path to the directoryfilter- the filter expression- Returns:
- The operation result
- See Also:
-
FileSystem.readDir(String, String)
-
readDirAndForget
Read the contents of the directory specified bypath, asynchronously.The parameter
filteris a regular expression. Iffilteris specified then only the paths that match @{filter}will be returned.The result is an array of String representing the paths of the files inside the directory.
Unlike the bare Vert.x variant, this method ignores the
List<String>result or any failure.- Parameters:
path- path to the directoryfilter- the filter expression- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.readDir(String, String)
-
readFile
Reads the entire file as represented by the pathpathas aBuffer, asynchronously.Do not use this method to read very large files or you risk running out of available RAM.
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:
path- path to the file- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.readFile(String)
-
readFileAndAwait
Reads the entire file as represented by the pathpathas aBuffer, asynchronously.Do not use this method to read very large files or you risk running out of available RAM.
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 aRuntimeException).- Parameters:
path- path to the file- Returns:
- The operation result
- See Also:
-
FileSystem.readFile(String)
-
readFileAndForget
Reads the entire file as represented by the pathpathas aBuffer, asynchronously.Do not use this method to read very large files or you risk running out of available RAM.
Unlike the bare Vert.x variant, this method ignores the
Bufferresult or any failure.- Parameters:
path- path to the file- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.readFile(String)
-
writeFile
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> writeFile(String path, io.vertx.core.buffer.Buffer data) Creates the file, and writes the specifiedBuffer datato the file represented by the pathpath, 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.
- Parameters:
path- path to the file- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.writeFile(String, Buffer)
-
writeFileAndAwait
Creates the file, and writes the specifiedBuffer datato the file represented by the pathpath, 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 aRuntimeException).- Parameters:
path- path to the file- See Also:
-
FileSystem.writeFile(String, Buffer)
-
writeFileAndForget
Creates the file, and writes the specifiedBuffer datato the file represented by the pathpath, asynchronously.Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
path- path to the file- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.writeFile(String, Buffer)
-
open
@CheckReturnValue public io.smallrye.mutiny.Uni<AsyncFile> open(String path, io.vertx.core.file.OpenOptions options) Open the file represented bypath, asynchronously.The file is opened for both reading and writing. If the file does not already exist it will be created.
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:
path- path to the fileoptions- options describing how the file should be opened- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.open(String, OpenOptions)
-
openAndAwait
Open the file represented bypath, asynchronously.The file is opened for both reading and writing. If the file does not already exist it will be created.
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 aRuntimeException).- Parameters:
path- path to the fileoptions- options describing how the file should be opened- Returns:
- The operation result
- See Also:
-
FileSystem.open(String, OpenOptions)
-
openAndForget
Open the file represented bypath, asynchronously.The file is opened for both reading and writing. If the file does not already exist it will be created.
Unlike the bare Vert.x variant, this method ignores the
AsyncFileresult or any failure.- Parameters:
path- path to the fileoptions- options describing how the file should be opened- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.open(String, OpenOptions)
-
createFile
Creates an empty file with the specifiedpath, 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.
- Parameters:
path- path to the file- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.createFile(String)
-
createFileAndAwait
Creates an empty file with the specifiedpath, 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 aRuntimeException).- Parameters:
path- path to the file- See Also:
-
FileSystem.createFile(String)
-
createFileAndForget
Creates an empty file with the specifiedpath, asynchronously.Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
path- path to the file- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.createFile(String)
-
createFile
Creates an empty file with the specifiedpathand permissionsperms, 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.
- Parameters:
path- path to the fileperms- the permissions string- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.createFile(String, String)
-
createFileAndAwait
Creates an empty file with the specifiedpathand permissionsperms, 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 aRuntimeException).- Parameters:
path- path to the fileperms- the permissions string- See Also:
-
FileSystem.createFile(String, String)
-
createFileAndForget
Creates an empty file with the specifiedpathand permissionsperms, asynchronously.Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Parameters:
path- path to the fileperms- the permissions string- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.createFile(String, String)
-
exists
Determines whether the file as specified by the pathpathexists, 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.
- Parameters:
path- path to the file- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.exists(String)
-
existsAndAwait
Determines whether the file as specified by the pathpathexists, asynchronously.Unlike the bare Vert.x variant, this method returns a
Boolean. 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 aRuntimeException).- Parameters:
path- path to the file- Returns:
- The operation result
- See Also:
-
FileSystem.exists(String)
-
existsAndForget
Determines whether the file as specified by the pathpathexists, asynchronously.Unlike the bare Vert.x variant, this method ignores the
Booleanresult or any failure.- Parameters:
path- path to the file- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.exists(String)
-
fsProps
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.core.file.FileSystemProps> fsProps(String path) Returns properties of the file-system being used by the specifiedpath, 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.
- Parameters:
path- path to anywhere on the filesystem- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.fsProps(String)
-
fsPropsAndAwait
Returns properties of the file-system being used by the specifiedpath, asynchronously.Unlike the bare Vert.x variant, this method returns a
FileSystemProps. 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 aRuntimeException).- Parameters:
path- path to anywhere on the filesystem- Returns:
- The operation result
- See Also:
-
FileSystem.fsProps(String)
-
fsPropsAndForget
Returns properties of the file-system being used by the specifiedpath, asynchronously.Unlike the bare Vert.x variant, this method ignores the
FileSystemPropsresult or any failure.- Parameters:
path- path to anywhere on the filesystem- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.fsProps(String)
-
createTempDirectory
Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.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:
prefix- the prefix string to be used in generating the directory's name; may benull- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.createTempDirectory(String)
-
createTempDirectoryAndAwait
Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method returns a
String. 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 aRuntimeException).- Parameters:
prefix- the prefix string to be used in generating the directory's name; may benull- Returns:
- The operation result
- See Also:
-
FileSystem.createTempDirectory(String)
-
createTempDirectoryAndForget
Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method ignores the
Stringresult or any failure.- Parameters:
prefix- the prefix string to be used in generating the directory's name; may benull- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.createTempDirectory(String)
-
createTempDirectory
@CheckReturnValue public io.smallrye.mutiny.Uni<String> createTempDirectory(String prefix, String perms) Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.The new directory will be created with permissions as specified by
The permission String takes the form rwxr-x--- as specified in here.perms.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.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:
prefix- the prefix string to be used in generating the directory's name; may benullperms- the permissions string- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.createTempDirectory(String, String)
-
createTempDirectoryAndAwait
Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.The new directory will be created with permissions as specified by
The permission String takes the form rwxr-x--- as specified in here.perms.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method returns a
String. 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 aRuntimeException).- Parameters:
prefix- the prefix string to be used in generating the directory's name; may benullperms- the permissions string- Returns:
- The operation result
- See Also:
-
FileSystem.createTempDirectory(String, String)
-
createTempDirectoryAndForget
Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.The new directory will be created with permissions as specified by
The permission String takes the form rwxr-x--- as specified in here.perms.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method ignores the
Stringresult or any failure.- Parameters:
prefix- the prefix string to be used in generating the directory's name; may benullperms- the permissions string- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.createTempDirectory(String, String)
-
createTempDirectory
@CheckReturnValue public io.smallrye.mutiny.Uni<String> createTempDirectory(String dir, String prefix, String perms) Creates a new directory in the directory provided by the pathpath, using the given prefix to generate its name, asynchronously.The new directory will be created with permissions as specified by
The permission String takes the form rwxr-x--- as specified in here.perms.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.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:
dir- the path to directory in which to create the directoryprefix- the prefix string to be used in generating the directory's name; may benullperms- the permissions string- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.createTempDirectory(String, String, String)
-
createTempDirectoryAndAwait
Creates a new directory in the directory provided by the pathpath, using the given prefix to generate its name, asynchronously.The new directory will be created with permissions as specified by
The permission String takes the form rwxr-x--- as specified in here.perms.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method returns a
String. 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 aRuntimeException).- Parameters:
dir- the path to directory in which to create the directoryprefix- the prefix string to be used in generating the directory's name; may benullperms- the permissions string- Returns:
- The operation result
- See Also:
-
FileSystem.createTempDirectory(String, String, String)
-
createTempDirectoryAndForget
Creates a new directory in the directory provided by the pathpath, using the given prefix to generate its name, asynchronously.The new directory will be created with permissions as specified by
The permission String takes the form rwxr-x--- as specified in here.perms.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method ignores the
Stringresult or any failure.- Parameters:
dir- the path to directory in which to create the directoryprefix- the prefix string to be used in generating the directory's name; may benullperms- the permissions string- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.createTempDirectory(String, String, String)
-
createTempFile
@CheckReturnValue public io.smallrye.mutiny.Uni<String> createTempFile(String prefix, String suffix) Creates a new file in the default temporary-file directory, using the given prefix and suffix to generate its name, asynchronously.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.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:
prefix- the prefix string to be used in generating the directory's name; may benullsuffix- the suffix string to be used in generating the file's name; may benull, in which case ".tmp" is used- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.createTempFile(String, String)
-
createTempFileAndAwait
Creates a new file in the default temporary-file directory, using the given prefix and suffix to generate its name, asynchronously.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method returns a
String. 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 aRuntimeException).- Parameters:
prefix- the prefix string to be used in generating the directory's name; may benullsuffix- the suffix string to be used in generating the file's name; may benull, in which case ".tmp" is used- Returns:
- The operation result
- See Also:
-
FileSystem.createTempFile(String, String)
-
createTempFileAndForget
Creates a new file in the default temporary-file directory, using the given prefix and suffix to generate its name, asynchronously.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method ignores the
Stringresult or any failure.- Parameters:
prefix- the prefix string to be used in generating the directory's name; may benullsuffix- the suffix string to be used in generating the file's name; may benull, in which case ".tmp" is used- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.createTempFile(String, String)
-
createTempFile
@CheckReturnValue public io.smallrye.mutiny.Uni<String> createTempFile(String prefix, String suffix, String perms) Creates a new file in the directory provided by the pathdir, using the given prefix and suffix to generate its name, asynchronously.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.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:
prefix- the prefix string to be used in generating the directory's name; may benullsuffix- the suffix string to be used in generating the file's name; may benull, in which case ".tmp" is used- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.createTempFile(String, String, String)
-
createTempFileAndAwait
Creates a new file in the directory provided by the pathdir, using the given prefix and suffix to generate its name, asynchronously.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method returns a
String. 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 aRuntimeException).- Parameters:
prefix- the prefix string to be used in generating the directory's name; may benullsuffix- the suffix string to be used in generating the file's name; may benull, in which case ".tmp" is used- Returns:
- The operation result
- See Also:
-
FileSystem.createTempFile(String, String, String)
-
createTempFileAndForget
Creates a new file in the directory provided by the pathdir, using the given prefix and suffix to generate its name, asynchronously.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method ignores the
Stringresult or any failure.- Parameters:
prefix- the prefix string to be used in generating the directory's name; may benullsuffix- the suffix string to be used in generating the file's name; may benull, in which case ".tmp" is used- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.createTempFile(String, String, String)
-
createTempFile
@CheckReturnValue public io.smallrye.mutiny.Uni<String> createTempFile(String dir, String prefix, String suffix, String perms) Creates a new file in the directory provided by the pathdir, using the given prefix and suffix to generate its name, asynchronously.The new directory will be created with permissions as specified by
The permission String takes the form rwxr-x--- as specified in here.perms.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.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:
dir- the path to directory in which to create the directoryprefix- the prefix string to be used in generating the directory's name; may benullsuffix- the suffix string to be used in generating the file's name; may benull, in which case ".tmp" is usedperms- the permissions string- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
FileSystem.createTempFile(String, String, String, String)
-
createTempFileAndAwait
Creates a new file in the directory provided by the pathdir, using the given prefix and suffix to generate its name, asynchronously.The new directory will be created with permissions as specified by
The permission String takes the form rwxr-x--- as specified in here.perms.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method returns a
String. 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 aRuntimeException).- Parameters:
dir- the path to directory in which to create the directoryprefix- the prefix string to be used in generating the directory's name; may benullsuffix- the suffix string to be used in generating the file's name; may benull, in which case ".tmp" is usedperms- the permissions string- Returns:
- The operation result
- See Also:
-
FileSystem.createTempFile(String, String, String, String)
-
createTempFileAndForget
Creates a new file in the directory provided by the pathdir, using the given prefix and suffix to generate its name, asynchronously.The new directory will be created with permissions as specified by
The permission String takes the form rwxr-x--- as specified in here.perms.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.Ashutdown-hook, or theFile.deleteOnExit()mechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method ignores the
Stringresult or any failure.- Parameters:
dir- the path to directory in which to create the directoryprefix- the prefix string to be used in generating the directory's name; may benullsuffix- the suffix string to be used in generating the file's name; may benull, in which case ".tmp" is usedperms- the permissions string- Returns:
- The current instance to chain operations if needed.
- See Also:
-
FileSystem.createTempFile(String, String, String, String)
-
copyBlocking
Blocking version ofcopy(String, String) -
copyRecursiveBlocking
Blocking version ofcopyRecursive(String, String, boolean) -
moveBlocking
Blocking version ofmove(String, String) -
truncateBlocking
Blocking version oftruncate(String, long) -
chmodBlocking
Blocking version ofchmod(String, String) -
chmodRecursiveBlocking
Blocking version ofchmodRecursive(String, String, String) -
chownBlocking
Blocking version ofchown(String, String, String) -
propsBlocking
Blocking version ofprops(String) -
lpropsBlocking
Blocking version oflprops(String) -
linkBlocking
Blocking version oflink(String, String) -
symlinkBlocking
Blocking version oflink(String, String) -
unlinkBlocking
Blocking version ofunlink(String) -
readSymlinkBlocking
Blocking version ofreadSymlink(String) -
deleteBlocking
Blocking version ofdelete(String) -
deleteRecursiveBlocking
Blocking version ofdeleteRecursive(String) -
mkdirBlocking
Blocking version ofmkdir(String) -
mkdirBlocking
Blocking version ofmkdir(String, String) -
mkdirsBlocking
Blocking version ofmkdirs(String) -
mkdirsBlocking
Blocking version ofmkdirs(String, String) -
readDirBlocking
Blocking version ofreadDir(String) -
readDirBlocking
Blocking version ofreadDir(String, String) -
readFileBlocking
Blocking version ofreadFile(String) -
writeFileBlocking
Blocking version ofwriteFile(String, Buffer) -
openBlocking
Blocking version ofopen(String, io.vertx.core.file.OpenOptions) -
createFileBlocking
Blocking version ofcreateFile(String) -
createFileBlocking
Blocking version ofcreateFile(String, String) -
existsBlocking
Blocking version ofexists(String) -
fsPropsBlocking
Blocking version offsProps(String) -
createTempDirectoryBlocking
Blocking version ofcreateTempDirectory(String) -
createTempDirectoryBlocking
Blocking version ofcreateTempDirectory(String, String) -
createTempDirectoryBlocking
Blocking version ofcreateTempDirectory(String, String, String) -
createTempFileBlocking
Blocking version ofcreateTempFile(String, String) -
createTempFileBlocking
Blocking version ofcreateTempFile(String, String, String) -
createTempFileBlocking
Blocking version ofcreateTempFile(String, String, String, String) -
newInstance
Creates a new instance of theFileSystem. -
hashCode
public int hashCode() -
equals
-
toString
-