File class
A reference to a file on the file system.
- Implemented types
- Implementers
Constructors
- File()
Properties
- absolute → File
-
Returns a File instance whose path is the absolute path to this. [...]
read-only, override
- basename → String
-
Gets the part of this entity's path after the last separator. [...]
read-only, inherited
- dirname → String
-
Gets the part of this entity's path before the last separator. [...]
read-only, inherited
- fileSystem → FileSystem
-
Returns the file system responsible for this entity.
read-only, inherited
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- isAbsolute → bool
-
Returns a bool indicating whether this object's path is absolute. [...]
read-only, inherited
- parent → Directory
-
The directory containing this.
read-only, inherited
- path → String
-
Get the path of the file.
read-only, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- uri → Uri
-
Returns a Uri representing the file system entity's location. [...]
read-only, inherited
Methods
-
copy(
String newPath) → Future< File> -
Copy this file. Returns a
Future<File>that completes with a File instance for the copied file. [...]override -
copySync(
String newPath) → File -
Synchronously copy this file. Returns a File
instance for the copied file. [...]
override
-
create(
{bool recursive: false }) → Future< File> -
Create the file. Returns a
Future<File>that completes with the file when it has been created. [...]override -
rename(
String newPath) → Future< File> -
Renames this file. Returns a
Future<File>that completes with a File instance for the renamed file. [...]override -
renameSync(
String newPath) → File -
Synchronously renames this file. Returns a File
instance for the renamed file. [...]
override
-
writeAsBytes(
List< int> bytes, { FileMode mode: io.FileMode.write, bool flush: false }) → Future< File> -
Write a list of bytes to a file. [...]
override
-
writeAsString(
String contents, { FileMode mode: io.FileMode.write, Encoding encoding: utf8, bool flush: false }) → Future< File> -
Write a string to a file. [...]
override
-
createSync(
{bool recursive: false }) → void -
Synchronously create the file. Existing files are left untouched
by createSync. Calling createSync on an existing file might fail
if there are restrictive permissions on the file. [...]
inherited
-
delete(
{bool recursive: false }) → Future< FileSystemEntity> -
Deletes this FileSystemEntity. [...]
inherited
-
deleteSync(
{bool recursive: false }) → void -
Synchronously deletes this FileSystemEntity. [...]
inherited
-
exists(
) → Future< bool> -
Checks whether the file system entity with this path exists. Returns
a
Future<bool>that completes with the result. [...]inherited -
existsSync(
) → bool -
Synchronously checks whether the file system entity with this path
exists. [...]
inherited
-
lastAccessed(
) → Future< DateTime> -
Get the last-accessed time of the file. [...]
inherited
-
lastAccessedSync(
) → DateTime -
Get the last-accessed time of the file. [...]
inherited
-
lastModified(
) → Future< DateTime> -
Get the last-modified time of the file. [...]
inherited
-
lastModifiedSync(
) → DateTime -
Get the last-modified time of the file. [...]
inherited
-
length(
) → Future< int> -
Get the length of the file. Returns a
Future<int>that completes with the length in bytes.inherited -
lengthSync(
) → int -
Synchronously get the length of the file. [...]
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
open(
{FileMode mode: FileMode.read }) → Future< RandomAccessFile> -
Open the file for random access operations. Returns a
Future<RandomAccessFile>that completes with the opened random access file. RandomAccessFiles must be closed using the RandomAccessFile.close method. [...]inherited -
openRead(
[int start, int end ]) → Stream< List< int>> -
Create a new independent Stream for the contents of this file. [...]
inherited
-
openSync(
{FileMode mode: FileMode.read }) → RandomAccessFile -
Synchronously open the file for random access operations. The
result is a RandomAccessFile on which random access operations
can be performed. Opened RandomAccessFiles must be closed using
the RandomAccessFile.close method. [...]
inherited
-
openWrite(
{FileMode mode: FileMode.write, Encoding encoding: utf8 }) → IOSink -
Creates a new independent IOSink for the file. The
IOSink must be closed when no longer used, to free
system resources. [...]
inherited
-
readAsBytes(
) → Future< List< int>> -
Read the entire file contents as a list of bytes. Returns a
Future<List<int>>that completes with the list of bytes that is the contents of the file.inherited -
readAsBytesSync(
) → List< int> -
Synchronously read the entire file contents as a list of bytes. [...]
inherited
-
readAsLines(
{Encoding encoding: utf8 }) → Future< List< String>> -
Read the entire file contents as lines of text using the given
Encoding. [...]
inherited
-
readAsLinesSync(
{Encoding encoding: utf8 }) → List< String> -
Synchronously read the entire file contents as lines of text
using the given Encoding. [...]
inherited
-
readAsString(
{Encoding encoding: utf8 }) → Future< String> -
Read the entire file contents as a string using the given
Encoding. [...]
inherited
-
readAsStringSync(
{Encoding encoding: utf8 }) → String -
Synchronously read the entire file contents as a string using the
given Encoding. [...]
inherited
-
resolveSymbolicLinks(
) → Future< String> -
Resolves the path of a file system object relative to the
current working directory. [...]
inherited
-
resolveSymbolicLinksSync(
) → String -
Resolves the path of a file system object relative to the
current working directory. [...]
inherited
-
setLastAccessed(
DateTime time) → Future -
Modifies the time the file was last accessed. [...]
inherited
-
setLastAccessedSync(
DateTime time) → void -
Synchronously modifies the time the file was last accessed. [...]
inherited
-
setLastModified(
DateTime time) → Future -
Modifies the time the file was last modified. [...]
inherited
-
setLastModifiedSync(
DateTime time) → void -
Synchronously modifies the time the file was last modified. [...]
inherited
-
stat(
) → Future< FileStat> -
Calls the operating system's stat() function on the path of this
FileSystemEntity. [...]
inherited
-
statSync(
) → FileStat -
Synchronously calls the operating system's stat() function on the
path of this FileSystemEntity. [...]
inherited
-
toString(
) → String -
Returns a string representation of this object.
inherited
-
watch(
{int events: FileSystemEvent.all, bool recursive: false }) → Stream< FileSystemEvent> -
Start watching the FileSystemEntity for changes. [...]
inherited
-
writeAsBytesSync(
List< int> bytes, { FileMode mode: FileMode.write, bool flush: false }) → void -
Synchronously write a list of bytes to a file. [...]
inherited
-
writeAsStringSync(
String contents, { FileMode mode: FileMode.write, Encoding encoding: utf8, bool flush: false }) → void -
Synchronously write a string to a file. [...]
inherited
Operators
-
operator ==(
dynamic other) → bool -
The equality operator. [...]
inherited