StoreDirectory class

Access point to a store

Contains access to:

  • Statistics
  • Management
  • Low-Level Access (advanced)

A store is identified by it's validated store name (see FMTCSettings.filesystemSanitiser - an error is throw if the name is invalid), and represents a directory that resides within a RootDirectory. Each store contains multiple sub-directories.

Constructors

StoreDirectory(RootDirectory rootDirectory, String storeName, {bool autoCreate = true})
Creates an access point to a store

Properties

access StoreAccess
Get direct filesystem access paths for this store
no setter
download DownloadManagement
Get tools to manage bulk downloading to this store
no setter
export StoreExport
Provides export functionality for this store
no setter
hashCode int
The hash code for this object.
no setteroverride
manage StoreManagement
Manage this store's representation on the filesystem
no setter
metadata → StoreMetadata
Manage custom miscellaneous information tied to this store
no setter
rootDirectory RootDirectory
The container for all files used within this library
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
stats StoreStats
Get statistics about this store
no setter
storeName String
The user-friendly name of the store directory
final

Methods

copyWith({RootDirectory? rootDirectory, String? storeName}) StoreDirectory
getTileProvider([FMTCTileProviderSettings? settings]) FMTCTileProvider
Get 'flutter_map_tile_caching's custom TileProvider for use in a TileLayerOptions, specific to this store
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
override