Warning

Experimental. Expect breaking changes and don't use it in production.

bull_fs

Unified file system APIs for Dart IO, Android SAF, and iOS / macOS NSFileCoordinator (mostly for iCloud access).

Usage

BFEnv

BFEnv is the core type of this package. Each supported platform has its own implementation of BFEnv. This class defines a set of common file-system APIs. There are 3 implementations:

• BFLocalEnv: Dart IO.
• BFSafEnv: Android Storage Access Framework (SAF).
• BFNsfcEnv: iOS / macOS NSFileCoordinator (mostly for iCloud access).

Below is a good summary of what to use on different platforms:

Platform	Which BFEnv to use
iOS	Use BFNsfcEnv if you need access to user-selected folders or files
Android	Use BFSafEnv if you need SAF access.
macOS	Use BFNsfcEnv for iCloud folders and BFLocalEnv for others.
Windows / Linux	Use BFLocalEnv

BFPath

Due to platform differences. Platform paths are represented by BFPath instead of String. It can be the following types:

• BFLocalPath: a path used in BFLocalEnv. e.g /path/to/file.
• BFScopedPath: a scoped path.
  • When used with BFSafEnv, it's a URI. e.g content://com.android.externalstorage.documents/document/primary:Download/file.txt.
  • When used with BFNsfcEnv, it's an iOS / macOS file URL. e.g. file:///path/to/file.

APIs

• List directory content:
  • list: Lists sub-directories and files in a directory.
  • listDirContentFiles: a platform optimized version of list that only lists files recursively.
• Get stats:
  • stat: Gets file or directory info.
  • child: Gets a child file or directory.
  • fileExists: Checks if a file exists.
  • directoryExists: Checks if a directory exists.
• Read / write files:
  • With local files:
    • copyToLocalFile: Copies a [BFPath] to a local file.
    • pasteLocalFile: Copies a local file to a [BFPath].
  • With streams:
    • readFileStream: Reads a file as a stream.
    • writeFileStream: Writes a stream to a file.
  • With Uint8List:
    • readFileBytes: Reads a file as a Uint8List.
    • writeFileBytes: Writes a Uint8List to a file.
• Create directories:
  • mkdirp: Creates directories recursively.
  • createDir: Creates a directory. Unlike mkdirp, it always creates a new directory.
• Delete / rename / move files or directories:
  • delete: Deletes a file or directory.
  • rename: Renames a file or directory.
  • moveToDir: Moves a file or directory to another directory.

Examples

Clone this repo and run example project. Click example button. You can see how a single set of APIs work on different platforms.

iOS	Android	macOS

Tests

bull_fs tests can run on device. To run tests, run example project and click tests button.