Safe Haskell	None
Language	Haskell2010

Photoname.Common

Synopsis

newtype Artist = Artist String
newtype ConfigPath = ConfigPath FilePath
newtype CopySwitch = CopySwitch Bool
newtype DestPath = DestPath FilePath
data Links
- = Exactly CNlink
- | NoLimit
newtype MoveSwitch = MoveSwitch Bool
newtype NoActionSwitch = NoActionSwitch Bool
newtype NoDirsSwitch = NoDirsSwitch Bool
newtype ParentDir = ParentDir FilePath
data Options = Options {
- optArtist :: Maybe Artist
- optConfig :: Maybe ConfigPath
- optCopy :: CopySwitch
- optNoDirs :: NoDirsSwitch
- optLinks :: Links
- optMove :: MoveSwitch
- optNoAction :: NoActionSwitch
- optParentDir :: ParentDir
- optPrefix :: Prefix
- optSuffix :: Suffix
- optVerbosity :: Verbosity
- optPaths :: [FilePath]
}
type Ph a = ReaderT Options (ExceptT String IO) a
newtype Prefix = Prefix String
newtype SrcPath = SrcPath FilePath
newtype Suffix = Suffix String
data Verbosity
- = Quiet
- | Verbose Priority
readVerbosity :: String -> Either String Verbosity
runRename :: Options -> Ph a -> IO (Either String a)
class Monad m => MonadError e (m :: Type -> Type) | m -> e
ask :: MonadReader r m => m r
asks :: MonadReader r m => (r -> a) -> m a
liftIO :: MonadIO m => IO a -> m a
throwError :: MonadError e m => e -> m a

Documentation

newtype Artist Source #

Constructors

Artist String

newtype ConfigPath Source #

Constructors

ConfigPath FilePath

newtype CopySwitch Source #

Constructors

CopySwitch Bool

Instances

Instances details

Generic CopySwitch Source #
Instance details Defined in Photoname.Common Associated Types type Rep CopySwitch :: Type -> Type # Methods from :: CopySwitch -> Rep CopySwitch x # to :: Rep CopySwitch x -> CopySwitch #
Newtype CopySwitch Source #
Instance details Defined in Photoname.Common Associated Types type O CopySwitch # Methods pack :: O CopySwitch -> CopySwitch # unpack :: CopySwitch -> O CopySwitch #
type Rep CopySwitch Source #
Instance details Defined in Photoname.Common type Rep CopySwitch = D1 ('MetaData "CopySwitch" "Photoname.Common" "photoname-5.1-EjQUsg3myJgHw35JYZwQoB" 'True) (C1 ('MetaCons "CopySwitch" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))
type O CopySwitch Source #
Instance details Defined in Photoname.Common type O CopySwitch = GO (Rep CopySwitch)

newtype DestPath Source #

Constructors

DestPath FilePath

Instances

Instances details

Generic DestPath Source #
Instance details Defined in Photoname.Common Associated Types type Rep DestPath :: Type -> Type # Methods from :: DestPath -> Rep DestPath x # to :: Rep DestPath x -> DestPath #
Newtype DestPath Source #
Instance details Defined in Photoname.Common Associated Types type O DestPath # Methods pack :: O DestPath -> DestPath # unpack :: DestPath -> O DestPath #
type Rep DestPath Source #
Instance details Defined in Photoname.Common type Rep DestPath = D1 ('MetaData "DestPath" "Photoname.Common" "photoname-5.1-EjQUsg3myJgHw35JYZwQoB" 'True) (C1 ('MetaCons "DestPath" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))
type O DestPath Source #
Instance details Defined in Photoname.Common type O DestPath = GO (Rep DestPath)

data Links Source #

Constructors

Exactly CNlink
NoLimit

newtype MoveSwitch Source #

Constructors

MoveSwitch Bool

Instances

Instances details

Generic MoveSwitch Source #
Instance details Defined in Photoname.Common Associated Types type Rep MoveSwitch :: Type -> Type # Methods from :: MoveSwitch -> Rep MoveSwitch x # to :: Rep MoveSwitch x -> MoveSwitch #
Newtype MoveSwitch Source #
Instance details Defined in Photoname.Common Associated Types type O MoveSwitch # Methods pack :: O MoveSwitch -> MoveSwitch # unpack :: MoveSwitch -> O MoveSwitch #
type Rep MoveSwitch Source #
Instance details Defined in Photoname.Common type Rep MoveSwitch = D1 ('MetaData "MoveSwitch" "Photoname.Common" "photoname-5.1-EjQUsg3myJgHw35JYZwQoB" 'True) (C1 ('MetaCons "MoveSwitch" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))
type O MoveSwitch Source #
Instance details Defined in Photoname.Common type O MoveSwitch = GO (Rep MoveSwitch)

newtype NoActionSwitch Source #

Constructors

NoActionSwitch Bool

Instances

Instances details

Generic NoActionSwitch Source #
Instance details Defined in Photoname.Common Associated Types type Rep NoActionSwitch :: Type -> Type # Methods from :: NoActionSwitch -> Rep NoActionSwitch x # to :: Rep NoActionSwitch x -> NoActionSwitch #
Newtype NoActionSwitch Source #
Instance details Defined in Photoname.Common Associated Types type O NoActionSwitch # Methods pack :: O NoActionSwitch -> NoActionSwitch # unpack :: NoActionSwitch -> O NoActionSwitch #
type Rep NoActionSwitch Source #
Instance details Defined in Photoname.Common type Rep NoActionSwitch = D1 ('MetaData "NoActionSwitch" "Photoname.Common" "photoname-5.1-EjQUsg3myJgHw35JYZwQoB" 'True) (C1 ('MetaCons "NoActionSwitch" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))
type O NoActionSwitch Source #
Instance details Defined in Photoname.Common type O NoActionSwitch = GO (Rep NoActionSwitch)

newtype NoDirsSwitch Source #

Constructors

NoDirsSwitch Bool

Instances

Instances details

Generic NoDirsSwitch Source #
Instance details Defined in Photoname.Common Associated Types type Rep NoDirsSwitch :: Type -> Type # Methods from :: NoDirsSwitch -> Rep NoDirsSwitch x # to :: Rep NoDirsSwitch x -> NoDirsSwitch #
Newtype NoDirsSwitch Source #
Instance details Defined in Photoname.Common Associated Types type O NoDirsSwitch # Methods pack :: O NoDirsSwitch -> NoDirsSwitch # unpack :: NoDirsSwitch -> O NoDirsSwitch #
type Rep NoDirsSwitch Source #
Instance details Defined in Photoname.Common type Rep NoDirsSwitch = D1 ('MetaData "NoDirsSwitch" "Photoname.Common" "photoname-5.1-EjQUsg3myJgHw35JYZwQoB" 'True) (C1 ('MetaCons "NoDirsSwitch" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))
type O NoDirsSwitch Source #
Instance details Defined in Photoname.Common type O NoDirsSwitch = GO (Rep NoDirsSwitch)

newtype ParentDir Source #

Constructors

ParentDir FilePath

Instances

Instances details

Generic ParentDir Source #
Instance details Defined in Photoname.Common Associated Types type Rep ParentDir :: Type -> Type # Methods from :: ParentDir -> Rep ParentDir x # to :: Rep ParentDir x -> ParentDir #
Newtype ParentDir Source #
Instance details Defined in Photoname.Common Associated Types type O ParentDir # Methods pack :: O ParentDir -> ParentDir # unpack :: ParentDir -> O ParentDir #
type Rep ParentDir Source #
Instance details Defined in Photoname.Common type Rep ParentDir = D1 ('MetaData "ParentDir" "Photoname.Common" "photoname-5.1-EjQUsg3myJgHw35JYZwQoB" 'True) (C1 ('MetaCons "ParentDir" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))
type O ParentDir Source #
Instance details Defined in Photoname.Common type O ParentDir = GO (Rep ParentDir)

data Options Source #

Constructors

Options
Fields optArtist :: Maybe Artist optConfig :: Maybe ConfigPath optCopy :: CopySwitch optNoDirs :: NoDirsSwitch optLinks :: Links optMove :: MoveSwitch optNoAction :: NoActionSwitch optParentDir :: ParentDir optPrefix :: Prefix optSuffix :: Suffix optVerbosity :: Verbosity optPaths :: [FilePath]

type Ph a = ReaderT Options (ExceptT String IO) a Source #

newtype Prefix Source #

Constructors

Prefix String

Instances

Instances details

Generic Prefix Source #
Instance details Defined in Photoname.Common Associated Types type Rep Prefix :: Type -> Type # Methods from :: Prefix -> Rep Prefix x # to :: Rep Prefix x -> Prefix #
Newtype Prefix Source #
Instance details Defined in Photoname.Common Associated Types type O Prefix # Methods pack :: O Prefix -> Prefix # unpack :: Prefix -> O Prefix #
type Rep Prefix Source #
Instance details Defined in Photoname.Common type Rep Prefix = D1 ('MetaData "Prefix" "Photoname.Common" "photoname-5.1-EjQUsg3myJgHw35JYZwQoB" 'True) (C1 ('MetaCons "Prefix" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))
type O Prefix Source #
Instance details Defined in Photoname.Common type O Prefix = GO (Rep Prefix)

newtype SrcPath Source #

Constructors

SrcPath FilePath

Instances

Instances details

Generic SrcPath Source #
Instance details Defined in Photoname.Common Associated Types type Rep SrcPath :: Type -> Type # Methods from :: SrcPath -> Rep SrcPath x # to :: Rep SrcPath x -> SrcPath #
Newtype SrcPath Source #
Instance details Defined in Photoname.Common Associated Types type O SrcPath # Methods pack :: O SrcPath -> SrcPath # unpack :: SrcPath -> O SrcPath #
type Rep SrcPath Source #
Instance details Defined in Photoname.Common type Rep SrcPath = D1 ('MetaData "SrcPath" "Photoname.Common" "photoname-5.1-EjQUsg3myJgHw35JYZwQoB" 'True) (C1 ('MetaCons "SrcPath" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))
type O SrcPath Source #
Instance details Defined in Photoname.Common type O SrcPath = GO (Rep SrcPath)

newtype Suffix Source #

Constructors

Suffix String

Instances

Instances details

Generic Suffix Source #
Instance details Defined in Photoname.Common Associated Types type Rep Suffix :: Type -> Type # Methods from :: Suffix -> Rep Suffix x # to :: Rep Suffix x -> Suffix #
Newtype Suffix Source #
Instance details Defined in Photoname.Common Associated Types type O Suffix # Methods pack :: O Suffix -> Suffix # unpack :: Suffix -> O Suffix #
type Rep Suffix Source #
Instance details Defined in Photoname.Common type Rep Suffix = D1 ('MetaData "Suffix" "Photoname.Common" "photoname-5.1-EjQUsg3myJgHw35JYZwQoB" 'True) (C1 ('MetaCons "Suffix" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))
type O Suffix Source #
Instance details Defined in Photoname.Common type O Suffix = GO (Rep Suffix)

data Verbosity Source #

Constructors

Quiet
Verbose Priority

Instances

Instances details

Show Verbosity Source #
Instance details Defined in Photoname.Common Methods showsPrec :: Int -> Verbosity -> ShowS # show :: Verbosity -> String # showList :: [Verbosity] -> ShowS #

readVerbosity :: String -> Either String Verbosity Source #

runRename :: Options -> Ph a -> IO (Either String a) Source #

class Monad m => MonadError e (m :: Type -> Type) | m -> e #

The strategy of combining computations that can throw exceptions by bypassing bound functions from the point an exception is thrown to the point that it is handled.

Is parameterized over the type of error information and the monad type constructor. It is common to use Either String as the monad type constructor for an error monad in which error descriptions take the form of strings. In that case and many other common cases the resulting monad is already defined as an instance of the MonadError class. You can also define your own error type and/or use a monad type constructor other than Either String or Either IOError. In these cases you will have to explicitly define instances of the MonadError class. (If you are using the deprecated Control.Monad.Error or Control.Monad.Trans.Error, you may also have to define an Error instance.)

Minimal complete definition

throwError, catchError

Instances

Instances details

MonadError () Maybe	Since: mtl-2.2.2
Instance details Defined in Control.Monad.Error.Class Methods throwError :: () -> Maybe a # catchError :: Maybe a -> (() -> Maybe a) -> Maybe a #
MonadError IOException IO
Instance details Defined in Control.Monad.Error.Class Methods throwError :: IOException -> IO a # catchError :: IO a -> (IOException -> IO a) -> IO a #
MonadError e m => MonadError e (MaybeT m)
Instance details Defined in Control.Monad.Error.Class Methods throwError :: e -> MaybeT m a # catchError :: MaybeT m a -> (e -> MaybeT m a) -> MaybeT m a #
MonadError e m => MonadError e (ListT m)
Instance details Defined in Control.Monad.Error.Class Methods throwError :: e -> ListT m a # catchError :: ListT m a -> (e -> ListT m a) -> ListT m a #
MonadError e (Either e)
Instance details Defined in Control.Monad.Error.Class Methods throwError :: e -> Either e a # catchError :: Either e a -> (e -> Either e a) -> Either e a #
MonadError e m => MonadError e (ReaderT r m)
Instance details Defined in Control.Monad.Error.Class Methods throwError :: e -> ReaderT r m a # catchError :: ReaderT r m a -> (e -> ReaderT r m a) -> ReaderT r m a #
Monad m => MonadError e (ExceptT e m)	Since: mtl-2.2
Instance details Defined in Control.Monad.Error.Class Methods throwError :: e -> ExceptT e m a # catchError :: ExceptT e m a -> (e -> ExceptT e m a) -> ExceptT e m a #
(Monoid w, MonadError e m) => MonadError e (WriterT w m)
Instance details Defined in Control.Monad.Error.Class Methods throwError :: e -> WriterT w m a # catchError :: WriterT w m a -> (e -> WriterT w m a) -> WriterT w m a #
(Monoid w, MonadError e m) => MonadError e (WriterT w m)
Instance details Defined in Control.Monad.Error.Class Methods throwError :: e -> WriterT w m a # catchError :: WriterT w m a -> (e -> WriterT w m a) -> WriterT w m a #
MonadError e m => MonadError e (StateT s m)
Instance details Defined in Control.Monad.Error.Class Methods throwError :: e -> StateT s m a # catchError :: StateT s m a -> (e -> StateT s m a) -> StateT s m a #
MonadError e m => MonadError e (StateT s m)
Instance details Defined in Control.Monad.Error.Class Methods throwError :: e -> StateT s m a # catchError :: StateT s m a -> (e -> StateT s m a) -> StateT s m a #
MonadError e m => MonadError e (IdentityT m)
Instance details Defined in Control.Monad.Error.Class Methods throwError :: e -> IdentityT m a # catchError :: IdentityT m a -> (e -> IdentityT m a) -> IdentityT m a #
(Monad m, Error e) => MonadError e (ErrorT e m)
Instance details Defined in Control.Monad.Error.Class Methods throwError :: e -> ErrorT e m a # catchError :: ErrorT e m a -> (e -> ErrorT e m a) -> ErrorT e m a #
MonadError e m => MonadError e (ParsecT s u m)
Instance details Defined in Text.Parsec.Prim Methods throwError :: e -> ParsecT s u m a # catchError :: ParsecT s u m a -> (e -> ParsecT s u m a) -> ParsecT s u m a #
(Monoid w, MonadError e m) => MonadError e (RWST r w s m)
Instance details Defined in Control.Monad.Error.Class Methods throwError :: e -> RWST r w s m a # catchError :: RWST r w s m a -> (e -> RWST r w s m a) -> RWST r w s m a #
(Monoid w, MonadError e m) => MonadError e (RWST r w s m)
Instance details Defined in Control.Monad.Error.Class Methods throwError :: e -> RWST r w s m a # catchError :: RWST r w s m a -> (e -> RWST r w s m a) -> RWST r w s m a #

ask :: MonadReader r m => m r #

Retrieves the monad environment.

asks #

Arguments

:: MonadReader r m
=> (r -> a)	The selector function to apply to the environment.
-> m a

Retrieves a function of the current environment.

liftIO :: MonadIO m => IO a -> m a #

Lift a computation from the IO monad.

throwError :: MonadError e m => e -> m a #

Is used within a monadic computation to begin exception processing.