Squeeze.Data.File

AUTHOR

Dr. Alistair Ward

DESCRIPTION

Defines file-related type-synonyms, and associated operations.

Types

Type-synonyms

type FilePathList = [FilePath]

A type suitable for containing an arbitrary set of file-paths.

type FileSize = Integer

A type-synonym specifically to hold file-sizes (in bytes).

type FileSizeAndPath = (FileSize, FilePath)

A type suitable for containing a file-path, qualified by the corresponding FileSize.

Functions

accumulateSize :: [FileSizeAndPath] -> [FileSize]

• Returns the cumulative sequence of sizes, as each file is prepended to the specified list.
• CAVEAT: the list-length is one greater than that supplied, since the last element represents the size with zero files.

aggregateSize :: [FileSizeAndPath] -> FileSize

Sum the FileSizes in the specified list.

findDuplicates :: FilePathList -> IO FilePathList

• Finds any file-paths which have been specified more than once.
• This includes files which have been implicitly specified via a directory.

findSizes :: FilePathList -> IO [FileSizeAndPath]

Finds file-sizes.

orderByIncreasingSize :: [FileSizeAndPath] -> [FileSizeAndPath]

Sorts a list of FileSizeAndPath by increasing size; ie. smallest first.

orderByDecreasingSize :: [FileSizeAndPath] -> [FileSizeAndPath]

Sorts a list of FileSizeAndPath by decreasing size; ie. smallest first.

getFileSizeStatistics

Arguments

:: (Fractional mean, Floating standardDeviation)

=> [FileSizeAndPath]

-> (Int, FileSize, mean, standardDeviation)

(Number of components, Aggregate size, Mean size, Standard-deviation).

Acquire statistics related to a list of files.

selectSuitableFileSizes :: (FileSize -> Bool) -> [FileSizeAndPath] -> Writer [String] [FileSizeAndPath]

• Partitions the specified list of file-sizes & paths, into those whose size is suitable according to the specified predicate & those which are unsuitable.
• Logs the results.

Accessors

getSize :: FileSizeAndPath -> FileSize

Accessor.

getPath :: FileSizeAndPath -> FilePath

Accessor.

Predicates

hasSizeBy

Arguments

:: (FileSize -> Bool)

The predicate.

-> FileSizeAndPath

The file-parameters to be tested.

-> Bool

True if the specified file has the required size according to the specified predicate.