Copyright	(c) 2015-2016 Peter Trško
License	BSD3
Maintainer	peter.trsko@gmail.com
Stability	experimental
Portability	BangPatterns (optional), CPP, DeriveDataTypeable (optional), DeriveGeneric (optional), NoImplicitPrelude, TemplateHaskell (optional)
Safe Haskell	Safe
Language	Haskell2010

Data.Verbosity

Description

Simple enum that encodes application Verbosity.

Synopsis

data Verbosity
- = Silent
- | Normal
- | Verbose
- | Annoying
increment :: Verbosity -> Maybe Verbosity
increment' :: Verbosity -> Verbosity
fromInt :: Int -> Maybe Verbosity
parse :: (Eq string, IsString string) => string -> Maybe Verbosity

Documentation

data Verbosity #

Ordering:

Silent < Normal < Verbose < Annoying

Bounds:

minBound = Silent; maxBound = Annoying

Enum:

map fromEnum [Silent .. Annoying] = [0, 1, 2, 3]

Constructors

Silent	Don't print any messages.
Normal	Print only important messages. (default)
Verbose	Print anything that comes in to mind.
Annoying	Print debugging/tracing information.

Instances

Bounded Verbosity #
Instance details Defined in Data.Verbosity Methods minBound :: Verbosity # maxBound :: Verbosity #
Enum Verbosity #
Instance details Defined in Data.Verbosity Methods succ :: Verbosity -> Verbosity # pred :: Verbosity -> Verbosity # toEnum :: Int -> Verbosity # fromEnum :: Verbosity -> Int # enumFrom :: Verbosity -> [Verbosity] # enumFromThen :: Verbosity -> Verbosity -> [Verbosity] # enumFromTo :: Verbosity -> Verbosity -> [Verbosity] # enumFromThenTo :: Verbosity -> Verbosity -> Verbosity -> [Verbosity] #
Eq Verbosity #
Instance details Defined in Data.Verbosity Methods (==) :: Verbosity -> Verbosity -> Bool # (/=) :: Verbosity -> Verbosity -> Bool #
Data Verbosity #
Instance details Defined in Data.Verbosity Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Verbosity -> c Verbosity # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Verbosity # toConstr :: Verbosity -> Constr # dataTypeOf :: Verbosity -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Verbosity) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Verbosity) # gmapT :: (forall b. Data b => b -> b) -> Verbosity -> Verbosity # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Verbosity -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Verbosity -> r # gmapQ :: (forall d. Data d => d -> u) -> Verbosity -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Verbosity -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Verbosity -> m Verbosity # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Verbosity -> m Verbosity # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Verbosity -> m Verbosity #
Ord Verbosity #
Instance details Defined in Data.Verbosity Methods compare :: Verbosity -> Verbosity -> Ordering # (<) :: Verbosity -> Verbosity -> Bool # (<=) :: Verbosity -> Verbosity -> Bool # (>) :: Verbosity -> Verbosity -> Bool # (>=) :: Verbosity -> Verbosity -> Bool # max :: Verbosity -> Verbosity -> Verbosity # min :: Verbosity -> Verbosity -> Verbosity #
Read Verbosity #
Instance details Defined in Data.Verbosity Methods readsPrec :: Int -> ReadS Verbosity # readList :: ReadS [Verbosity] # readPrec :: ReadPrec Verbosity # readListPrec :: ReadPrec [Verbosity] #
Show Verbosity #
Instance details Defined in Data.Verbosity Methods showsPrec :: Int -> Verbosity -> ShowS # show :: Verbosity -> String # showList :: [Verbosity] -> ShowS #
Generic Verbosity #
Instance details Defined in Data.Verbosity Associated Types type Rep Verbosity :: * -> * # Methods from :: Verbosity -> Rep Verbosity x # to :: Rep Verbosity x -> Verbosity #
Binary Verbosity #	Encoded as one byte in range `[minBound .. maxBound :: Verbosity]`.
Instance details Defined in Data.Verbosity Methods put :: Verbosity -> Put # get :: Get Verbosity # putList :: [Verbosity] -> Put #
Default Verbosity #	`def` = `Normal`
Instance details Defined in Data.Verbosity Methods def :: Verbosity #
NFData Verbosity #
Instance details Defined in Data.Verbosity Methods rnf :: Verbosity -> () #
HasVerbosity Verbosity #
Instance details Defined in Data.Verbosity.Class Methods verbosity :: Functor f => (Verbosity -> f Verbosity) -> Verbosity -> f Verbosity #
type Rep Verbosity #
Instance details Defined in Data.Verbosity type Rep Verbosity = D1 (MetaData "Verbosity" "Data.Verbosity" "verbosity-0.2.3.0-HgAnoWDIosa8mnl1GtvHyo" False) ((C1 (MetaCons "Silent" PrefixI False) (U1 :: * -> ) :+: C1 (MetaCons "Normal" PrefixI False) (U1 :: -> )) :+: (C1 (MetaCons "Verbose" PrefixI False) (U1 :: -> ) :+: C1 (MetaCons "Annoying" PrefixI False) (U1 :: -> *)))

increment :: Verbosity -> Maybe Verbosity #

Increment verbosity level. Return Nothing if trying to icrement beyond maxBound.

increment' :: Verbosity -> Verbosity #

Variant of increment that doesn't fail when maxBound is reached. It is defined as:

increment' v = fromMaybe v (increment v)

fromInt :: Int -> Maybe Verbosity #

Safe version of toEnum specialized to Verbosity.

parse :: (Eq string, IsString string) => string -> Maybe Verbosity #

Generic Verbosity parsing function.

Use case-insensitive package to make this function case insensitive:

ghci> import Data.Verbosity as Verbosity
ghci> import qualified Data.CaseInsensitive as CI (mk)
ghci> Verbosity.parse (CI.mk "silent")
Just Silent