Class FileSystem
- java.lang.Object
-
- io.vertx.mutiny.core.file.FileSystem
-
public class FileSystem extends Object
Contains a broad set of operations for manipulating files on the file system.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
xxxBlockingand 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 theoriginalnon Mutiny-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<FileSystem>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description FileSystem(io.vertx.core.file.FileSystem delegate)FileSystem(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description io.smallrye.mutiny.Uni<Void>chmod(String path, String perms)Change the permissions on the file represented bypathtoperms, asynchronously.VoidchmodAndAwait(String path, String perms)Blocking variant ofchmod(String,String).FileSystemchmodAndForget(String path, String perms)Variant ofchmod(String,String)that ignores the result of the operation.FileSystemchmodBlocking(String path, String perms)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)Blocking variant ofchmodRecursive(String,String,String).FileSystemchmodRecursiveAndForget(String path, String perms, String dirPerms)Variant ofchmodRecursive(String,String,String)that ignores the result of the operation.FileSystemchmodRecursiveBlocking(String path, String perms, String dirPerms)io.smallrye.mutiny.Uni<Void>chown(String path, String user, String group)Change the ownership on the file represented bypathtouserand {code group}, asynchronously.VoidchownAndAwait(String path, String user, String group)Blocking variant ofchown(String,String,String).FileSystemchownAndForget(String path, String user, String group)Variant ofchown(String,String,String)that ignores the result of the operation.FileSystemchownBlocking(String path, String user, String group)io.smallrye.mutiny.Uni<Void>copy(String from, String to)Copy a file from the pathfromto pathto, asynchronously.io.smallrye.mutiny.Uni<Void>copy(String from, String to, io.vertx.core.file.CopyOptions options)Copy a file from the pathfromto pathto, asynchronously.VoidcopyAndAwait(String from, String to)Blocking variant ofcopy(String,String).VoidcopyAndAwait(String from, String to, io.vertx.core.file.CopyOptions options)Blocking variant ofcopy(String,String,CopyOptions).FileSystemcopyAndForget(String from, String to)Variant ofcopy(String,String)that ignores the result of the operation.FileSystemcopyAndForget(String from, String to, io.vertx.core.file.CopyOptions options)Variant ofcopy(String,String,CopyOptions)that ignores the result of the operation.FileSystemcopyBlocking(String from, String to)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)Blocking variant ofcopyRecursive(String,String,boolean).FileSystemcopyRecursiveAndForget(String from, String to, boolean recursive)Variant ofcopyRecursive(String,String,boolean)that ignores the result of the operation.FileSystemcopyRecursiveBlocking(String from, String to, boolean recursive)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)Blocking variant ofcreateFile(String).VoidcreateFileAndAwait(String path, String perms)Blocking variant ofcreateFile(String,String).FileSystemcreateFileAndForget(String path)Variant ofcreateFile(String)that ignores the result of the operation.FileSystemcreateFileAndForget(String path, String perms)Variant ofcreateFile(String,String)that ignores the result of the operation.FileSystemcreateFileBlocking(String path)FileSystemcreateFileBlocking(String path, String perms)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.StringcreateTempDirectoryAndAwait(String prefix)Blocking variant ofcreateTempDirectory(String).StringcreateTempDirectoryAndAwait(String prefix, String perms)Blocking variant ofcreateTempDirectory(String,String).StringcreateTempDirectoryAndAwait(String dir, String prefix, String perms)Blocking variant ofcreateTempDirectory(String,String,String).FileSystemcreateTempDirectoryAndForget(String prefix)Variant ofcreateTempDirectory(String)that ignores the result of the operation.FileSystemcreateTempDirectoryAndForget(String prefix, String perms)Variant ofcreateTempDirectory(String,String)that ignores the result of the operation.FileSystemcreateTempDirectoryAndForget(String dir, String prefix, String perms)Variant ofcreateTempDirectory(String,String,String)that ignores the result of the operation.StringcreateTempDirectoryBlocking(String prefix)StringcreateTempDirectoryBlocking(String prefix, String perms)StringcreateTempDirectoryBlocking(String dir, String prefix, String perms)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.StringcreateTempFileAndAwait(String prefix, String suffix)Blocking variant ofcreateTempFile(String,String).StringcreateTempFileAndAwait(String prefix, String suffix, String perms)Blocking variant ofcreateTempFile(String,String,String).StringcreateTempFileAndAwait(String dir, String prefix, String suffix, String perms)Blocking variant ofcreateTempFile(String,String,String,String).FileSystemcreateTempFileAndForget(String prefix, String suffix)Variant ofcreateTempFile(String,String)that ignores the result of the operation.FileSystemcreateTempFileAndForget(String prefix, String suffix, String perms)Variant ofcreateTempFile(String,String,String)that ignores the result of the operation.FileSystemcreateTempFileAndForget(String dir, String prefix, String suffix, String perms)Variant ofcreateTempFile(String,String,String,String)that ignores the result of the operation.StringcreateTempFileBlocking(String prefix, String suffix)StringcreateTempFileBlocking(String prefix, String suffix, String perms)StringcreateTempFileBlocking(String dir, String prefix, String suffix, String perms)io.smallrye.mutiny.Uni<Void>delete(String path)Deletes the file represented by the specifiedpath, asynchronously.VoiddeleteAndAwait(String path)Blocking variant ofdelete(String).FileSystemdeleteAndForget(String path)Variant ofdelete(String)that ignores the result of the operation.FileSystemdeleteBlocking(String path)io.smallrye.mutiny.Uni<Void>deleteRecursive(String path, boolean recursive)Deletes the file represented by the specifiedpath, asynchronously.VoiddeleteRecursiveAndAwait(String path, boolean recursive)Blocking variant ofdeleteRecursive(String,boolean).FileSystemdeleteRecursiveAndForget(String path, boolean recursive)Variant ofdeleteRecursive(String,boolean)that ignores the result of the operation.FileSystemdeleteRecursiveBlocking(String path, boolean recursive)booleanequals(Object o)io.smallrye.mutiny.Uni<Boolean>exists(String path)Determines whether the file as specified by the pathpathexists, asynchronously.BooleanexistsAndAwait(String path)Blocking variant ofexists(String).FileSystemexistsAndForget(String path)Variant ofexists(String)that ignores the result of the operation.booleanexistsBlocking(String path)io.smallrye.mutiny.Uni<FileSystemProps>fsProps(String path)Returns properties of the file-system being used by the specifiedpath, asynchronously.FileSystemPropsfsPropsAndAwait(String path)Blocking variant offsProps(String).FileSystemfsPropsAndForget(String path)Variant offsProps(String)that ignores the result of the operation.FileSystemPropsfsPropsBlocking(String path)io.vertx.core.file.FileSystemgetDelegate()inthashCode()io.smallrye.mutiny.Uni<Void>link(String link, String existing)Create a hard link on the file system fromlinktoexisting, asynchronously.VoidlinkAndAwait(String link, String existing)Blocking variant oflink(String,String).FileSystemlinkAndForget(String link, String existing)Variant oflink(String,String)that ignores the result of the operation.FileSystemlinkBlocking(String link, String existing)io.smallrye.mutiny.Uni<FileProps>lprops(String path)Obtain properties for the link represented bypath, asynchronously.FilePropslpropsAndAwait(String path)Blocking variant oflprops(String).FileSystemlpropsAndForget(String path)Variant oflprops(String)that ignores the result of the operation.FilePropslpropsBlocking(String path)io.smallrye.mutiny.Uni<Void>mkdir(String path)Create the directory represented bypath, asynchronously.io.smallrye.mutiny.Uni<Void>mkdir(String path, String perms)Create the directory represented bypath, asynchronously.VoidmkdirAndAwait(String path)Blocking variant ofmkdir(String).VoidmkdirAndAwait(String path, String perms)Blocking variant ofmkdir(String,String).FileSystemmkdirAndForget(String path)Variant ofmkdir(String)that ignores the result of the operation.FileSystemmkdirAndForget(String path, String perms)Variant ofmkdir(String,String)that ignores the result of the operation.FileSystemmkdirBlocking(String path)FileSystemmkdirBlocking(String path, String perms)io.smallrye.mutiny.Uni<Void>mkdirs(String path)Create the directory represented bypathand any non existent parents, asynchronously.io.smallrye.mutiny.Uni<Void>mkdirs(String path, String perms)Create the directory represented bypathand any non existent parents, asynchronously.VoidmkdirsAndAwait(String path)Blocking variant ofmkdirs(String).VoidmkdirsAndAwait(String path, String perms)Blocking variant ofmkdirs(String,String).FileSystemmkdirsAndForget(String path)Variant ofmkdirs(String)that ignores the result of the operation.FileSystemmkdirsAndForget(String path, String perms)Variant ofmkdirs(String,String)that ignores the result of the operation.FileSystemmkdirsBlocking(String path)FileSystemmkdirsBlocking(String path, String perms)io.smallrye.mutiny.Uni<Void>move(String from, String to)Move a file from the pathfromto pathto, asynchronously.io.smallrye.mutiny.Uni<Void>move(String from, String to, io.vertx.core.file.CopyOptions options)Move a file from the pathfromto pathto, asynchronously.VoidmoveAndAwait(String from, String to)Blocking variant ofmove(String,String).VoidmoveAndAwait(String from, String to, io.vertx.core.file.CopyOptions options)Blocking variant ofmove(String,String,CopyOptions).FileSystemmoveAndForget(String from, String to)Variant ofmove(String,String)that ignores the result of the operation.FileSystemmoveAndForget(String from, String to, io.vertx.core.file.CopyOptions options)Variant ofmove(String,String,CopyOptions)that ignores the result of the operation.FileSystemmoveBlocking(String from, String to)static FileSystemnewInstance(io.vertx.core.file.FileSystem arg)io.smallrye.mutiny.Uni<AsyncFile>open(String path, io.vertx.core.file.OpenOptions options)Open the file represented bypath, asynchronously.AsyncFileopenAndAwait(String path, io.vertx.core.file.OpenOptions options)Blocking variant ofopen(String,OpenOptions).FileSystemopenAndForget(String path, io.vertx.core.file.OpenOptions options)Variant ofopen(String,OpenOptions)that ignores the result of the operation.AsyncFileopenBlocking(String path, io.vertx.core.file.OpenOptions options)io.smallrye.mutiny.Uni<FileProps>props(String path)Obtain properties for the file represented bypath, asynchronously.FilePropspropsAndAwait(String path)Blocking variant ofprops(String).FileSystempropsAndForget(String path)Variant ofprops(String)that ignores the result of the operation.FilePropspropsBlocking(String path)io.smallrye.mutiny.Uni<List<String>>readDir(String path)Read the contents of the directory specified bypath, asynchronously.io.smallrye.mutiny.Uni<List<String>>readDir(String path, String filter)Read the contents of the directory specified bypath, asynchronously.List<String>readDirAndAwait(String path)Blocking variant ofreadDir(String).List<String>readDirAndAwait(String path, String filter)Blocking variant ofreadDir(String,String).FileSystemreadDirAndForget(String path)Variant ofreadDir(String)that ignores the result of the operation.FileSystemreadDirAndForget(String path, String filter)Variant ofreadDir(String,String)that ignores the result of the operation.List<String>readDirBlocking(String path)List<String>readDirBlocking(String path, String filter)io.smallrye.mutiny.Uni<Buffer>readFile(String path)Reads the entire file as represented by the pathpathas a , asynchronously.BufferreadFileAndAwait(String path)Blocking variant ofreadFile(String).FileSystemreadFileAndForget(String path)Variant ofreadFile(String)that ignores the result of the operation.BufferreadFileBlocking(String path)io.smallrye.mutiny.Uni<String>readSymlink(String link)Returns the path representing the file that the symbolic link specified bylinkpoints to, asynchronously.StringreadSymlinkAndAwait(String link)Blocking variant ofreadSymlink(String).FileSystemreadSymlinkAndForget(String link)Variant ofreadSymlink(String)that ignores the result of the operation.StringreadSymlinkBlocking(String link)io.smallrye.mutiny.Uni<Void>symlink(String link, String existing)Create a symbolic link on the file system fromlinktoexisting, asynchronously.VoidsymlinkAndAwait(String link, String existing)Blocking variant ofsymlink(String,String).FileSystemsymlinkAndForget(String link, String existing)Variant ofsymlink(String,String)that ignores the result of the operation.FileSystemsymlinkBlocking(String link, String existing)StringtoString()io.smallrye.mutiny.Uni<Void>truncate(String path, long len)Truncate the file represented bypathto lengthlenin bytes, asynchronously.VoidtruncateAndAwait(String path, long len)Blocking variant oftruncate(String,long).FileSystemtruncateAndForget(String path, long len)Variant oftruncate(String,long)that ignores the result of the operation.FileSystemtruncateBlocking(String path, long len)io.smallrye.mutiny.Uni<Void>unlink(String link)Unlinks the link on the file system represented by the pathlink, asynchronously.VoidunlinkAndAwait(String link)Blocking variant ofunlink(String).FileSystemunlinkAndForget(String link)Variant ofunlink(String)that ignores the result of the operation.FileSystemunlinkBlocking(String link)io.smallrye.mutiny.Uni<Void>writeFile(String path, Buffer data)Creates the file, and writes the specifiedBuffer datato the file represented by the pathpath, asynchronously.VoidwriteFileAndAwait(String path, Buffer data)Blocking variant ofwriteFile(String,io.vertx.mutiny.core.buffer.Buffer).FileSystemwriteFileAndForget(String path, Buffer data)Variant ofwriteFile(String,io.vertx.mutiny.core.buffer.Buffer)that ignores the result of the operation.FileSystemwriteFileBlocking(String path, Buffer data)
-
-
-
Field Detail
-
__TYPE_ARG
public static final TypeArg<FileSystem> __TYPE_ARG
-
-
Constructor Detail
-
FileSystem
public FileSystem(io.vertx.core.file.FileSystem delegate)
-
FileSystem
public FileSystem(Object delegate)
-
-
Method Detail
-
getDelegate
public io.vertx.core.file.FileSystem getDelegate()
-
copy
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> copy(String from, String to)
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. Don't forget to subscribe on it to trigger the operation.- Parameters:
from- the path to copy fromto- the path to copy to- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
copyAndAwait
public Void copyAndAwait(String from, String to)
Blocking variant ofcopy(String,String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
from- the path to copy fromto- the path to copy to- Returns:
- the Void instance produced by the operation.
-
copyAndForget
public FileSystem copyAndForget(String from, String to)
Variant ofcopy(String,String)that ignores the result of the operation.This method subscribes on the result of
copy(String,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcopy(String,String)but you don't need to compose it with other operations.- Parameters:
from- the path to copy fromto- the path to copy to- Returns:
- the instance of FileSystem to chain method calls.
-
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. 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:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
copyAndAwait
public Void copyAndAwait(String from, String to, io.vertx.core.file.CopyOptions options)
Blocking variant ofcopy(String,String,CopyOptions).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
from- the path to copy fromto- the path to copy tooptions- options describing how the file should be copied- Returns:
- the Void instance produced by the operation.
-
copyAndForget
public FileSystem copyAndForget(String from, String to, io.vertx.core.file.CopyOptions options)
Variant ofcopy(String,String,CopyOptions)that ignores the result of the operation.This method subscribes on the result of
copy(String,String,CopyOptions), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcopy(String,String,CopyOptions)but you don't need to compose it with other operations.- Parameters:
from- the path to copy fromto- the path to copy tooptions- options describing how the file should be copied- Returns:
- the instance of FileSystem to chain method calls.
-
copyBlocking
public FileSystem copyBlocking(String from, String to)
- Parameters:
from-to-- Returns:
- the instance of FileSystem to chain method calls.
-
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. Don't forget to subscribe on it to trigger the operation.- Parameters:
from- the path to copy fromto- the path to copy torecursive-- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
copyRecursiveAndAwait
public Void copyRecursiveAndAwait(String from, String to, boolean recursive)
Blocking variant ofcopyRecursive(String,String,boolean).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
from- the path to copy fromto- the path to copy torecursive-- Returns:
- the Void instance produced by the operation.
-
copyRecursiveAndForget
public FileSystem copyRecursiveAndForget(String from, String to, boolean recursive)
Variant ofcopyRecursive(String,String,boolean)that ignores the result of the operation.This method subscribes on the result of
copyRecursive(String,String,boolean), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcopyRecursive(String,String,boolean)but you don't need to compose it with other operations.- Parameters:
from- the path to copy fromto- the path to copy torecursive-- Returns:
- the instance of FileSystem to chain method calls.
-
copyRecursiveBlocking
public FileSystem copyRecursiveBlocking(String from, String to, boolean recursive)
- Parameters:
from-to-recursive-- Returns:
- the instance of FileSystem to chain method calls.
-
move
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> move(String from, String to)
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. Don't forget to subscribe on it to trigger the operation.- Parameters:
from- the path to copy fromto- the path to copy to- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
moveAndAwait
public Void moveAndAwait(String from, String to)
Blocking variant ofmove(String,String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
from- the path to copy fromto- the path to copy to- Returns:
- the Void instance produced by the operation.
-
moveAndForget
public FileSystem moveAndForget(String from, String to)
Variant ofmove(String,String)that ignores the result of the operation.This method subscribes on the result of
move(String,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation frommove(String,String)but you don't need to compose it with other operations.- Parameters:
from- the path to copy fromto- the path to copy to- Returns:
- the instance of FileSystem to chain method calls.
-
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. 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:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
moveAndAwait
public Void moveAndAwait(String from, String to, io.vertx.core.file.CopyOptions options)
Blocking variant ofmove(String,String,CopyOptions).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
from- the path to copy fromto- the path to copy tooptions- options describing how the file should be copied- Returns:
- the Void instance produced by the operation.
-
moveAndForget
public FileSystem moveAndForget(String from, String to, io.vertx.core.file.CopyOptions options)
Variant ofmove(String,String,CopyOptions)that ignores the result of the operation.This method subscribes on the result of
move(String,String,CopyOptions), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation frommove(String,String,CopyOptions)but you don't need to compose it with other operations.- Parameters:
from- the path to copy fromto- the path to copy tooptions- options describing how the file should be copied- Returns:
- the instance of FileSystem to chain method calls.
-
moveBlocking
public FileSystem moveBlocking(String from, String to)
- Parameters:
from-to-- Returns:
- the instance of FileSystem to chain method calls.
-
truncate
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> truncate(String path, long len)
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. 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:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
truncateAndAwait
public Void truncateAndAwait(String path, long len)
Blocking variant oftruncate(String,long).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- the path to the filelen- the length to truncate it to- Returns:
- the Void instance produced by the operation.
-
truncateAndForget
public FileSystem truncateAndForget(String path, long len)
Variant oftruncate(String,long)that ignores the result of the operation.This method subscribes on the result of
truncate(String,long), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromtruncate(String,long)but you don't need to compose it with other operations.- Parameters:
path- the path to the filelen- the length to truncate it to- Returns:
- the instance of FileSystem to chain method calls.
-
truncateBlocking
public FileSystem truncateBlocking(String path, long len)
- Parameters:
path-len-- Returns:
- the instance of FileSystem to chain method calls.
-
chmod
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> chmod(String path, String perms)
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. Don't forget to subscribe on it to trigger the operation.- Parameters:
path- the path to the fileperms- the permissions string- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
chmodAndAwait
public Void chmodAndAwait(String path, String perms)
Blocking variant ofchmod(String,String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- the path to the fileperms- the permissions string- Returns:
- the Void instance produced by the operation.
-
chmodAndForget
public FileSystem chmodAndForget(String path, String perms)
Variant ofchmod(String,String)that ignores the result of the operation.This method subscribes on the result of
chmod(String,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromchmod(String,String)but you don't need to compose it with other operations.- Parameters:
path- the path to the fileperms- the permissions string- Returns:
- the instance of FileSystem to chain method calls.
-
chmodBlocking
public FileSystem chmodBlocking(String path, String perms)
- Parameters:
path-perms-- Returns:
- the instance of FileSystem to chain method calls.
-
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. 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:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
chmodRecursiveAndAwait
public Void chmodRecursiveAndAwait(String path, String perms, String dirPerms)
Blocking variant ofchmodRecursive(String,String,String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- the path to the fileperms- the permissions stringdirPerms- the directory permissions- Returns:
- the Void instance produced by the operation.
-
chmodRecursiveAndForget
public FileSystem chmodRecursiveAndForget(String path, String perms, String dirPerms)
Variant ofchmodRecursive(String,String,String)that ignores the result of the operation.This method subscribes on the result of
chmodRecursive(String,String,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromchmodRecursive(String,String,String)but you don't need to compose it with other operations.- Parameters:
path- the path to the fileperms- the permissions stringdirPerms- the directory permissions- Returns:
- the instance of FileSystem to chain method calls.
-
chmodRecursiveBlocking
public FileSystem chmodRecursiveBlocking(String path, String perms, String dirPerms)
- Parameters:
path-perms-dirPerms-- Returns:
- the instance of FileSystem to chain method calls.
-
chown
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> chown(String path, String user, String group)
Change the ownership on the file represented bypathtouserand {code group}, asynchronously.Unlike the bare Vert.x variant, this method returns a
Uni. 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:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
chownAndAwait
public Void chownAndAwait(String path, String user, String group)
Blocking variant ofchown(String,String,String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- 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 Void instance produced by the operation.
-
chownAndForget
public FileSystem chownAndForget(String path, String user, String group)
Variant ofchown(String,String,String)that ignores the result of the operation.This method subscribes on the result of
chown(String,String,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromchown(String,String,String)but you don't need to compose it with other operations.- 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 instance of FileSystem to chain method calls.
-
chownBlocking
public FileSystem chownBlocking(String path, String user, String group)
- Parameters:
path-user-group-- Returns:
- the instance of FileSystem to chain method calls.
-
props
@CheckReturnValue public io.smallrye.mutiny.Uni<FileProps> props(String path)
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. Don't forget to subscribe on it to trigger the operation.- Parameters:
path- the path to the file- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
propsAndAwait
public FileProps propsAndAwait(String path)
Blocking variant ofprops(String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- the path to the file- Returns:
- the FileProps instance produced by the operation.
-
propsAndForget
public FileSystem propsAndForget(String path)
Variant ofprops(String)that ignores the result of the operation.This method subscribes on the result of
props(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromprops(String)but you don't need to compose it with other operations.- Parameters:
path- the path to the file- Returns:
- the instance of FileSystem to chain method calls.
-
lprops
@CheckReturnValue public io.smallrye.mutiny.Uni<FileProps> lprops(String path)
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. Don't forget to subscribe on it to trigger the operation.- Parameters:
path- the path to the file- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
lpropsAndAwait
public FileProps lpropsAndAwait(String path)
Blocking variant oflprops(String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- the path to the file- Returns:
- the FileProps instance produced by the operation.
-
lpropsAndForget
public FileSystem lpropsAndForget(String path)
Variant oflprops(String)that ignores the result of the operation.This method subscribes on the result of
lprops(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromlprops(String)but you don't need to compose it with other operations.- Parameters:
path- the path to the file- Returns:
- the instance of FileSystem to chain method calls.
-
link
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> link(String link, String existing)
Create a hard link on the file system fromlinktoexisting, asynchronously.Unlike the bare Vert.x variant, this method returns a
Uni. Don't forget to subscribe on it to trigger the operation.- Parameters:
link- the linkexisting- the link destination- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
linkAndAwait
public Void linkAndAwait(String link, String existing)
Blocking variant oflink(String,String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
link- the linkexisting- the link destination- Returns:
- the Void instance produced by the operation.
-
linkAndForget
public FileSystem linkAndForget(String link, String existing)
Variant oflink(String,String)that ignores the result of the operation.This method subscribes on the result of
link(String,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromlink(String,String)but you don't need to compose it with other operations.- Parameters:
link- the linkexisting- the link destination- Returns:
- the instance of FileSystem to chain method calls.
-
linkBlocking
public FileSystem linkBlocking(String link, String existing)
- Parameters:
link-existing-- Returns:
- the instance of FileSystem to chain method calls.
-
symlink
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> symlink(String link, String existing)
Create a symbolic link on the file system fromlinktoexisting, asynchronously.Unlike the bare Vert.x variant, this method returns a
Uni. Don't forget to subscribe on it to trigger the operation.- Parameters:
link- the linkexisting- the link destination- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
symlinkAndAwait
public Void symlinkAndAwait(String link, String existing)
Blocking variant ofsymlink(String,String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
link- the linkexisting- the link destination- Returns:
- the Void instance produced by the operation.
-
symlinkAndForget
public FileSystem symlinkAndForget(String link, String existing)
Variant ofsymlink(String,String)that ignores the result of the operation.This method subscribes on the result of
symlink(String,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromsymlink(String,String)but you don't need to compose it with other operations.- Parameters:
link- the linkexisting- the link destination- Returns:
- the instance of FileSystem to chain method calls.
-
symlinkBlocking
public FileSystem symlinkBlocking(String link, String existing)
- Parameters:
link-existing-- Returns:
- the instance of FileSystem to chain method calls.
-
unlink
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> unlink(String link)
Unlinks the link on the file system represented by the pathlink, asynchronously.Unlike the bare Vert.x variant, this method returns a
Uni. Don't forget to subscribe on it to trigger the operation.- Parameters:
link- the link- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
unlinkAndAwait
public Void unlinkAndAwait(String link)
Blocking variant ofunlink(String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
link- the link- Returns:
- the Void instance produced by the operation.
-
unlinkAndForget
public FileSystem unlinkAndForget(String link)
Variant ofunlink(String)that ignores the result of the operation.This method subscribes on the result of
unlink(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromunlink(String)but you don't need to compose it with other operations.- Parameters:
link- the link- Returns:
- the instance of FileSystem to chain method calls.
-
unlinkBlocking
public FileSystem unlinkBlocking(String link)
- Parameters:
link-- Returns:
- the instance of FileSystem to chain method calls.
-
readSymlink
@CheckReturnValue public io.smallrye.mutiny.Uni<String> readSymlink(String link)
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. Don't forget to subscribe on it to trigger the operation.- Parameters:
link- the link- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
readSymlinkAndAwait
public String readSymlinkAndAwait(String link)
Blocking variant ofreadSymlink(String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
link- the link- Returns:
- the String instance produced by the operation.
-
readSymlinkAndForget
public FileSystem readSymlinkAndForget(String link)
Variant ofreadSymlink(String)that ignores the result of the operation.This method subscribes on the result of
readSymlink(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromreadSymlink(String)but you don't need to compose it with other operations.- Parameters:
link- the link- Returns:
- the instance of FileSystem to chain method calls.
-
delete
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> delete(String path)
Deletes the file represented by the specifiedpath, asynchronously.Unlike the bare Vert.x variant, this method returns a
Uni. Don't forget to subscribe on it to trigger the operation.- Parameters:
path- path to the file- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
deleteAndAwait
public Void deleteAndAwait(String path)
Blocking variant ofdelete(String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- path to the file- Returns:
- the Void instance produced by the operation.
-
deleteAndForget
public FileSystem deleteAndForget(String path)
Variant ofdelete(String)that ignores the result of the operation.This method subscribes on the result of
delete(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromdelete(String)but you don't need to compose it with other operations.- Parameters:
path- path to the file- Returns:
- the instance of FileSystem to chain method calls.
-
deleteBlocking
public FileSystem deleteBlocking(String path)
- Parameters:
path-- Returns:
- the instance of FileSystem to chain method calls.
-
deleteRecursive
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> deleteRecursive(String path, boolean recursive)
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. Don't forget to subscribe on it to trigger the operation.- Parameters:
path- path to the filerecursive- delete recursively?- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
deleteRecursiveAndAwait
public Void deleteRecursiveAndAwait(String path, boolean recursive)
Blocking variant ofdeleteRecursive(String,boolean).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- path to the filerecursive- delete recursively?- Returns:
- the Void instance produced by the operation.
-
deleteRecursiveAndForget
public FileSystem deleteRecursiveAndForget(String path, boolean recursive)
Variant ofdeleteRecursive(String,boolean)that ignores the result of the operation.This method subscribes on the result of
deleteRecursive(String,boolean), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromdeleteRecursive(String,boolean)but you don't need to compose it with other operations.- Parameters:
path- path to the filerecursive- delete recursively?- Returns:
- the instance of FileSystem to chain method calls.
-
deleteRecursiveBlocking
public FileSystem deleteRecursiveBlocking(String path, boolean recursive)
- Parameters:
path-recursive-- Returns:
- the instance of FileSystem to chain method calls.
-
mkdir
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> mkdir(String path)
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. Don't forget to subscribe on it to trigger the operation.- Parameters:
path- path to the file- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
mkdirAndAwait
public Void mkdirAndAwait(String path)
Blocking variant ofmkdir(String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- path to the file- Returns:
- the Void instance produced by the operation.
-
mkdirAndForget
public FileSystem mkdirAndForget(String path)
Variant ofmkdir(String)that ignores the result of the operation.This method subscribes on the result of
mkdir(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation frommkdir(String)but you don't need to compose it with other operations.- Parameters:
path- path to the file- Returns:
- the instance of FileSystem to chain method calls.
-
mkdirBlocking
public FileSystem mkdirBlocking(String path)
- Parameters:
path-- Returns:
- the instance of FileSystem to chain method calls.
-
mkdir
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> mkdir(String path, String perms)
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. Don't forget to subscribe on it to trigger the operation.- Parameters:
path- path to the fileperms- the permissions string- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
mkdirAndAwait
public Void mkdirAndAwait(String path, String perms)
Blocking variant ofmkdir(String,String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- path to the fileperms- the permissions string- Returns:
- the Void instance produced by the operation.
-
mkdirAndForget
public FileSystem mkdirAndForget(String path, String perms)
Variant ofmkdir(String,String)that ignores the result of the operation.This method subscribes on the result of
mkdir(String,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation frommkdir(String,String)but you don't need to compose it with other operations.- Parameters:
path- path to the fileperms- the permissions string- Returns:
- the instance of FileSystem to chain method calls.
-
mkdirBlocking
public FileSystem mkdirBlocking(String path, String perms)
- Parameters:
path-perms-- Returns:
- the instance of FileSystem to chain method calls.
-
mkdirs
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> mkdirs(String path)
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. Don't forget to subscribe on it to trigger the operation.- Parameters:
path- path to the file- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
mkdirsAndAwait
public Void mkdirsAndAwait(String path)
Blocking variant ofmkdirs(String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- path to the file- Returns:
- the Void instance produced by the operation.
-
mkdirsAndForget
public FileSystem mkdirsAndForget(String path)
Variant ofmkdirs(String)that ignores the result of the operation.This method subscribes on the result of
mkdirs(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation frommkdirs(String)but you don't need to compose it with other operations.- Parameters:
path- path to the file- Returns:
- the instance of FileSystem to chain method calls.
-
mkdirsBlocking
public FileSystem mkdirsBlocking(String path)
- Parameters:
path-- Returns:
- the instance of FileSystem to chain method calls.
-
mkdirs
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> mkdirs(String path, String perms)
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. Don't forget to subscribe on it to trigger the operation.- Parameters:
path- path to the fileperms- the permissions string- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
mkdirsAndAwait
public Void mkdirsAndAwait(String path, String perms)
Blocking variant ofmkdirs(String,String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- path to the fileperms- the permissions string- Returns:
- the Void instance produced by the operation.
-
mkdirsAndForget
public FileSystem mkdirsAndForget(String path, String perms)
Variant ofmkdirs(String,String)that ignores the result of the operation.This method subscribes on the result of
mkdirs(String,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation frommkdirs(String,String)but you don't need to compose it with other operations.- Parameters:
path- path to the fileperms- the permissions string- Returns:
- the instance of FileSystem to chain method calls.
-
mkdirsBlocking
public FileSystem mkdirsBlocking(String path, String perms)
- Parameters:
path-perms-- Returns:
- the instance of FileSystem to chain method calls.
-
readDir
@CheckReturnValue public io.smallrye.mutiny.Uni<List<String>> readDir(String path)
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. Don't forget to subscribe on it to trigger the operation.- Parameters:
path- path to the file- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
readDirAndAwait
public List<String> readDirAndAwait(String path)
Blocking variant ofreadDir(String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- path to the file- Returns:
- the List
instance produced by the operation.
-
readDirAndForget
public FileSystem readDirAndForget(String path)
Variant ofreadDir(String)that ignores the result of the operation.This method subscribes on the result of
readDir(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromreadDir(String)but you don't need to compose it with other operations.- Parameters:
path- path to the file- Returns:
- the instance of FileSystem to chain method calls.
-
readDir
@CheckReturnValue public io.smallrye.mutiny.Uni<List<String>> readDir(String path, String filter)
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. Don't forget to subscribe on it to trigger the operation.- Parameters:
path- path to the directoryfilter- the filter expression- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
readDirAndAwait
public List<String> readDirAndAwait(String path, String filter)
Blocking variant ofreadDir(String,String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- path to the directoryfilter- the filter expression- Returns:
- the List
instance produced by the operation.
-
readDirAndForget
public FileSystem readDirAndForget(String path, String filter)
Variant ofreadDir(String,String)that ignores the result of the operation.This method subscribes on the result of
readDir(String,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromreadDir(String,String)but you don't need to compose it with other operations.- Parameters:
path- path to the directoryfilter- the filter expression- Returns:
- the instance of FileSystem to chain method calls.
-
readDirBlocking
public List<String> readDirBlocking(String path, String filter)
- Parameters:
path-filter-- Returns:
-
readFile
@CheckReturnValue public io.smallrye.mutiny.Uni<Buffer> readFile(String path)
Reads the entire file as represented by the pathpathas a , 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. Don't forget to subscribe on it to trigger the operation.- Parameters:
path- path to the file- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
readFileAndAwait
public Buffer readFileAndAwait(String path)
Blocking variant ofreadFile(String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- path to the file- Returns:
- the Buffer instance produced by the operation.
-
readFileAndForget
public FileSystem readFileAndForget(String path)
Variant ofreadFile(String)that ignores the result of the operation.This method subscribes on the result of
readFile(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromreadFile(String)but you don't need to compose it with other operations.- Parameters:
path- path to the file- Returns:
- the instance of FileSystem to chain method calls.
-
writeFile
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> writeFile(String path, 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. Don't forget to subscribe on it to trigger the operation.- Parameters:
path- path to the filedata-- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
writeFileAndAwait
public Void writeFileAndAwait(String path, Buffer data)
Blocking variant ofwriteFile(String,io.vertx.mutiny.core.buffer.Buffer).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- path to the filedata-- Returns:
- the Void instance produced by the operation.
-
writeFileAndForget
public FileSystem writeFileAndForget(String path, Buffer data)
Variant ofwriteFile(String,io.vertx.mutiny.core.buffer.Buffer)that ignores the result of the operation.This method subscribes on the result of
writeFile(String,io.vertx.mutiny.core.buffer.Buffer), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromwriteFile(String,io.vertx.mutiny.core.buffer.Buffer)but you don't need to compose it with other operations.- Parameters:
path- path to the filedata-- Returns:
- the instance of FileSystem to chain method calls.
-
writeFileBlocking
public FileSystem writeFileBlocking(String path, Buffer data)
- Parameters:
path-data-- Returns:
- the instance of FileSystem to chain method calls.
-
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. 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:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
openAndAwait
public AsyncFile openAndAwait(String path, io.vertx.core.file.OpenOptions options)
Blocking variant ofopen(String,OpenOptions).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- path to the fileoptions- options describing how the file should be opened- Returns:
- the AsyncFile instance produced by the operation.
-
openAndForget
public FileSystem openAndForget(String path, io.vertx.core.file.OpenOptions options)
Variant ofopen(String,OpenOptions)that ignores the result of the operation.This method subscribes on the result of
open(String,OpenOptions), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromopen(String,OpenOptions)but you don't need to compose it with other operations.- Parameters:
path- path to the fileoptions- options describing how the file should be opened- Returns:
- the instance of FileSystem to chain method calls.
-
openBlocking
public AsyncFile openBlocking(String path, io.vertx.core.file.OpenOptions options)
- Parameters:
path-options-- Returns:
-
createFile
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> createFile(String path)
Creates an empty file with the specifiedpath, asynchronously.Unlike the bare Vert.x variant, this method returns a
Uni. Don't forget to subscribe on it to trigger the operation.- Parameters:
path- path to the file- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
createFileAndAwait
public Void createFileAndAwait(String path)
Blocking variant ofcreateFile(String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- path to the file- Returns:
- the Void instance produced by the operation.
-
createFileAndForget
public FileSystem createFileAndForget(String path)
Variant ofcreateFile(String)that ignores the result of the operation.This method subscribes on the result of
createFile(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcreateFile(String)but you don't need to compose it with other operations.- Parameters:
path- path to the file- Returns:
- the instance of FileSystem to chain method calls.
-
createFileBlocking
public FileSystem createFileBlocking(String path)
- Parameters:
path-- Returns:
- the instance of FileSystem to chain method calls.
-
createFile
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> createFile(String path, String perms)
Creates an empty file with the specifiedpathand permissionsperms, asynchronously.Unlike the bare Vert.x variant, this method returns a
Uni. Don't forget to subscribe on it to trigger the operation.- Parameters:
path- path to the fileperms- the permissions string- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
createFileAndAwait
public Void createFileAndAwait(String path, String perms)
Blocking variant ofcreateFile(String,String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- path to the fileperms- the permissions string- Returns:
- the Void instance produced by the operation.
-
createFileAndForget
public FileSystem createFileAndForget(String path, String perms)
Variant ofcreateFile(String,String)that ignores the result of the operation.This method subscribes on the result of
createFile(String,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcreateFile(String,String)but you don't need to compose it with other operations.- Parameters:
path- path to the fileperms- the permissions string- Returns:
- the instance of FileSystem to chain method calls.
-
createFileBlocking
public FileSystem createFileBlocking(String path, String perms)
- Parameters:
path-perms-- Returns:
- the instance of FileSystem to chain method calls.
-
exists
@CheckReturnValue public io.smallrye.mutiny.Uni<Boolean> exists(String path)
Determines whether the file as specified by the pathpathexists, asynchronously.Unlike the bare Vert.x variant, this method returns a
Uni. Don't forget to subscribe on it to trigger the operation.- Parameters:
path- path to the file- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
existsAndAwait
public Boolean existsAndAwait(String path)
Blocking variant ofexists(String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- path to the file- Returns:
- the Boolean instance produced by the operation.
-
existsAndForget
public FileSystem existsAndForget(String path)
Variant ofexists(String)that ignores the result of the operation.This method subscribes on the result of
exists(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromexists(String)but you don't need to compose it with other operations.- Parameters:
path- path to the file- Returns:
- the instance of FileSystem to chain method calls.
-
existsBlocking
public boolean existsBlocking(String path)
- Parameters:
path-- Returns:
-
fsProps
@CheckReturnValue public io.smallrye.mutiny.Uni<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. Don't forget to subscribe on it to trigger the operation.- Parameters:
path- path to anywhere on the filesystem- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
fsPropsAndAwait
public FileSystemProps fsPropsAndAwait(String path)
Blocking variant offsProps(String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
path- path to anywhere on the filesystem- Returns:
- the FileSystemProps instance produced by the operation.
-
fsPropsAndForget
public FileSystem fsPropsAndForget(String path)
Variant offsProps(String)that ignores the result of the operation.This method subscribes on the result of
fsProps(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromfsProps(String)but you don't need to compose it with other operations.- Parameters:
path- path to anywhere on the filesystem- Returns:
- the instance of FileSystem to chain method calls.
-
fsPropsBlocking
public FileSystemProps fsPropsBlocking(String path)
- Parameters:
path-- Returns:
-
createTempDirectory
@CheckReturnValue public 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.As with the
File.createTempFilemethods, this method is only part of a temporary-file facility.ARuntime, or theFilemechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method returns a
Uni. 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:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
createTempDirectoryAndAwait
public String createTempDirectoryAndAwait(String prefix)
Blocking variant ofcreateTempDirectory(String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
prefix- the prefix string to be used in generating the directory's name; may benull- Returns:
- the String instance produced by the operation.
-
createTempDirectoryAndForget
public FileSystem createTempDirectoryAndForget(String prefix)
Variant ofcreateTempDirectory(String)that ignores the result of the operation.This method subscribes on the result of
createTempDirectory(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcreateTempDirectory(String)but you don't need to compose it with other operations.- Parameters:
prefix- the prefix string to be used in generating the directory's name; may benull- Returns:
- the instance of FileSystem to chain method calls.
-
createTempDirectoryBlocking
public String createTempDirectoryBlocking(String prefix)
- Parameters:
prefix-- Returns:
-
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.ARuntime, or theFilemechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method returns a
Uni. 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:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
createTempDirectoryAndAwait
public String createTempDirectoryAndAwait(String prefix, String perms)
Blocking variant ofcreateTempDirectory(String,String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
prefix- the prefix string to be used in generating the directory's name; may benullperms- the permissions string- Returns:
- the String instance produced by the operation.
-
createTempDirectoryAndForget
public FileSystem createTempDirectoryAndForget(String prefix, String perms)
Variant ofcreateTempDirectory(String,String)that ignores the result of the operation.This method subscribes on the result of
createTempDirectory(String,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcreateTempDirectory(String,String)but you don't need to compose it with other operations.- Parameters:
prefix- the prefix string to be used in generating the directory's name; may benullperms- the permissions string- Returns:
- the instance of FileSystem to chain method calls.
-
createTempDirectoryBlocking
public String createTempDirectoryBlocking(String prefix, String perms)
- Parameters:
prefix-perms-- Returns:
-
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.ARuntime, or theFilemechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method returns a
Uni. 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:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
createTempDirectoryAndAwait
public String createTempDirectoryAndAwait(String dir, String prefix, String perms)
Blocking variant ofcreateTempDirectory(String,String,String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- 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 String instance produced by the operation.
-
createTempDirectoryAndForget
public FileSystem createTempDirectoryAndForget(String dir, String prefix, String perms)
Variant ofcreateTempDirectory(String,String,String)that ignores the result of the operation.This method subscribes on the result of
createTempDirectory(String,String,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcreateTempDirectory(String,String,String)but you don't need to compose it with other operations.- 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 instance of FileSystem to chain method calls.
-
createTempDirectoryBlocking
public String createTempDirectoryBlocking(String dir, String prefix, String perms)
- Parameters:
dir-prefix-perms-- Returns:
-
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.ARuntime, or theFilemechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method returns a
Uni. 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:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
createTempFileAndAwait
public String createTempFileAndAwait(String prefix, String suffix)
Blocking variant ofcreateTempFile(String,String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- 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 String instance produced by the operation.
-
createTempFileAndForget
public FileSystem createTempFileAndForget(String prefix, String suffix)
Variant ofcreateTempFile(String,String)that ignores the result of the operation.This method subscribes on the result of
createTempFile(String,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcreateTempFile(String,String)but you don't need to compose it with other operations.- 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 instance of FileSystem to chain method calls.
-
createTempFileBlocking
public String createTempFileBlocking(String prefix, String suffix)
- Parameters:
prefix-suffix-- Returns:
-
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.ARuntime, or theFilemechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method returns a
Uni. 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 usedperms-- Returns:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
createTempFileAndAwait
public String createTempFileAndAwait(String prefix, String suffix, String perms)
Blocking variant ofcreateTempFile(String,String,String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- 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 usedperms-- Returns:
- the String instance produced by the operation.
-
createTempFileAndForget
public FileSystem createTempFileAndForget(String prefix, String suffix, String perms)
Variant ofcreateTempFile(String,String,String)that ignores the result of the operation.This method subscribes on the result of
createTempFile(String,String,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcreateTempFile(String,String,String)but you don't need to compose it with other operations.- 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 usedperms-- Returns:
- the instance of FileSystem to chain method calls.
-
createTempFileBlocking
public String createTempFileBlocking(String prefix, String suffix, String perms)
- Parameters:
prefix-suffix-perms-- Returns:
-
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.ARuntime, or theFilemechanism may be used to delete the directory automatically.Unlike the bare Vert.x variant, this method returns a
Uni. 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:
- the
unifiring the result of the operation when completed, or a failure if the operation failed.
-
createTempFileAndAwait
public String createTempFileAndAwait(String dir, String prefix, String suffix, String perms)
Blocking variant ofcreateTempFile(String,String,String,String).This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- 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 String instance produced by the operation.
-
createTempFileAndForget
public FileSystem createTempFileAndForget(String dir, String prefix, String suffix, String perms)
Variant ofcreateTempFile(String,String,String,String)that ignores the result of the operation.This method subscribes on the result of
createTempFile(String,String,String,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcreateTempFile(String,String,String,String)but you don't need to compose it with other operations.- 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 instance of FileSystem to chain method calls.
-
createTempFileBlocking
public String createTempFileBlocking(String dir, String prefix, String suffix, String perms)
- Parameters:
dir-prefix-suffix-perms-- Returns:
-
newInstance
public static FileSystem newInstance(io.vertx.core.file.FileSystem arg)
-
-