FishFood.Data.CommandOptions

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.

Types

Type-synonyms

type BinSizeDelta ratio = Either (Maybe FileSize) ratio

Either an arithmetic size-increase for which there's a default, or a geometric size-ratio.

Data-types

data CommandOptions ratio

Declares a record to contain command-line options.

Instances

Show ratio => Show (CommandOptions ratio)

Defined in FishFood.Data.CommandOptions

Methods

showsPrec :: Int -> CommandOptions ratio -> ShowS

show :: CommandOptions ratio -> String

showList :: [CommandOptions ratio] -> ShowS

Default (CommandOptions ratio)

Defined in FishFood.Data.CommandOptions

Methods

def :: CommandOptions ratio

(Num ratio, Ord ratio, Show ratio) => SelfValidator (CommandOptions ratio)

Defined in FishFood.Data.CommandOptions

Methods

getErrors :: CommandOptions ratio -> [String]

isValid :: CommandOptions ratio -> Bool

Functions

Constructor

mkCommandOptions :: (Num ratio, Ord ratio, Show ratio) => BinSizeDelta ratio -> Bool -> Int -> Verbosity -> CommandOptions ratio

Smart constructor.

Mutators

setBinSizeIncrement :: FileSize -> CommandOptions ratio -> CommandOptions ratio

Mutator.

setBinSizeRatio :: ratio -> CommandOptions ratio -> CommandOptions ratio

Mutator.