Google Git
Sign in
dart / external / github.com / google / file.dart / f289ad5967515ff8a26012de5d5cc996e5619808
commitf289ad5967515ff8a26012de5d5cc996e5619808[log] [tgz]
authorTodd Volkert <tvolkert@users.noreply.github.com>Tue Dec 13 13:43:07 2016 -0800
committerGitHub <noreply@github.com>Tue Dec 13 13:43:07 2016 -0800
tree0eb4b907ec3f57ce0a6175ee42eedebf53305743
parent653c2fdc996ba31f35c0e1dbfb0eb53959aab408 [diff]
Move memory tests to common tests. (#17)

Move memory tests to common tests.

This change prepares us to be able to run all file system
tests against multiple implementations of the interface.
The goal is to be able to test the local file system impl
against all tests, and run the exact same tests against
the in-memory impl, thus ensuring (a) the in-memory impl
has test coverage, and (b) that it behaves identical in
its API to the local dart:io variant.

This change does not touch any code - just restructures
things.
2 files changed
tree: 0eb4b907ec3f57ce0a6175ee42eedebf53305743
  1. contrib/
  2. lib/
  3. test/
  4. tool/
  5. .analysis_options
  6. .gitignore
  7. .travis.yml
  8. CHANGELOG.md
  9. LICENSE
  10. pubspec.yaml
  11. README.md
README.md

Build Status Coverage Status

File

A generic file system abstraction for Dart.

This package is currently experimental and subject to change

Like dart:io, package:file supplies a rich Dart-idiomatic API for accessing a file system.

Unlike dart:io, package:file:

  • Does not mix synchronous and asynchronous API in one. It is up to users to choose one, the other, or both.
  • Has explicit factory classes for different implementations.
  • Can be used to implement custom file systems.
  • Comes with in-memory implementation out-of-the-box, making it super-easy to test code that works with the file system.
  • Allows using multiple file systems simultaneously. A file system is a first-class object. Instantiate however many you want and use them all.

Usage

Implement your own custom file system:

import 'package:file/file.dart';

class FooBarFileSystem implements FileSystem { ... }

Use the in-memory file system:

import 'package:file/file.dart';

var fs = new InMemoryFileSystem();

Use the local file system (requires dart:io access):

import 'package:file/io.dart';

var fs = const LocalFileSystem();

The synchronous counterparts can be imported from:

// API and in-memory implementation
import `package:file/sync.dart`;
// Implementation based on "dart:io"
import `package:file/sync_io.dart`;