| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
FishFood.Data.CommandOptions
Description
AUTHOR- Dr. Alistair Ward
DESCRIPTION
- Defines options for program-operation.
- Defines an appropriate default value, which is expected to be over-ridden on the command-line.
- Self-validates.
- type BinSizeDelta ratio = Either (Maybe FileSize) ratio
- data CommandOptions ratio
- mkCommandOptions :: (Num ratio, Ord ratio, Show ratio) => BinSizeDelta ratio -> Bool -> Int -> Verbosity -> CommandOptions ratio
- setBinSizeIncrement :: FileSize -> CommandOptions ratio -> CommandOptions ratio
- setBinSizeRatio :: ratio -> CommandOptions ratio -> CommandOptions ratio
Types
Type-synonyms
type BinSizeDelta ratio = Either (Maybe FileSize) ratio Source
Either an arithmetic size-increase for which there's a default, or a geometric size-ratio.
Data-types
data CommandOptions ratio Source
Declares a record to contain command-line options.
Instances
| Show ratio => Show (CommandOptions ratio) Source | |
| Defaultable (CommandOptions ratio) Source | |
| (Num ratio, Ord ratio, Show ratio) => SelfValidator (CommandOptions ratio) Source |
Functions
Constructors
mkCommandOptions :: (Num ratio, Ord ratio, Show ratio) => BinSizeDelta ratio -> Bool -> Int -> Verbosity -> CommandOptions ratio Source
Smart constructor.
Mutators
setBinSizeIncrement :: FileSize -> CommandOptions ratio -> CommandOptions ratio Source
Mutator.
setBinSizeRatio :: ratio -> CommandOptions ratio -> CommandOptions ratio Source
Mutator.