fs_browser library

File systems on IndexedDB in the browser (fileSystemWeb, fileSystemWebNoPaging, getFileSystemWeb, newFileSystemWeb), web only: reading them on io throws UnimplementedError.

Classes

Directory
A reference to a directory on the file system.
File
A reference to a file on the file system.
FileMode
The mode in which a file is opened.
FileSink
A sink for writing to a file.
FileStat
Information about a file system object.
FileStreamSink
File streaming sink.
FileSystem
A file system: creates the File, Directory and Link entities of a path (file, directory, link) and tells the type of a path (type, isFile, isDirectory, isLink).
FileSystemEntity
A reference to an entity on the file system, such as a file or directory.
FileSystemEntityParent
Entity or FileSystem
FileSystemEntityType
The type of an entity on the file system, such as a file, directory, or link.
FileSystemIdbOptions
Idb file system options.
FsShimSandboxedFileSystem
A file system that is sandboxed to a specific directory.
A reference to a link on the file system.
OSError
An error from the operating system.
RandomAccessFile
Random access to the data in a file.

Extensions

FileSystemIdbExt on FileSystem
Web specific extesion
FileSystemIdbOptionsExt on FileSystemIdbOptions
Extension representing FileSystemIdbOptionsExt.
FsShimDirectoryExtension on Directory
Common extension helpers
FsShimFileExtension on File
File extension.
FsShimFileSystemExtension on FileSystem
File system extension.

Properties

fileSystemIdb → FileSystem
The default browser file system on top of IndexedDB.
no setter
fileSystemWeb → FileSystem
Web file system on top of IndexedDB (database lfs.db), the default file system on the web.
no setter
fileSystemWebNoPaging → FileSystem
fileSystemWeb without pages (the same database lfs.db): each file in one record, as fileSystemWeb did up to fs_shim 2.7.
no setter

Functions

getFileSystemWeb({FileSystemIdbOptions? options}) → FileSystem
Web file system (database lfs.db) with options: fileSystemWeb if options is null, fileSystemWebNoPaging without page size.
newFileSystemIdb(IdbFactory idbFactory, [String? dbPath]) → FileSystem
Idb implementation (base for memory and browser)
newFileSystemWeb({required String name, FileSystemIdbOptions? options}) → FileSystem
Create a new web file system with some options (if options is null, 256 KiB pages, as fileSystemWeb).
newIdbFileSystem(IdbFactory idbFactory, [String? name]) → FileSystem
Prefer newFileSystemIdb

Exceptions / Errors

FileSystemException
An exception holding information about a file system error.