File class abstract

Files are leaf Resources which contain data.

Implemented types

Constructors

File()

Properties

changes → Stream<WatchEvent>
Watch for changes to this file.
read-only
exists → bool
Return true if this resource exists.
read-onlyinherited
hashCode → int
The hash code for this object.
read-onlyinherited
lengthSync → int
Synchronously get the length of the file. Throws a FileSystemException if the operation fails.
read-only
modificationStamp → int
Return the last-modified stamp of the file. Throws a FileSystemException if the file does not exist.
read-only
parent → Folder
Return the Folder that contains this resource, possibly itself if this resource is a root folder.
read-onlyinherited
parent2 → Folder
Return the Folder that contains this resource, possibly itself if this resource is a root folder.
read-onlyinherited
path → String
Return the full path to this resource.
read-onlyinherited
provider → ResourceProvider
Return the ResourceProvider that owns this resource.
read-onlyinherited
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited
shortName → String
Return a short version of the name that can be displayed to the user to denote this resource.
read-onlyinherited

Methods

copyTo(Folder parentFolder) → File
Copy this resource to a child of the parentFolder with the same kind and shortName as this resource. If this resource is a folder, then all of the contents of the folder will be recursively copied.
override
createSource([Uri? uri]) → Source
Create a new Source instance that serves this file.
delete() → void
Synchronously deletes this resource and its children.
inherited
isOrContains(String path) → bool
Return true if absolute path references this resource or a resource in this folder.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
readAsBytesSync() → Uint8List
Synchronously read the entire file contents as a list of bytes. Throws a FileSystemException if the operation fails.
readAsStringSync() → String
Synchronously read the entire file contents as a String. Throws FileSystemException if the file does not exist.
renameSync(String newPath) → File
Synchronously rename this file. Return a File instance for the renamed file.
resolveSymbolicLinksSync() → Resource
Return a resource that refers to the same resource as this resource, but whose path does not contain any symbolic links.
inherited
toString() → String
A string representation of this object.
inherited
toUri() → Uri
Return a Uri representing this resource.
inherited
watch() → ResourceWatcher
Watch for changes to this file.
override
writeAsBytesSync(List<int> bytes) → void
Synchronously write the given bytes to the file. The new content will replace any existing content.
writeAsStringSync(String content) → void
Synchronously write the given content to the file. The new content will replace any existing content.

Operators

operator ==(Object other) → bool
The equality operator.
inherited