Link objects are references to filesystem links.

Inheritance

Properties

absolute Link
read-only

Returns a Link instance whose path is the absolute path to this.

isAbsolute bool
read-only, inherited

Returns a bool indicating whether this object's path is absolute.

parent Directory
read-only, inherited

The directory containing this. If this is a root directory, returns this.

path String
read-only, inherited

Constructors

Creates a Link object.

Link.fromUri(Uri uri)

Creates a Link object.

Methods

create(String target, {bool recursive: false}) → Future<Link>

Creates a symbolic link. Returns a Future<Link> that completes with the link when it has been created. If the link exists, the future will complete with an error.

createSync(String target, {bool recursive: false}) → void

Synchronously create the link. Calling createSync on an existing link will throw an exception.

delete({bool recursive: false}) → Future<FileSystemEntity>
inherited

Deletes this FileSystemEntity.

deleteSync({bool recursive: false}) → void
inherited

Synchronously deletes this FileSystemEntity.

exists() → Future<bool>
inherited

Checks whether the file system entity with this path exists. Returns a Future<bool> that completes with the result.

existsSync() → bool
inherited

Synchronously checks whether the file system entity with this path exists.

rename(String newPath) → Future<Link>

Renames this link. Returns a Future<Link> that completes with a Link instance for the renamed link.

renameSync(String newPath) → Link

Synchronously renames this link. Returns a Link instance for the renamed link.

Resolves the path of a file system object relative to the current working directory, resolving all symbolic links on the path and resolving all .. and . path segments.

resolveSymbolicLinksSync() → String

Resolves the path of a file system object relative to the current working directory, resolving all symbolic links on the path and resolving all .. and . path segments.

stat() → Future<FileStat>
inherited

Calls the operating system's stat() function on the path of this FileSystemEntity. Identical to FileStat.stat(this.path).

statSync() → FileStat
inherited

Synchronously calls the operating system's stat() function on the path of this FileSystemEntity. Identical to FileStat.statSync(this.path).

target() → Future<String>

Gets the target of the link. Returns a future that completes with the path to the target.

targetSync() → String

Synchronously gets the target of the link. Returns the path to the target.

update(String target) → Future<Link>

Updates the link. Returns a Future<Link> that completes with the link when it has been updated. Calling update on a non-existing link will complete its returned future with an exception.

updateSync(String target) → void

Synchronously updates the link. Calling updateSync on a non-existing link will throw an exception.

watch({int events: FileSystemEvent.ALL, bool recursive: false}) → Stream<FileSystemEvent>
inherited

Start watching the FileSystemEntity for changes.