implicit final class VertxFileSystemOps extends AnyVal
- Alphabetic
- By Inheritance
- VertxFileSystemOps
- AnyVal
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new VertxFileSystemOps(target: FileSystem)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- Any
-
final
def
##(): Int
- Definition Classes
- Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
chmodL(path: String, perms: String): Task[Unit]
Change the permissions on the file represented by
path
toperms
, asynchronously.Change the permissions on the file represented by
path
toperms
, asynchronously.The permission String takes the form rwxr-x--- as specified here.
- path
the path to the file
- perms
the permissions string
- returns
a reference to this, so the API can be used fluently
-
def
chmodRecursiveL(path: String, perms: String, dirPerms: String): Task[Unit]
Change the permissions on the file represented by
path
toperms
, asynchronously.Change the permissions on the file represented by
path
toperms
, 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
.- path
the path to the file
- perms
the permissions string
- dirPerms
the directory permissions
- returns
a reference to this, so the API can be used fluently
-
def
chownL(path: String, user: String, group: String): Task[Unit]
Change the ownership on the file represented by
path
touser
and {code group}, asynchronously.Change the ownership on the file represented by
path
touser
and {code group}, asynchronously.- 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 reference to this, so the API can be used fluently
-
def
copyL(from: String, to: String, options: CopyOptions): Task[Unit]
Copy a file from the path
from
to pathto
, asynchronously.Copy a file from the path
from
to pathto
, asynchronously.- from
the path to copy from
- to
the path to copy to
- options
options describing how the file should be copied
- returns
a reference to this, so the API can be used fluently
-
def
copyL(from: String, to: String): Task[Unit]
Copy a file from the path
from
to pathto
, asynchronously.Copy a file from the path
from
to pathto
, asynchronously.The copy will fail if the destination already exists.
- from
the path to copy from
- to
the path to copy to
- returns
a reference to this, so the API can be used fluently
-
def
copyRecursiveL(from: String, to: String, recursive: Boolean): Task[Unit]
Copy a file from the path
from
to pathto
, asynchronously.Copy a file from the path
from
to pathto
, asynchronously.If
recursive
istrue
andfrom
represents 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.
- from
the path to copy from
- to
the path to copy to
- returns
a reference to this, so the API can be used fluently
-
def
createFileL(path: String, perms: String): Task[Unit]
Creates an empty file with the specified
path
and permissionsperms
, asynchronously.Creates an empty file with the specified
path
and permissionsperms
, asynchronously.- path
path to the file
- perms
the permissions string
- returns
a reference to this, so the API can be used fluently
-
def
createFileL(path: String): Task[Unit]
Creates an empty file with the specified
path
, asynchronously.Creates an empty file with the specified
path
, asynchronously.- path
path to the file
- returns
a reference to this, so the API can be used fluently
-
def
createTempDirectoryL(dir: String, prefix: String, perms: String): Task[String]
Creates a new directory in the directory provided by the path
path
, using the given prefix to generate its name, asynchronously.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.Ashutdown-hook
, or thejava.io.File#deleteOnExit
mechanism may be used to delete the directory automatically.- 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 reference to this, so the API can be used fluently
-
def
createTempDirectoryL(prefix: String, perms: String): Task[String]
Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.
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.Ashutdown-hook
, or thejava.io.File#deleteOnExit
mechanism may be used to delete the directory automatically.- prefix
the prefix string to be used in generating the directory's name; may be
null
- perms
the permissions string
- returns
a reference to this, so the API can be used fluently
-
def
createTempDirectoryL(prefix: String): Task[String]
Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.
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.Ashutdown-hook
, or thejava.io.File#deleteOnExit
mechanism may be used to delete the directory automatically.- prefix
the prefix string to be used in generating the directory's name; may be
null
- returns
a reference to this, so the API can be used fluently
-
def
createTempFileL(dir: String, prefix: String, suffix: String, perms: String): Task[String]
Creates a new file in the directory provided by the path
dir
, using the given prefix and suffix to generate its name, asynchronously.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.Ashutdown-hook
, or thejava.io.File#deleteOnExit
mechanism may be used to delete the directory automatically.- 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 reference to this, so the API can be used fluently
-
def
createTempFileL(prefix: String, suffix: String, perms: String): Task[String]
Creates a new file in the directory provided by the path
dir
, using the given prefix and suffix to generate its name, asynchronously.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.Ashutdown-hook
, or thejava.io.File#deleteOnExit
mechanism may be used to delete the directory automatically.- 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 reference to this, so the API can be used fluently
-
def
createTempFileL(prefix: String, suffix: String): Task[String]
Creates a new file in the default temporary-file directory, using the given prefix and suffix to generate its name, asynchronously.
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.Ashutdown-hook
, or thejava.io.File#deleteOnExit
mechanism may be used to delete the directory automatically.- 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 reference to this, so the API can be used fluently
-
def
deleteL(path: String): Task[Unit]
Deletes the file represented by the specified
path
, asynchronously.Deletes the file represented by the specified
path
, asynchronously.- path
path to the file
- returns
a reference to this, so the API can be used fluently
-
def
deleteRecursiveL(path: String, recursive: Boolean): Task[Unit]
Deletes the file represented by the specified
path
, asynchronously.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.- path
path to the file
- recursive
delete recursively?
- returns
a reference to this, so the API can be used fluently
-
def
existsL(path: String): Task[Boolean]
Determines whether the file as specified by the path
path
exists, asynchronously.Determines whether the file as specified by the path
path
exists, asynchronously.- path
path to the file
- returns
a reference to this, so the API can be used fluently
-
def
fsPropsL(path: String): Task[FileSystemProps]
Returns properties of the file-system being used by the specified
path
, asynchronously.Returns properties of the file-system being used by the specified
path
, asynchronously.- path
path to anywhere on the filesystem
- returns
a reference to this, so the API can be used fluently
-
def
getClass(): Class[_ <: AnyVal]
- Definition Classes
- AnyVal → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
linkL(link: String, existing: String): Task[Unit]
Create a hard link on the file system from
link
toexisting
, asynchronously.Create a hard link on the file system from
link
toexisting
, asynchronously.- link
the link
- existing
the link destination
- returns
a reference to this, so the API can be used fluently
-
def
lpropsL(path: String): Task[FileProps]
Obtain properties for the link represented by
path
, asynchronously.Obtain properties for the link represented by
path
, asynchronously.The link will not be followed.
- path
the path to the file
- returns
a reference to this, so the API can be used fluently
-
def
mkdirL(path: String, perms: String): Task[Unit]
Create the directory represented by
path
, asynchronously.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.
- path
path to the file
- perms
the permissions string
- returns
a reference to this, so the API can be used fluently
-
def
mkdirL(path: String): Task[Unit]
Create the directory represented by
path
, asynchronously.Create the directory represented by
path
, asynchronously.The operation will fail if the directory already exists.
- path
path to the file
- returns
a reference to this, so the API can be used fluently
-
def
mkdirsL(path: String, perms: String): Task[Unit]
Create the directory represented by
path
and any non existent parents, asynchronously.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.- path
path to the file
- perms
the permissions string
- returns
a reference to this, so the API can be used fluently
-
def
mkdirsL(path: String): Task[Unit]
Create the directory represented by
path
and any non existent parents, asynchronously.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.- path
path to the file
- returns
a reference to this, so the API can be used fluently
-
def
moveL(from: String, to: String, options: CopyOptions): Task[Unit]
Move a file from the path
from
to pathto
, asynchronously.Move a file from the path
from
to pathto
, asynchronously.- from
the path to copy from
- to
the path to copy to
- options
options describing how the file should be copied
- returns
a reference to this, so the API can be used fluently
-
def
moveL(from: String, to: String): Task[Unit]
Move a file from the path
from
to pathto
, asynchronously.Move a file from the path
from
to pathto
, asynchronously.The move will fail if the destination already exists.
- from
the path to copy from
- to
the path to copy to
- returns
a reference to this, so the API can be used fluently
-
def
openL(path: String, options: OpenOptions): Task[AsyncFile]
Open the file represented by
path
, asynchronously.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.
- path
path to the file
- options
options describing how the file should be opened
- returns
a reference to this, so the API can be used fluently
-
def
propsL(path: String): Task[FileProps]
Obtain properties for the file represented by
path
, asynchronously.Obtain properties for the file represented by
path
, asynchronously.If the file is a link, the link will be followed.
- path
the path to the file
- returns
a reference to this, so the API can be used fluently
-
def
readDirL(path: String, filter: String): Task[List[String]]
Read the contents of the directory specified by
path
, asynchronously.Read the contents of the directory specified by
path
, asynchronously.The parameter
filter
is a regular expression. Iffilter
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.
- path
path to the directory
- filter
the filter expression
- returns
a reference to this, so the API can be used fluently
-
def
readDirL(path: String): Task[List[String]]
Read the contents of the directory specified by
path
, asynchronously.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.
- path
path to the file
- returns
a reference to this, so the API can be used fluently
-
def
readFileL(path: String): Task[Buffer]
Reads the entire file as represented by the path
path
as aBuffer
, asynchronously.Reads the entire file as represented by the path
path
as aBuffer
, asynchronously.Do not use this method to read very large files or you risk running out of available RAM.
- path
path to the file
- returns
a reference to this, so the API can be used fluently
-
def
readSymlinkL(link: String): Task[String]
Returns the path representing the file that the symbolic link specified by
link
points to, asynchronously.Returns the path representing the file that the symbolic link specified by
link
points to, asynchronously.- link
the link
- returns
a reference to this, so the API can be used fluently
-
def
symlinkL(link: String, existing: String): Task[Unit]
Create a symbolic link on the file system from
link
toexisting
, asynchronously.Create a symbolic link on the file system from
link
toexisting
, asynchronously.- link
the link
- existing
the link destination
- returns
a reference to this, so the API can be used fluently
- val target: FileSystem
-
def
toString(): String
- Definition Classes
- Any
-
def
truncateL(path: String, len: Long): Task[Unit]
Truncate the file represented by
path
to lengthlen
in bytes, asynchronously.Truncate the file represented by
path
to lengthlen
in bytes, asynchronously.The operation will fail if the file does not exist or
len
is less thanzero
.- path
the path to the file
- len
the length to truncate it to
- returns
a reference to this, so the API can be used fluently
-
def
unlinkL(link: String): Task[Unit]
Unlinks the link on the file system represented by the path
link
, asynchronously.Unlinks the link on the file system represented by the path
link
, asynchronously.- link
the link
- returns
a reference to this, so the API can be used fluently
-
def
writeFileL(path: String, data: Buffer): Task[Unit]
Creates the file, and writes the specified
Buffer data
to the file represented by the pathpath
, asynchronously.Creates the file, and writes the specified
Buffer data
to the file represented by the pathpath
, asynchronously.- path
path to the file
- returns
a reference to this, so the API can be used fluently