Vimeta.Core

Documentation

class Monad m => MonadIO (m :: * -> *) where

Monads in which IO computations may be embedded. Any monad built by applying a sequence of monad transformers to the IO monad will be an instance of this class.

Instances should satisfy the following laws, which state that liftIO is a transformer of monads:

• liftIO . return = return

• liftIO (m >>= f) = liftIO m >>= (liftIO . f)

Minimal complete definition

liftIO

Methods

liftIO :: IO a -> m a

Lift a computation from the IO monad.

Instances

MonadIO IO

Since: base-4.9.0.0

Defined in Control.Monad.IO.Class

Methods

liftIO :: IO a -> IO a

MonadIO TheMovieDB

Defined in Network.API.TheMovieDB.Internal.TheMovieDB

Methods

liftIO :: IO a -> TheMovieDB a

MonadIO m => MonadIO (Byline m)

Defined in System.Console.Byline.Internal.Byline

Methods

liftIO :: IO a -> Byline m a

MonadIO m => MonadIO (ResourceT m)

Defined in Control.Monad.Trans.Resource.Internal

Methods

liftIO :: IO a -> ResourceT m a

MonadIO m => MonadIO (PErrorT m)

Defined in Data.Yaml.Internal

Methods

liftIO :: IO a -> PErrorT m a

MonadIO m => MonadIO (Vimeta m)

Defined in Vimeta.Core.Vimeta

Methods

liftIO :: IO a -> Vimeta m a

MonadIO m => MonadIO (IdentityT m)

Defined in Control.Monad.Trans.Identity

Methods

liftIO :: IO a -> IdentityT m a

MonadIO m => MonadIO (ExceptT e m)

Defined in Control.Monad.Trans.Except

Methods

liftIO :: IO a -> ExceptT e m a

(Error e, MonadIO m) => MonadIO (ErrorT e m)

Defined in Control.Monad.Trans.Error

Methods

liftIO :: IO a -> ErrorT e m a

MonadIO m => MonadIO (ReaderT r m)

Defined in Control.Monad.Trans.Reader

Methods

liftIO :: IO a -> ReaderT r m a

MonadIO m => MonadIO (ConduitT i o m)

Defined in Data.Conduit.Internal.Conduit

Methods

liftIO :: IO a -> ConduitT i o m a

MonadIO m => MonadIO (ParsecT s u m)

Defined in Text.Parsec.Prim

Methods

liftIO :: IO a -> ParsecT s u m a

MonadIO m => MonadIO (Pipe l i o u m)

Defined in Data.Conduit.Internal.Pipe

Methods

liftIO :: IO a -> Pipe l i o u m a

asks

Arguments

:: MonadReader r m

=> (r -> a)

The selector function to apply to the environment.

-> m a

Retrieves a function of the current environment.

ask :: MonadReader r m => m r

Retrieves the monad environment.

type FormatTable = Map Char (Maybe Text)

Mapping of format characters to their possible replacement text.

fromFormatString

Arguments

:: FormatTable

Format character mapping.

-> String

Name of format string.

-> Text

Input text.

-> Either String Text

Output text or error.

Replace format characters prefixed with a % with the replacement text found in the given Map.

formatFullDate :: Maybe Day -> Maybe Text

Format a Day using the XML schema notation.

formatYear :: Maybe Day -> Maybe Text

Format a Day displaying just the year.

data Tagger

Constructors

AtomicParsley

formatStringsForTagger :: Tagger -> (Text, Text)

data Config

Vimeta configuration.

Constructors

Config

Fields

• configTMDBKey :: Key
• configFormatMovie :: Text
• configFormatTV :: Text
• configVerbose :: Bool
• configDryRun :: Bool

Instances

ToJSON Config

Defined in Vimeta.Core.Config

Methods

toJSON :: Config -> Value

toEncoding :: Config -> Encoding

toJSONList :: [Config] -> Value

toEncodingList :: [Config] -> Encoding

FromJSON Config

Defined in Vimeta.Core.Config

Methods

parseJSON :: Value -> Parser Config

parseJSONList :: Value -> Parser [Config]

defaultConfig :: Tagger -> Config

configFileName :: IO FilePath

Get the name of the configuration file.

readConfig :: MonadIO m => ExceptT String m Config

Read the configuration file and return a Config value or an error.

writeConfig :: MonadIO m => Config -> ExceptT String m FilePath

data Vimeta m a

Instances

Monad m => MonadReader Context (Vimeta m)

Defined in Vimeta.Core.Vimeta

Methods

ask :: Vimeta m Context

local :: (Context -> Context) -> Vimeta m a -> Vimeta m a

reader :: (Context -> a) -> Vimeta m a

Monad m => Monad (Vimeta m)

Defined in Vimeta.Core.Vimeta

Methods

(>>=) :: Vimeta m a -> (a -> Vimeta m b) -> Vimeta m b

(>>) :: Vimeta m a -> Vimeta m b -> Vimeta m b

return :: a -> Vimeta m a

fail :: String -> Vimeta m a

Functor m => Functor (Vimeta m)

Defined in Vimeta.Core.Vimeta

Methods

fmap :: (a -> b) -> Vimeta m a -> Vimeta m b

(<$) :: a -> Vimeta m b -> Vimeta m a

Monad m => Applicative (Vimeta m)

Defined in Vimeta.Core.Vimeta

Methods

pure :: a -> Vimeta m a

(<*>) :: Vimeta m (a -> b) -> Vimeta m a -> Vimeta m b

liftA2 :: (a -> b -> c) -> Vimeta m a -> Vimeta m b -> Vimeta m c

(*>) :: Vimeta m a -> Vimeta m b -> Vimeta m b

(<*) :: Vimeta m a -> Vimeta m b -> Vimeta m a

MonadIO m => MonadIO (Vimeta m)

Defined in Vimeta.Core.Vimeta

Methods

liftIO :: IO a -> Vimeta m a

data Context

Constructors

Context

Fields

• ctxManager :: Manager
• ctxConfig :: Config
• ctxTMDBCfg :: Configuration
• ctxVerboseH :: Handle

Instances

Monad m => MonadReader Context (Vimeta m)

Defined in Vimeta.Core.Vimeta

Methods

ask :: Vimeta m Context

local :: (Context -> Context) -> Vimeta m a -> Vimeta m a

reader :: (Context -> a) -> Vimeta m a

die :: Monad m => String -> Vimeta m a

Terminate a Vimeta session with an error message.

runIO :: MonadIO m => IO a -> Vimeta m a

runIOE :: MonadIO m => IO (Either String a) -> Vimeta m a

tmdb :: MonadIO m => TheMovieDB a -> Vimeta m a

Run a TheMovieDB operation.

verbose :: MonadIO m => Text -> Vimeta m ()

execVimetaWithContext :: Context -> Vimeta m a -> m (Either String a)

Very primitive way of running a Vimeta value with the given Context. Mostly useful for running vimeta action within another vimeta action.

execVimeta

Arguments

:: MonadIO m

=> (Config -> Config)

Modify configuration before running.

-> Vimeta m a

The Vimeta value to execute.

-> m (Either String a)

The result.

Run a Vimeta operation after loading the configuration file from disk.

runVimeta :: MonadIO m => Vimeta m a -> m (Either String a)

Simple wrapper around execVimeta.

tagFile :: String -> Vimeta IO ()

Run the tagging command unless dry-run mode is in effect.

parseMappingFile

Arguments

:: MonadIO m

=> FilePath

File name for the mapping file.

-> Parser a

Parser for the second column.

-> Vimeta m [(FilePath, a)]

Parse a mapping file.

withArtwork :: MonadIO m => [Text] -> (Maybe FilePath -> Vimeta IO a) -> Vimeta m a

Try to download artwork and run the given function. The function will be passed a FilePath if the artwork was downloaded.

See the withDownload function for more details.

withDownload

Arguments

:: MonadIO m

=> Maybe Text

URL.

-> (Maybe FilePath -> Vimeta IO a)

Function to call and pass the file name to.

-> Vimeta m a

Result of above function.

Download the given URL to a temporary file and pass the file name to the given function.

The reason a function needs to be passed to withDownload is the result of using withSystemTempFile to store the downloaded file. The file will be automatically removed after the given function completes.