Package io.vertx.rxjava3.core.file

Class 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 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 RX-ified interface using Vert.x codegen.

    • Field Detail

      • __TYPE_ARG

        public static final io.vertx.lang.rx.TypeArg<FileSystem> __TYPE_ARG

    • Constructor Detail

      • FileSystem

        public FileSystem​(FileSystem delegate)

      • FileSystem

        public FileSystem​(Object delegate)

    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • copy

        public Completable copy​(String from,
                        String to)
        Copy a file from the path from to path to, asynchronously.

        The copy will fail if the destination already exists.

        Parameters:
        from - the path to copy from
        to - the path to copy to
        Returns:
        a future notified on completion

      • rxCopy

        public Completable rxCopy​(String from,
                          String to)
        Copy a file from the path from to path to, asynchronously.

        The copy will fail if the destination already exists.

        Parameters:
        from - the path to copy from
        to - the path to copy to
        Returns:
        a future notified on completion

      • copy

        public Completable copy​(String from,
                        String to,
                        CopyOptions options)
        Copy a file from the path from to path to, asynchronously.
        Parameters:
        from - the path to copy from
        to - the path to copy to
        options - options describing how the file should be copied
        Returns:
        a future notified on completion

      • rxCopy

        public Completable rxCopy​(String from,
                          String to,
                          CopyOptions options)
        Copy a file from the path from to path to, asynchronously.
        Parameters:
        from - the path to copy from
        to - the path to copy to
        options - options describing how the file should be copied
        Returns:
        a future notified on completion

      • copyRecursive

        public Completable copyRecursive​(String from,
                                 String to,
                                 boolean recursive)
        Copy a file from the path from to path to, asynchronously.

        If recursive is true and from represents a directory, then the directory and its contents will be copied recursively to the destination to.

        The copy will fail if the destination if the destination already exists.

        Parameters:
        from - the path to copy from
        to - the path to copy to
        recursive -
        Returns:
        a future notified on completion

      • rxCopyRecursive

        public Completable rxCopyRecursive​(String from,
                                   String to,
                                   boolean recursive)
        Copy a file from the path from to path to, asynchronously.

        If recursive is true and from represents a directory, then the directory and its contents will be copied recursively to the destination to.

        The copy will fail if the destination if the destination already exists.

        Parameters:
        from - the path to copy from
        to - the path to copy to
        recursive -
        Returns:
        a future notified on completion

      • move

        public Completable move​(String from,
                        String to)
        Move a file from the path from to path to, asynchronously.

        The move will fail if the destination already exists.

        Parameters:
        from - the path to copy from
        to - the path to copy to
        Returns:
        a future notified on completion

      • rxMove

        public Completable rxMove​(String from,
                          String to)
        Move a file from the path from to path to, asynchronously.

        The move will fail if the destination already exists.

        Parameters:
        from - the path to copy from
        to - the path to copy to
        Returns:
        a future notified on completion

      • move

        public Completable move​(String from,
                        String to,
                        CopyOptions options)
        Move a file from the path from to path to, asynchronously.
        Parameters:
        from - the path to copy from
        to - the path to copy to
        options - options describing how the file should be copied
        Returns:
        a future notified on completion

      • rxMove

        public Completable rxMove​(String from,
                          String to,
                          CopyOptions options)
        Move a file from the path from to path to, asynchronously.
        Parameters:
        from - the path to copy from
        to - the path to copy to
        options - options describing how the file should be copied
        Returns:
        a future notified on completion

      • truncate

        public Completable truncate​(String path,
                            long len)
        Truncate the file represented by path to length len in bytes, asynchronously.

        The operation will fail if the file does not exist or len is less than zero.

        Parameters:
        path - the path to the file
        len - the length to truncate it to
        Returns:
        a future notified on completion

      • rxTruncate

        public Completable rxTruncate​(String path,
                              long len)
        Truncate the file represented by path to length len in bytes, asynchronously.

        The operation will fail if the file does not exist or len is less than zero.

        Parameters:
        path - the path to the file
        len - the length to truncate it to
        Returns:
        a future notified on completion

      • chmod

        public Completable chmod​(String path,
                         String perms)
        Change the permissions on the file represented by path to perms, asynchronously.

        The permission String takes the form rwxr-x--- as specified here.

        Parameters:
        path - the path to the file
        perms - the permissions string
        Returns:
        a future notified on completion

      • rxChmod

        public Completable rxChmod​(String path,
                           String perms)
        Change the permissions on the file represented by path to perms, asynchronously.

        The permission String takes the form rwxr-x--- as specified here.

        Parameters:
        path - the path to the file
        perms - the permissions string
        Returns:
        a future notified on completion

      • chmodRecursive

        public Completable chmodRecursive​(String path,
                                  String perms,
                                  String dirPerms)
        Change the permissions on the file represented by path to perms, 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 to perms.

        Parameters:
        path - the path to the file
        perms - the permissions string
        dirPerms - the directory permissions
        Returns:
        a future notified on completion

      • rxChmodRecursive

        public Completable rxChmodRecursive​(String path,
                                    String perms,
                                    String dirPerms)
        Change the permissions on the file represented by path to perms, 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 to perms.

        Parameters:
        path - the path to the file
        perms - the permissions string
        dirPerms - the directory permissions
        Returns:
        a future notified on completion

      • chown

        public Completable chown​(String path,
                         String user,
                         String group)
        Change the ownership on the file represented by path to user and {code group}, asynchronously.
        Parameters:
        path - the path to the file
        user - the user name, null will not change the user name
        group - the user group, null will not change the user group name
        Returns:
        a future notified on completion

      • rxChown

        public Completable rxChown​(String path,
                           String user,
                           String group)
        Change the ownership on the file represented by path to user and {code group}, asynchronously.
        Parameters:
        path - the path to the file
        user - the user name, null will not change the user name
        group - the user group, null will not change the user group name
        Returns:
        a future notified on completion

      • props

        public Single<FileProps> props​(String path)
        Obtain properties for the file represented by path, asynchronously.

        If the file is a link, the link will be followed.

        Parameters:
        path - the path to the file
        Returns:
        a future notified on completion

      • rxProps

        public Single<FileProps> rxProps​(String path)
        Obtain properties for the file represented by path, asynchronously.

        If the file is a link, the link will be followed.

        Parameters:
        path - the path to the file
        Returns:
        a future notified on completion

      • lprops

        public Single<FileProps> lprops​(String path)
        Obtain properties for the link represented by path, asynchronously.

        The link will not be followed.

        Parameters:
        path - the path to the file
        Returns:
        a future notified on completion

      • rxLprops

        public Single<FileProps> rxLprops​(String path)
        Obtain properties for the link represented by path, asynchronously.

        The link will not be followed.

        Parameters:
        path - the path to the file
        Returns:
        a future notified on completion

      • link

        public Completable link​(String link,
                        String existing)
        Create a hard link on the file system from link to existing, asynchronously.
        Parameters:
        link - the link
        existing - the link destination
        Returns:
        a future notified on completion

      • rxLink

        public Completable rxLink​(String link,
                          String existing)
        Create a hard link on the file system from link to existing, asynchronously.
        Parameters:
        link - the link
        existing - the link destination
        Returns:
        a future notified on completion

      • symlink

        public Completable symlink​(String link,
                           String existing)
        Create a symbolic link on the file system from link to existing, asynchronously.
        Parameters:
        link - the link
        existing - the link destination
        Returns:
        a future notified on completion

      • rxSymlink

        public Completable rxSymlink​(String link,
                             String existing)
        Create a symbolic link on the file system from link to existing, asynchronously.
        Parameters:
        link - the link
        existing - the link destination
        Returns:
        a future notified on completion

      • unlink

        public Completable unlink​(String link)
        Unlinks the link on the file system represented by the path link, asynchronously.
        Parameters:
        link - the link
        Returns:
        a future notified on completion

      • rxUnlink

        public Completable rxUnlink​(String link)
        Unlinks the link on the file system represented by the path link, asynchronously.
        Parameters:
        link - the link
        Returns:
        a future notified on completion

      • readSymlink

        public Single<String> readSymlink​(String link)
        Returns the path representing the file that the symbolic link specified by link points to, asynchronously.
        Parameters:
        link - the link
        Returns:
        a future notified on completion

      • rxReadSymlink

        public Single<String> rxReadSymlink​(String link)
        Returns the path representing the file that the symbolic link specified by link points to, asynchronously.
        Parameters:
        link - the link
        Returns:
        a future notified on completion

      • delete

        public Completable delete​(String path)
        Deletes the file represented by the specified path, asynchronously.
        Parameters:
        path - path to the file
        Returns:
        a future notified on completion

      • rxDelete

        public Completable rxDelete​(String path)
        Deletes the file represented by the specified path, asynchronously.
        Parameters:
        path - path to the file
        Returns:
        a future notified on completion

      • deleteRecursive

        public Completable deleteRecursive​(String path,
                                   boolean recursive)
        Deletes the file represented by the specified path, asynchronously.

        If the path represents a directory and recursive = true then the directory and its contents will be deleted recursively.

        Parameters:
        path - path to the file
        recursive - delete recursively?
        Returns:
        a future notified on completion

      • rxDeleteRecursive

        public Completable rxDeleteRecursive​(String path,
                                     boolean recursive)
        Deletes the file represented by the specified path, asynchronously.

        If the path represents a directory and recursive = true then the directory and its contents will be deleted recursively.

        Parameters:
        path - path to the file
        recursive - delete recursively?
        Returns:
        a future notified on completion

      • mkdir

        public Completable mkdir​(String path)
        Create the directory represented by path, asynchronously.

        The operation will fail if the directory already exists.

        Parameters:
        path - path to the file
        Returns:
        a future notified on completion

      • rxMkdir

        public Completable rxMkdir​(String path)
        Create the directory represented by path, asynchronously.

        The operation will fail if the directory already exists.

        Parameters:
        path - path to the file
        Returns:
        a future notified on completion

      • mkdir

        public Completable mkdir​(String path,
                         String perms)
        Create the directory represented by path, 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.

        Parameters:
        path - path to the file
        perms - the permissions string
        Returns:
        a future notified on completion

      • rxMkdir

        public Completable rxMkdir​(String path,
                           String perms)
        Create the directory represented by path, 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.

        Parameters:
        path - path to the file
        perms - the permissions string
        Returns:
        a future notified on completion

      • mkdirs

        public Completable mkdirs​(String path)
        Create the directory represented by path and any non existent parents, asynchronously.

        The operation will fail if the path already exists but is not a directory.

        Parameters:
        path - path to the file
        Returns:
        a future notified on completion

      • rxMkdirs

        public Completable rxMkdirs​(String path)
        Create the directory represented by path and any non existent parents, asynchronously.

        The operation will fail if the path already exists but is not a directory.

        Parameters:
        path - path to the file
        Returns:
        a future notified on completion

      • mkdirs

        public Completable mkdirs​(String path,
                          String perms)
        Create the directory represented by path and 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 path already exists but is not a directory.

        Parameters:
        path - path to the file
        perms - the permissions string
        Returns:
        a future notified on completion

      • rxMkdirs

        public Completable rxMkdirs​(String path,
                            String perms)
        Create the directory represented by path and 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 path already exists but is not a directory.

        Parameters:
        path - path to the file
        perms - the permissions string
        Returns:
        a future notified on completion

      • readDir

        public Single<List<String>> readDir​(String path)
        Read the contents of the directory specified by path, asynchronously.

        The result is an array of String representing the paths of the files inside the directory.

        Parameters:
        path - path to the file
        Returns:
        a future notified on completion

      • rxReadDir

        public Single<List<String>> rxReadDir​(String path)
        Read the contents of the directory specified by path, asynchronously.

        The result is an array of String representing the paths of the files inside the directory.

        Parameters:
        path - path to the file
        Returns:
        a future notified on completion

      • readDir

        public Single<List<String>> readDir​(String path,
                                    String filter)
        Read the contents of the directory specified by path, asynchronously.

        The parameter filter is a regular expression. If filter is 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.

        Parameters:
        path - path to the directory
        filter - the filter expression
        Returns:
        a future notified on completion

      • rxReadDir

        public Single<List<String>> rxReadDir​(String path,
                                      String filter)
        Read the contents of the directory specified by path, asynchronously.

        The parameter filter is a regular expression. If filter is 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.

        Parameters:
        path - path to the directory
        filter - the filter expression
        Returns:
        a future notified on completion

      • readFile

        public Single<Buffer> readFile​(String path)
        Reads the entire file as represented by the path path as a , asynchronously.

        Do not use this method to read very large files or you risk running out of available RAM.

        Parameters:
        path - path to the file
        Returns:
        a future notified on completion

      • rxReadFile

        public Single<Buffer> rxReadFile​(String path)
        Reads the entire file as represented by the path path as a , asynchronously.

        Do not use this method to read very large files or you risk running out of available RAM.

        Parameters:
        path - path to the file
        Returns:
        a future notified on completion

      • writeFile

        public Completable writeFile​(String path,
                             Buffer data)
        Creates the file, and writes the specified Buffer data to the file represented by the path path, asynchronously.
        Parameters:
        path - path to the file
        data -
        Returns:
        a future notified on completion

      • rxWriteFile

        public Completable rxWriteFile​(String path,
                               Buffer data)
        Creates the file, and writes the specified Buffer data to the file represented by the path path, asynchronously.
        Parameters:
        path - path to the file
        data -
        Returns:
        a future notified on completion

      • open

        public Single<AsyncFile> open​(String path,
                              OpenOptions options)
        Open the file represented by path, asynchronously.

        The file is opened for both reading and writing. If the file does not already exist it will be created.

        Parameters:
        path - path to the file
        options - options describing how the file should be opened
        Returns:
        a future notified on completion

      • rxOpen

        public Single<AsyncFile> rxOpen​(String path,
                                OpenOptions options)
        Open the file represented by path, asynchronously.

        The file is opened for both reading and writing. If the file does not already exist it will be created.

        Parameters:
        path - path to the file
        options - options describing how the file should be opened
        Returns:
        a future notified on completion

      • createFile

        public Completable createFile​(String path)
        Creates an empty file with the specified path, asynchronously.
        Parameters:
        path - path to the file
        Returns:
        a future notified on completion

      • rxCreateFile

        public Completable rxCreateFile​(String path)
        Creates an empty file with the specified path, asynchronously.
        Parameters:
        path - path to the file
        Returns:
        a future notified on completion

      • createFile

        public Completable createFile​(String path,
                              String perms)
        Creates an empty file with the specified path and permissions perms, asynchronously.
        Parameters:
        path - path to the file
        perms - the permissions string
        Returns:
        a future notified on completion

      • rxCreateFile

        public Completable rxCreateFile​(String path,
                                String perms)
        Creates an empty file with the specified path and permissions perms, asynchronously.
        Parameters:
        path - path to the file
        perms - the permissions string
        Returns:
        a future notified on completion

      • exists

        public Single<Boolean> exists​(String path)
        Determines whether the file as specified by the path path exists, asynchronously.
        Parameters:
        path - path to the file
        Returns:
        a future notified on completion

      • rxExists

        public Single<Boolean> rxExists​(String path)
        Determines whether the file as specified by the path path exists, asynchronously.
        Parameters:
        path - path to the file
        Returns:
        a future notified on completion

      • fsProps

        public Single<FileSystemProps> fsProps​(String path)
        Returns properties of the file-system being used by the specified path, asynchronously.
        Parameters:
        path - path to anywhere on the filesystem
        Returns:
        a future notified on completion

      • rxFsProps

        public Single<FileSystemProps> rxFsProps​(String path)
        Returns properties of the file-system being used by the specified path, asynchronously.
        Parameters:
        path - path to anywhere on the filesystem
        Returns:
        a future notified on completion

      • createTempDirectory

        public Single<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.createTempFile methods, this method is only part of a temporary-file facility.A Runtime, or the File mechanism may be used to delete the directory automatically.

        Parameters:
        prefix - the prefix string to be used in generating the directory's name; may be null
        Returns:
        a future notified on completion

      • rxCreateTempDirectory

        public Single<String> rxCreateTempDirectory​(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.createTempFile methods, this method is only part of a temporary-file facility.A Runtime, or the File mechanism may be used to delete the directory automatically.

        Parameters:
        prefix - the prefix string to be used in generating the directory's name; may be null
        Returns:
        a future notified on completion

      • createTempDirectory

        public Single<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 perms.

        The permission String takes the form rwxr-x--- as specified in here.

        As with the File.createTempFile methods, this method is only part of a temporary-file facility.A Runtime, or the File mechanism may be used to delete the directory automatically.

        Parameters:
        prefix - the prefix string to be used in generating the directory's name; may be null
        perms - the permissions string
        Returns:
        a future notified on completion

      • rxCreateTempDirectory

        public Single<String> rxCreateTempDirectory​(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 perms.

        The permission String takes the form rwxr-x--- as specified in here.

        As with the File.createTempFile methods, this method is only part of a temporary-file facility.A Runtime, or the File mechanism may be used to delete the directory automatically.

        Parameters:
        prefix - the prefix string to be used in generating the directory's name; may be null
        perms - the permissions string
        Returns:
        a future notified on completion

      • createTempDirectory

        public Single<String> createTempDirectory​(String dir,
                                          String prefix,
                                          String perms)
        Creates a new directory in the directory provided by the path path, using the given prefix to generate its name, 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.

        As with the File.createTempFile methods, this method is only part of a temporary-file facility.A Runtime, or the File mechanism may be used to delete the directory automatically.

        Parameters:
        dir - the path to directory in which to create the directory
        prefix - the prefix string to be used in generating the directory's name; may be null
        perms - the permissions string
        Returns:
        a future notified on completion

      • rxCreateTempDirectory

        public Single<String> rxCreateTempDirectory​(String dir,
                                            String prefix,
                                            String perms)
        Creates a new directory in the directory provided by the path path, using the given prefix to generate its name, 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.

        As with the File.createTempFile methods, this method is only part of a temporary-file facility.A Runtime, or the File mechanism may be used to delete the directory automatically.

        Parameters:
        dir - the path to directory in which to create the directory
        prefix - the prefix string to be used in generating the directory's name; may be null
        perms - the permissions string
        Returns:
        a future notified on completion

      • createTempFile

        public Single<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.createTempFile methods, this method is only part of a temporary-file facility.A Runtime, or the File mechanism may be used to delete the directory automatically.

        Parameters:
        prefix - the prefix string to be used in generating the directory's name; may be null
        suffix - the suffix string to be used in generating the file's name; may be null, in which case ".tmp" is used
        Returns:
        a future notified on completion

      • rxCreateTempFile

        public Single<String> rxCreateTempFile​(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.createTempFile methods, this method is only part of a temporary-file facility.A Runtime, or the File mechanism may be used to delete the directory automatically.

        Parameters:
        prefix - the prefix string to be used in generating the directory's name; may be null
        suffix - the suffix string to be used in generating the file's name; may be null, in which case ".tmp" is used
        Returns:
        a future notified on completion

      • createTempFile

        public Single<String> createTempFile​(String prefix,
                                     String suffix,
                                     String perms)
        Creates a new file in the directory provided by the path dir, using the given prefix and suffix to generate its name, asynchronously.

        As with the File.createTempFile methods, this method is only part of a temporary-file facility.A Runtime, or the File mechanism may be used to delete the directory automatically.

        Parameters:
        prefix - the prefix string to be used in generating the directory's name; may be null
        suffix - the suffix string to be used in generating the file's name; may be null, in which case ".tmp" is used
        perms -
        Returns:
        a future notified on completion

      • rxCreateTempFile

        public Single<String> rxCreateTempFile​(String prefix,
                                       String suffix,
                                       String perms)
        Creates a new file in the directory provided by the path dir, using the given prefix and suffix to generate its name, asynchronously.

        As with the File.createTempFile methods, this method is only part of a temporary-file facility.A Runtime, or the File mechanism may be used to delete the directory automatically.

        Parameters:
        prefix - the prefix string to be used in generating the directory's name; may be null
        suffix - the suffix string to be used in generating the file's name; may be null, in which case ".tmp" is used
        perms -
        Returns:
        a future notified on completion

      • createTempFile

        public Single<String> createTempFile​(String dir,
                                     String prefix,
                                     String suffix,
                                     String perms)
        Creates a new file in the directory provided by the path dir, using the given prefix and suffix to generate its name, 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.

        As with the File.createTempFile methods, this method is only part of a temporary-file facility.A Runtime, or the File mechanism may be used to delete the directory automatically.

        Parameters:
        dir - the path to directory in which to create the directory
        prefix - the prefix string to be used in generating the directory's name; may be null
        suffix - the suffix string to be used in generating the file's name; may be null, in which case ".tmp" is used
        perms - the permissions string
        Returns:
        a future notified on completion

      • rxCreateTempFile

        public Single<String> rxCreateTempFile​(String dir,
                                       String prefix,
                                       String suffix,
                                       String perms)
        Creates a new file in the directory provided by the path dir, using the given prefix and suffix to generate its name, 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.

        As with the File.createTempFile methods, this method is only part of a temporary-file facility.A Runtime, or the File mechanism may be used to delete the directory automatically.

        Parameters:
        dir - the path to directory in which to create the directory
        prefix - the prefix string to be used in generating the directory's name; may be null
        suffix - the suffix string to be used in generating the file's name; may be null, in which case ".tmp" is used
        perms - the permissions string
        Returns:
        a future notified on completion