Using Roots & Stores

Base Chains

Once you can access FMTC.instance, you can chain on other methods to use the majority of this library's functionality. These are the base chains you will need:

Root

To get the Root and it's associated information, just chain on rootDirectory, as so:

final root = FMTC.instance.rootDirectory;

Store - Manual Creation

To use a Store without automatically creating it (recommended for performance), use () (call()). Place the store name inside the parenthesis. For example:

final store = FMTC.instance('storeName');
await store.manage.createAsync(); // Create the store if necessary

All examples in this documentation will use this method of accessing Stores, assuming that they are already ready.

Store - Automatic Creation

To use a Store and automatically synchronously create it if it doesn't exist, use []. Place the store name inside the parenthesis. For example:

final store = FMTC.instance['storeName'];

This is not recommended, as it uses synchronous IO operations on every get, which can block your application's main thread.

Only use this if you cannot use asynchronous techniques in your current context, or the slight blocking doesn't matter.

Extra Chains

After this, you can chain any of the following members/accessors (each will be accessible on a Root, a Store, or both):

Many of the symbols one level beneath the ones listed here, for example those under manage, have asynchronous versions which are recommended for performance.

To use them, if available, just add 'Async' to the end of the symbol. For example, manage.ready and manage.readyAsync.

pageflutter_map Integration

access

RootsStores

Access the underlying file/directory structure as standard 'dart:io' objects (advanced)

manage

RootsStores

Modify and control the structure itself, such as creation and deletion operations

stats

RootsStores

Retrieve statistics about a structure, such as size and length

recovery

Roots

Recover failed bulk downloads, and prepare them to restart

migrator

Roots

Migrate the incompatible file/directory structure of a root from a previous version of FMTC to a newer version

import

Roots

Import and prepare a store from a previously exported archive file

download

Stores

Prepare, start, and manage a store's bulk downloads

metadata

Stores

A simple key-value pair store designed for storing simple, store related information

export

Stores

Export a store to an archive file, for future importing

If you receive warnings in your IDE about using internal members outside its package, you should use the chains listed above instead of directly using the indicated object.