prepareDirectory property

Future<void> Function(PrepareDirectoryParams params) prepareDirectory
read / write

IMPORTANT: The following parameters below point to functions defined in the top-level, not within the inheriting class. They are meant to be defined in the constructor -- the actual functions to be executed are outside of the class, placed preferably at the bottom of the inheriting format class. This is because these functions should not block the UI isolate and must be top-level in order to do so. Given a File, prepare files to be accessible in a working Directory such that it will be possible to make relative commands (in the directory) to be able to get a dictionary's name, its entries and other related metadata that will be useful for preservation.

For many formats, this will likely be a ZIP extraction operation. A given parameter is where the final working directory should be, and where zthe rest of the operations will be performed.

See PrepareDirectoryParams for how to work with the individual input parameters.

Implementation

/// Given a [File], prepare files to be accessible in a working [Directory]
/// such that it will be possible to make relative commands (in the
/// directory) to be able to get a dictionary's name, its entries and
/// other related metadata that will be useful for preservation.
///
/// For many formats, this will likely be a ZIP extraction operation. A
/// given parameter is where the final working directory should be, and where
/// zthe rest of the operations will be performed.
///
/// See [PrepareDirectoryParams] for how to work with the individual input
/// parameters.
Future<void> Function(PrepareDirectoryParams params) prepareDirectory;