| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
B9
Description
B9 is a library and build tool with which one can create/convert different types of VM images. Additionally installation steps - like installing software - can be done in a LXC container, running on the disk images.
B9 allows to create and convert virtual machine image files as well as related ISO and VFAT disk images for e.g. cloud-init configuration sources.
This module re-exports the modules needed to build a tool around the
library, e.g. see src/cli/Main.hs as an example.
B9.Artifact.Generator is the module containing the basic data structure used to describe a B9 build.
Synopsis
- b9Version :: Version
- b9VersionString :: String
- runShowVersion :: MonadIO m => m ()
- runBuildArtifacts :: [FilePath] -> B9ConfigAction String
- runFormatBuildFiles :: MonadIO m => [FilePath] -> m ()
- runPush :: SharedImageName -> B9ConfigAction ()
- runPull :: Maybe SharedImageName -> B9ConfigAction ()
- runRun :: SharedImageName -> [String] -> B9ConfigAction String
- runGcLocalRepoCache :: B9ConfigAction ()
- runGcRemoteRepoCache :: B9ConfigAction ()
- runListSharedImages :: B9ConfigAction [SharedImage]
- runAddRepo :: RemoteRepo -> B9ConfigAction ()
- runLookupLocalSharedImage :: SharedImageName -> B9ConfigAction (Maybe SharedImageBuildId)
- (++) :: [a] -> [a] -> [a]
- filter :: (a -> Bool) -> [a] -> [a]
- zip :: [a] -> [b] -> [(a, b)]
- map :: (a -> b) -> [a] -> [b]
- guard :: Alternative f => Bool -> f ()
- join :: Monad m => m (m a) -> m a
- class Applicative m => Monad (m :: Type -> Type) where
- class Functor (f :: Type -> Type) where
- class Functor f => Applicative (f :: Type -> Type) where
- foldr :: Foldable t => (a -> b -> b) -> b -> t a -> b
- length :: Foldable t => t a -> Int
- null :: Foldable t => t a -> Bool
- foldl :: Foldable t => (b -> a -> b) -> b -> t a -> b
- foldl' :: Foldable t => (b -> a -> b) -> b -> t a -> b
- foldl1 :: Foldable t => (a -> a -> a) -> t a -> a
- sum :: (Foldable t, Num a) => t a -> a
- product :: (Foldable t, Num a) => t a -> a
- foldr1 :: Foldable t => (a -> a -> a) -> t a -> a
- maximum :: (Foldable t, Ord a) => t a -> a
- minimum :: (Foldable t, Ord a) => t a -> a
- elem :: (Foldable t, Eq a) => a -> t a -> Bool
- mapM :: (Traversable t, Monad m) => (a -> m b) -> t a -> m (t b)
- sequence :: (Traversable t, Monad m) => t (m a) -> m (t a)
- (<>) :: Semigroup a => a -> a -> a
- class Semigroup a => Monoid a where
- data Maybe a
- unlines :: [String] -> String
- lines :: String -> [String]
- isInfixOf :: Eq a => [a] -> [a] -> Bool
- delete :: Eq a => a -> [a] -> [a]
- data Version = Version {
- versionBranch :: [Int]
- versionTags :: [String]
- liftM :: Monad m => (a1 -> r) -> m a1 -> m r
- local :: MonadReader r m => (r -> r) -> m a -> m a
- ask :: MonadReader r m => m r
- data ByteString
- (<$>) :: Functor f => (a -> b) -> f a -> f b
- data Text
- class Applicative f => Alternative (f :: Type -> Type) where
- class (Alternative m, Monad m) => MonadPlus (m :: Type -> Type) where
- class Monad m => MonadIO (m :: Type -> Type) where
- exitWith :: ExitCode -> IO a
- printf :: PrintfType r => String -> r
- mfilter :: MonadPlus m => (a -> Bool) -> m a -> m a
- (<$!>) :: Monad m => (a -> b) -> m a -> m b
- unless :: Applicative f => Bool -> f () -> f ()
- replicateM_ :: Applicative m => Int -> m a -> m ()
- replicateM :: Applicative m => Int -> m a -> m [a]
- foldM_ :: (Foldable t, Monad m) => (b -> a -> m b) -> b -> t a -> m ()
- foldM :: (Foldable t, Monad m) => (b -> a -> m b) -> b -> t a -> m b
- zipWithM_ :: Applicative m => (a -> b -> m c) -> [a] -> [b] -> m ()
- zipWithM :: Applicative m => (a -> b -> m c) -> [a] -> [b] -> m [c]
- mapAndUnzipM :: Applicative m => (a -> m (b, c)) -> [a] -> m ([b], [c])
- forever :: Applicative f => f a -> f b
- (<=<) :: Monad m => (b -> m c) -> (a -> m b) -> a -> m c
- (>=>) :: Monad m => (a -> m b) -> (b -> m c) -> a -> m c
- filterM :: Applicative m => (a -> m Bool) -> [a] -> m [a]
- makeVersion :: [Int] -> Version
- parseVersion :: ReadP Version
- showVersion :: Version -> String
- isSubsequenceOf :: Eq a => [a] -> [a] -> Bool
- mapAccumR :: Traversable t => (a -> b -> (a, c)) -> a -> t b -> (a, t c)
- mapAccumL :: Traversable t => (a -> b -> (a, c)) -> a -> t b -> (a, t c)
- forM :: (Traversable t, Monad m) => t a -> (a -> m b) -> m (t b)
- optional :: Alternative f => f a -> f (Maybe a)
- newtype WrappedMonad (m :: Type -> Type) a = WrapMonad {
- unwrapMonad :: m a
- newtype WrappedArrow (a :: Type -> Type -> Type) b c = WrapArrow {
- unwrapArrow :: a b c
- newtype ZipList a = ZipList {
- getZipList :: [a]
- data ExitCode
- newtype Const a (b :: k) :: forall k. Type -> k -> Type = Const {
- getConst :: a
- find :: Foldable t => (a -> Bool) -> t a -> Maybe a
- notElem :: (Foldable t, Eq a) => a -> t a -> Bool
- minimumBy :: Foldable t => (a -> a -> Ordering) -> t a -> a
- maximumBy :: Foldable t => (a -> a -> Ordering) -> t a -> a
- all :: Foldable t => (a -> Bool) -> t a -> Bool
- any :: Foldable t => (a -> Bool) -> t a -> Bool
- or :: Foldable t => t Bool -> Bool
- and :: Foldable t => t Bool -> Bool
- concatMap :: Foldable t => (a -> [b]) -> t a -> [b]
- concat :: Foldable t => t [a] -> [a]
- msum :: (Foldable t, MonadPlus m) => t (m a) -> m a
- sequence_ :: (Foldable t, Monad m) => t (m a) -> m ()
- forM_ :: (Foldable t, Monad m) => t a -> (a -> m b) -> m ()
- mapM_ :: (Foldable t, Monad m) => (a -> m b) -> t a -> m ()
- newtype First a = First {}
- newtype Last a = Last {}
- newtype Ap (f :: k -> Type) (a :: k) :: forall k. (k -> Type) -> k -> Type = Ap {
- getAp :: f a
- newtype Dual a = Dual {
- getDual :: a
- newtype Endo a = Endo {
- appEndo :: a -> a
- newtype All = All {}
- newtype Any = Any {}
- newtype Sum a = Sum {
- getSum :: a
- newtype Product a = Product {
- getProduct :: a
- newtype Alt (f :: k -> Type) (a :: k) :: forall k. (k -> Type) -> k -> Type = Alt {
- getAlt :: f a
- unwords :: [String] -> String
- words :: String -> [String]
- unfoldr :: (b -> Maybe (a, b)) -> b -> [a]
- sortOn :: Ord b => (a -> b) -> [a] -> [a]
- sortBy :: (a -> a -> Ordering) -> [a] -> [a]
- sort :: Ord a => [a] -> [a]
- permutations :: [a] -> [[a]]
- subsequences :: [a] -> [[a]]
- tails :: [a] -> [[a]]
- inits :: [a] -> [[a]]
- groupBy :: (a -> a -> Bool) -> [a] -> [[a]]
- group :: Eq a => [a] -> [[a]]
- deleteFirstsBy :: (a -> a -> Bool) -> [a] -> [a] -> [a]
- unzip7 :: [(a, b, c, d, e, f, g)] -> ([a], [b], [c], [d], [e], [f], [g])
- unzip6 :: [(a, b, c, d, e, f)] -> ([a], [b], [c], [d], [e], [f])
- unzip5 :: [(a, b, c, d, e)] -> ([a], [b], [c], [d], [e])
- unzip4 :: [(a, b, c, d)] -> ([a], [b], [c], [d])
- zipWith7 :: (a -> b -> c -> d -> e -> f -> g -> h) -> [a] -> [b] -> [c] -> [d] -> [e] -> [f] -> [g] -> [h]
- zipWith6 :: (a -> b -> c -> d -> e -> f -> g) -> [a] -> [b] -> [c] -> [d] -> [e] -> [f] -> [g]
- zipWith5 :: (a -> b -> c -> d -> e -> f) -> [a] -> [b] -> [c] -> [d] -> [e] -> [f]
- zipWith4 :: (a -> b -> c -> d -> e) -> [a] -> [b] -> [c] -> [d] -> [e]
- zip7 :: [a] -> [b] -> [c] -> [d] -> [e] -> [f] -> [g] -> [(a, b, c, d, e, f, g)]
- zip6 :: [a] -> [b] -> [c] -> [d] -> [e] -> [f] -> [(a, b, c, d, e, f)]
- zip5 :: [a] -> [b] -> [c] -> [d] -> [e] -> [(a, b, c, d, e)]
- zip4 :: [a] -> [b] -> [c] -> [d] -> [(a, b, c, d)]
- genericReplicate :: Integral i => i -> a -> [a]
- genericIndex :: Integral i => [a] -> i -> a
- genericSplitAt :: Integral i => i -> [a] -> ([a], [a])
- genericDrop :: Integral i => i -> [a] -> [a]
- genericTake :: Integral i => i -> [a] -> [a]
- genericLength :: Num i => [a] -> i
- insertBy :: (a -> a -> Ordering) -> a -> [a] -> [a]
- insert :: Ord a => a -> [a] -> [a]
- partition :: (a -> Bool) -> [a] -> ([a], [a])
- transpose :: [[a]] -> [[a]]
- intercalate :: [a] -> [[a]] -> [a]
- intersperse :: a -> [a] -> [a]
- intersectBy :: (a -> a -> Bool) -> [a] -> [a] -> [a]
- intersect :: Eq a => [a] -> [a] -> [a]
- unionBy :: (a -> a -> Bool) -> [a] -> [a] -> [a]
- union :: Eq a => [a] -> [a] -> [a]
- (\\) :: Eq a => [a] -> [a] -> [a]
- deleteBy :: (a -> a -> Bool) -> a -> [a] -> [a]
- nubBy :: (a -> a -> Bool) -> [a] -> [a]
- nub :: Eq a => [a] -> [a]
- isSuffixOf :: Eq a => [a] -> [a] -> Bool
- isPrefixOf :: Eq a => [a] -> [a] -> Bool
- findIndices :: (a -> Bool) -> [a] -> [Int]
- findIndex :: (a -> Bool) -> [a] -> Maybe Int
- elemIndices :: Eq a => a -> [a] -> [Int]
- elemIndex :: Eq a => a -> [a] -> Maybe Int
- stripPrefix :: Eq a => [a] -> [a] -> Maybe [a]
- dropWhileEnd :: (a -> Bool) -> [a] -> [a]
- (&) :: a -> (a -> b) -> b
- void :: Functor f => f a -> f ()
- unzip3 :: [(a, b, c)] -> ([a], [b], [c])
- unzip :: [(a, b)] -> ([a], [b])
- zipWith3 :: (a -> b -> c -> d) -> [a] -> [b] -> [c] -> [d]
- zipWith :: (a -> b -> c) -> [a] -> [b] -> [c]
- zip3 :: [a] -> [b] -> [c] -> [(a, b, c)]
- (!!) :: [a] -> Int -> a
- lookup :: Eq a => a -> [(a, b)] -> Maybe b
- reverse :: [a] -> [a]
- break :: (a -> Bool) -> [a] -> ([a], [a])
- span :: (a -> Bool) -> [a] -> ([a], [a])
- splitAt :: Int -> [a] -> ([a], [a])
- drop :: Int -> [a] -> [a]
- take :: Int -> [a] -> [a]
- dropWhile :: (a -> Bool) -> [a] -> [a]
- takeWhile :: (a -> Bool) -> [a] -> [a]
- cycle :: [a] -> [a]
- replicate :: Int -> a -> [a]
- repeat :: a -> [a]
- iterate' :: (a -> a) -> a -> [a]
- iterate :: (a -> a) -> a -> [a]
- scanr1 :: (a -> a -> a) -> [a] -> [a]
- scanr :: (a -> b -> b) -> b -> [a] -> [b]
- scanl' :: (b -> a -> b) -> b -> [a] -> [b]
- scanl1 :: (a -> a -> a) -> [a] -> [a]
- scanl :: (b -> a -> b) -> b -> [a] -> [b]
- foldl1' :: (a -> a -> a) -> [a] -> a
- init :: [a] -> [a]
- last :: [a] -> a
- tail :: [a] -> [a]
- uncons :: [a] -> Maybe (a, [a])
- head :: [a] -> a
- mapMaybe :: (a -> Maybe b) -> [a] -> [b]
- catMaybes :: [Maybe a] -> [a]
- listToMaybe :: [a] -> Maybe a
- maybeToList :: Maybe a -> [a]
- fromMaybe :: a -> Maybe a -> a
- fromJust :: Maybe a -> a
- isNothing :: Maybe a -> Bool
- isJust :: Maybe a -> Bool
- maybe :: b -> (a -> b) -> Maybe a -> b
- ap :: Monad m => m (a -> b) -> m a -> m b
- liftM5 :: Monad m => (a1 -> a2 -> a3 -> a4 -> a5 -> r) -> m a1 -> m a2 -> m a3 -> m a4 -> m a5 -> m r
- liftM4 :: Monad m => (a1 -> a2 -> a3 -> a4 -> r) -> m a1 -> m a2 -> m a3 -> m a4 -> m r
- liftM3 :: Monad m => (a1 -> a2 -> a3 -> r) -> m a1 -> m a2 -> m a3 -> m r
- liftM2 :: Monad m => (a1 -> a2 -> r) -> m a1 -> m a2 -> m r
- when :: Applicative f => Bool -> f () -> f ()
- (=<<) :: Monad m => (a -> m b) -> m a -> m b
- liftA3 :: Applicative f => (a -> b -> c -> d) -> f a -> f b -> f c -> f d
- liftA :: Applicative f => (a -> b) -> f a -> f b
- (<**>) :: Applicative f => f a -> f (a -> b) -> f b
- data ReaderT r (m :: k -> Type) (a :: k) :: forall k. Type -> (k -> Type) -> k -> Type
- (</>) :: FilePath -> FilePath -> FilePath
- takeDirectory :: FilePath -> FilePath
- takeFileName :: FilePath -> FilePath
- (<.>) :: FilePath -> String -> FilePath
- replaceExtension :: FilePath -> String -> FilePath
- (^.) :: s -> Getting a s a -> a
- (.~) :: ASetter s t a b -> b -> s -> t
- (%~) :: ASetter s t a b -> (a -> b) -> s -> t
- type Lens s t a b = forall (f :: Type -> Type). Functor f => (a -> f b) -> s -> f t
- ppShow :: Show a => a -> String
- newtype B9Error = MkB9Error {}
- type ExcB9 = Exc SomeException
- runExcB9 :: Eff (ExcB9 ': e) a -> Eff e (Either SomeException a)
- errorOnException :: Eff (ExcB9 ': e) a -> Eff e a
- throwSomeException :: (Member ExcB9 e, Exception x) => x -> Eff e a
- throwSomeException_ :: (Member ExcB9 e, Exception x) => x -> Eff e ()
- throwB9Error :: Member ExcB9 e => String -> Eff e a
- throwB9Error_ :: Member ExcB9 e => String -> Eff e ()
- catchB9Error :: Member ExcB9 e => Eff e a -> (SomeException -> Eff e a) -> Eff e a
- catchB9ErrorAsEither :: Member ExcB9 e => Eff e a -> Eff e (Either SomeException a)
- arbitraryEnv :: Arbitrary a => Gen [(String, a)]
- halfSize :: Gen a -> Gen a
- smaller :: Gen a -> Gen a
- arbitraryFilePath :: Gen FilePath
- arbitraryLetter :: Gen Char
- arbitraryLetterUpper :: Gen Char
- arbitraryLetterLower :: Gen Char
- arbitraryDigit :: Gen Char
- newtype SharedImageBuildId = SharedImageBuildId String
- newtype SharedImageDate = SharedImageDate String
- newtype SharedImageName = SharedImageName String
- data SharedImage = SharedImage SharedImageName SharedImageDate SharedImageBuildId ImageType FileSystem
- type Mounted a = (a, MountPoint)
- data ImageResize
- data SizeUnit
- data ImageSize = ImageSize Int SizeUnit
- data FileSystem
- = NoFileSystem
- | Ext4
- | Ext4_64
- | ISO9660
- | VFAT
- data ImageType
- data Image = Image FilePath ImageType FileSystem
- data Partition
- data ImageSource
- data ImageDestination
- data MountPoint
- data ImageTarget = ImageTarget ImageDestination ImageSource MountPoint
- fromSharedImageName :: SharedImageName -> String
- fromSharedImageBuildId :: SharedImageBuildId -> String
- imageFileName :: Image -> FilePath
- imageImageType :: Image -> ImageType
- getImageDestinationOutputFiles :: ImageTarget -> [FilePath]
- imageDestinationSharedImageName :: ImageDestination -> Maybe SharedImageName
- imageSourceSharedImageName :: ImageSource -> Maybe SharedImageName
- itImageDestination :: ImageTarget -> ImageDestination
- itImageSource :: ImageTarget -> ImageSource
- itImageMountPoint :: ImageTarget -> MountPoint
- isPartitioned :: Partition -> Bool
- getPartition :: Partition -> Int
- imageFileExtension :: ImageType -> String
- changeImageFormat :: ImageType -> Image -> Image
- changeImageDirectory :: FilePath -> Image -> Image
- getImageSourceImageType :: ImageSource -> Maybe ImageType
- sharedImageName :: SharedImage -> SharedImageName
- sharedImageDate :: SharedImage -> SharedImageDate
- sharedImageBuildId :: SharedImage -> SharedImageBuildId
- prettyPrintSharedImages :: [SharedImage] -> String
- sharedImageImage :: SharedImage -> Image
- sharedImageFileName :: SharedImage -> FilePath
- sharedImagesRootDirectory :: FilePath
- sharedImageFileExtension :: String
- sharedImageDefaultImageType :: ImageType
- transientCOWImage :: FilePath -> FilePath -> ImageTarget
- transientSharedImage :: SharedImageName -> FilePath -> ImageTarget
- transientLocalImage :: FilePath -> FilePath -> ImageTarget
- shareCOWImage :: FilePath -> SharedImageName -> FilePath -> ImageTarget
- shareSharedImage :: SharedImageName -> SharedImageName -> FilePath -> ImageTarget
- shareLocalImage :: FilePath -> SharedImageName -> FilePath -> ImageTarget
- cowToliveInstallerImage :: String -> FilePath -> FilePath -> FilePath -> ImageTarget
- cowToLocalImage :: FilePath -> FilePath -> FilePath -> ImageTarget
- localToLocalImage :: FilePath -> FilePath -> FilePath -> ImageTarget
- partition1ToLocalImage :: FilePath -> FilePath -> FilePath -> ImageTarget
- splitToIntermediateSharedImage :: ImageTarget -> SharedImageName -> (ImageTarget, ImageTarget)
- arbitrarySharedImageName :: Gen String
- data RamSize
- data CPUArch
- data Resources = Resources {}
- data SharedDirectory
- data ExecEnv = ExecEnv {}
- noResources :: Resources
- data User
- data Cwd
- data CmdVerbosity
- = Debug
- | Verbose
- | OnlyStdErr
- | Quiet
- data Script
- writeSh :: FilePath -> Script -> IO ()
- emptyScript :: Script -> Bool
- renderScript :: Script -> String
- class Textual a where
- renderToText :: HasCallStack => a -> Either String Text
- parseFromText :: HasCallStack => Text -> Either String a
- type LazyText = Text
- type LazyByteString = ByteString
- writeTextFile :: (HasCallStack, MonadIO m) => FilePath -> Text -> m ()
- unsafeRenderToText :: (Textual a, HasCallStack) => a -> Text
- unsafeParseFromText :: (Textual a, HasCallStack) => Text -> a
- encodeAsUtf8LazyByteString :: HasCallStack => String -> LazyByteString
- parseFromTextWithErrorMessage :: (HasCallStack, Textual a) => String -> Text -> Either String a
- data KeyNotFound = MkKeyNotFound Text Environment
- data DuplicateKey = MkDuplicateKey {}
- type EnvironmentReader = Reader Environment
- data Environment
- addPositionalArguments :: [Text] -> Environment -> Environment
- addLocalPositionalArguments :: Member EnvironmentReader e => [String] -> Eff e a -> Eff e a
- fromStringPairs :: [(String, String)] -> Environment
- addBinding :: Member ExcB9 e => (Text, Text) -> Environment -> Eff e Environment
- addStringBinding :: Member ExcB9 e => (String, String) -> Environment -> Eff e Environment
- addLocalStringBinding :: (Member EnvironmentReader e, Member ExcB9 e) => (String, String) -> Eff e a -> Eff e a
- runEnvironmentReader :: Environment -> Eff (EnvironmentReader ': e) a -> Eff e a
- askEnvironment :: Member EnvironmentReader e => Eff e Environment
- localEnvironment :: Member EnvironmentReader e => (Environment -> Environment) -> Eff e a -> Eff e a
- lookupOrThrow :: '[ExcB9, EnvironmentReader] <:: e => Text -> Eff e Text
- lookupEither :: Member EnvironmentReader e => Text -> Eff e (Either KeyNotFound Text)
- hasKey :: Member EnvironmentReader e => Text -> Eff e Bool
- data SimpleErlangTerm
- parseErlTerm :: String -> Text -> Either String SimpleErlangTerm
- renderErlTerm :: SimpleErlangTerm -> Text
- erlTermParser :: Parser SimpleErlangTerm
- arbitraryErlSimpleAtom :: Gen SimpleErlangTerm
- arbitraryErlString :: Gen SimpleErlangTerm
- arbitraryErlNumber :: Gen SimpleErlangTerm
- arbitraryErlNatural :: Gen SimpleErlangTerm
- arbitraryErlFloat :: Gen SimpleErlangTerm
- arbitraryErlNameChar :: Gen Char
- data UUID
- data ConsultException = ConsultException FilePath String
- data SystemPath
- overSystemPath :: (FilePath -> FilePath) -> SystemPath -> SystemPath
- resolve :: MonadIO m => SystemPath -> m FilePath
- getDirectoryFiles :: MonadIO m => FilePath -> m [FilePath]
- ensureDir :: MonadIO m => FilePath -> m ()
- prettyPrintToFile :: (MonadIO m, Show a) => FilePath -> a -> m ()
- consult :: (MonadIO m, Read a) => FilePath -> m a
- randomUUID :: MonadIO m => m UUID
- newtype SshRemoteUser = SshRemoteUser String
- newtype SshRemoteHost = SshRemoteHost (String, Int)
- newtype SshPrivKey = SshPrivKey FilePath
- data RemoteRepo = RemoteRepo String FilePath SshPrivKey SshRemoteHost SshRemoteUser
- newtype RepoCache = RepoCache FilePath
- remoteRepoRepoId :: RemoteRepo -> String
- remoteRepoToCPDocument :: RemoteRepo -> CPDocument -> Either CPError CPDocument
- parseRemoteRepos :: CPDocument -> Either CPError [RemoteRepo]
- data LXCGuestCapability
- = CAP_MKNOD
- | CAP_AUDIT_CONTROL
- | CAP_AUDIT_READ
- | CAP_AUDIT_WRITE
- | CAP_BLOCK_SUSPEND
- | CAP_CHOWN
- | CAP_DAC_OVERRIDE
- | CAP_DAC_READ_SEARCH
- | CAP_FOWNER
- | CAP_FSETID
- | CAP_IPC_LOCK
- | CAP_IPC_OWNER
- | CAP_KILL
- | CAP_LEASE
- | CAP_LINUX_IMMUTABLE
- | CAP_MAC_ADMIN
- | CAP_MAC_OVERRIDE
- | CAP_NET_ADMIN
- | CAP_NET_BIND_SERVICE
- | CAP_NET_BROADCAST
- | CAP_NET_RAW
- | CAP_SETGID
- | CAP_SETFCAP
- | CAP_SETPCAP
- | CAP_SETUID
- | CAP_SYS_ADMIN
- | CAP_SYS_BOOT
- | CAP_SYS_CHROOT
- | CAP_SYS_MODULE
- | CAP_SYS_NICE
- | CAP_SYS_PACCT
- | CAP_SYS_PTRACE
- | CAP_SYS_RAWIO
- | CAP_SYS_RESOURCE
- | CAP_SYS_TIME
- | CAP_SYS_TTY_CONFIG
- | CAP_SYSLOG
- | CAP_WAKE_ALARM
- data LibVirtLXCConfig = LibVirtLXCConfig {}
- networkId :: Lens' LibVirtLXCConfig (Maybe String)
- defaultLibVirtLXCConfig :: LibVirtLXCConfig
- libVirtLXCConfigToCPDocument :: LibVirtLXCConfig -> CPDocument -> Either CPError CPDocument
- parseLibVirtLXCConfig :: CPDocument -> Either CPError LibVirtLXCConfig
- getEmulatorPath :: MonadIO m => LibVirtLXCConfig -> m FilePath
- data B9ConfigOverride = B9ConfigOverride {}
- type B9ConfigReader = Reader B9Config
- data B9Config = B9Config {
- _verbosity :: Maybe LogLevel
- _logFile :: Maybe FilePath
- _projectRoot :: Maybe FilePath
- _keepTempDirs :: Bool
- _execEnvType :: ExecEnvType
- _uniqueBuildDirs :: Bool
- _repositoryCache :: Maybe SystemPath
- _repository :: Maybe String
- _interactive :: Bool
- _maxLocalSharedImageRevisions :: Maybe Int
- _libVirtLXCConfigs :: Maybe LibVirtLXCConfig
- _remoteRepos :: [RemoteRepo]
- data LogLevel
- data ExecEnvType = LibVirtLXC
- runB9ConfigReader :: HasCallStack => B9Config -> Eff (B9ConfigReader ': e) a -> Eff e a
- getB9Config :: Member B9ConfigReader e => Eff e B9Config
- localB9Config :: Member B9ConfigReader e => (B9Config -> B9Config) -> Eff e a -> Eff e a
- getConfig :: Member B9ConfigReader e => Eff e B9Config
- isInteractive :: Member B9ConfigReader e => Eff e Bool
- getExecEnvType :: Member B9ConfigReader e => Eff e ExecEnvType
- getRemoteRepos :: Member B9ConfigReader e => Eff e [RemoteRepo]
- getLogVerbosity :: Member B9ConfigReader e => Eff e (Maybe LogLevel)
- getProjectRoot :: Member B9ConfigReader e => Eff e FilePath
- noB9ConfigOverride :: B9ConfigOverride
- execEnvType :: Lens' B9Config ExecEnvType
- interactive :: Lens' B9Config Bool
- keepTempDirs :: Lens' B9Config Bool
- libVirtLXCConfigs :: Lens' B9Config (Maybe LibVirtLXCConfig)
- logFile :: Lens' B9Config (Maybe FilePath)
- maxLocalSharedImageRevisions :: Lens' B9Config (Maybe Int)
- projectRoot :: Lens' B9Config (Maybe FilePath)
- remoteRepos :: Lens' B9Config [RemoteRepo]
- repository :: Lens' B9Config (Maybe String)
- repositoryCache :: Lens' B9Config (Maybe SystemPath)
- uniqueBuildDirs :: Lens' B9Config Bool
- verbosity :: Lens' B9Config (Maybe LogLevel)
- type B9ConfigWriter = Writer (Endo B9Config)
- type B9ConfigAction a = Eff '[B9ConfigWriter, B9ConfigReader, EnvironmentReader, Lift IO] a
- customB9Config :: Lens' B9ConfigOverride (Endo B9Config)
- customB9ConfigPath :: Lens' B9ConfigOverride (Maybe SystemPath)
- customEnvironment :: Lens' B9ConfigOverride Environment
- overrideB9ConfigPath :: SystemPath -> B9ConfigOverride -> B9ConfigOverride
- overrideB9Config :: (B9Config -> B9Config) -> B9ConfigOverride -> B9ConfigOverride
- overrideWorkingDirectory :: FilePath -> B9ConfigOverride -> B9ConfigOverride
- overrideVerbosity :: LogLevel -> B9ConfigOverride -> B9ConfigOverride
- overrideKeepBuildDirs :: Bool -> B9ConfigOverride -> B9ConfigOverride
- modifyPermanentConfig :: (HasCallStack, Member B9ConfigWriter e) => Endo B9Config -> Eff e ()
- runB9ConfigActionWithOverrides :: HasCallStack => B9ConfigAction a -> B9ConfigOverride -> IO a
- runB9ConfigAction :: HasCallStack => B9ConfigAction a -> IO a
- openOrCreateB9Config :: (HasCallStack, MonadIO m) => FilePath -> m CPDocument
- writeB9CPDocument :: (HasCallStack, MonadIO m) => Maybe SystemPath -> CPDocument -> m ()
- defaultB9Config :: B9Config
- defaultRepositoryCache :: SystemPath
- defaultB9ConfigFile :: SystemPath
- modifyCPDocument :: CPDocument -> Endo B9Config -> Either CPError CPDocument
- b9ConfigToCPDocument :: HasCallStack => B9Config -> Either CPError CPDocument
- readB9Config :: (HasCallStack, MonadIO m) => Maybe SystemPath -> m CPDocument
- parseB9Config :: HasCallStack => CPDocument -> Either CPError B9Config
- type SelectedRemoteRepoReader = Reader SelectedRemoteRepo
- newtype SelectedRemoteRepo = MkSelectedRemoteRepo {}
- type RepoCacheReader = Reader RepoCache
- withRemoteRepos :: (Member B9ConfigReader e, Lifted IO e) => Eff (RepoCacheReader ': e) a -> Eff e a
- getRepoCache :: Member RepoCacheReader e => Eff e RepoCache
- withSelectedRemoteRepo :: (Member B9ConfigReader e, Member ExcB9 e) => Eff (SelectedRemoteRepoReader ': e) a -> Eff e a
- getSelectedRemoteRepo :: Member SelectedRemoteRepoReader e => Eff e SelectedRemoteRepo
- initRepoCache :: MonadIO m => SystemPath -> m RepoCache
- remoteRepoCheckSshPrivKey :: MonadIO m => RemoteRepo -> m RemoteRepo
- initRemoteRepo :: MonadIO m => RepoCache -> RemoteRepo -> m RemoteRepo
- cleanRemoteRepo :: MonadIO m => RepoCache -> RemoteRepo -> m ()
- remoteRepoCacheDir :: RepoCache -> String -> FilePath
- localRepoDir :: RepoCache -> FilePath
- lookupRemoteRepo :: [RemoteRepo] -> String -> Maybe RemoteRepo
- type CommandIO e = (MonadBaseControl IO (Eff e), MonadIO (Eff e), Member LoggerReader e, Member B9ConfigReader e)
- type LoggerReader = Reader Logger
- newtype Logger = MkLogger {}
- withLogger :: (MonadBaseControl IO (Eff e), MonadIO (Eff e), Member B9ConfigReader e) => Eff (LoggerReader ': e) a -> Eff e a
- traceL :: CommandIO e => String -> Eff e ()
- dbgL :: CommandIO e => String -> Eff e ()
- infoL :: CommandIO e => String -> Eff e ()
- errorL :: CommandIO e => String -> Eff e ()
- errorExitL :: (CommandIO e, Member ExcB9 e) => String -> Eff e a
- b9Log :: CommandIO e => LogLevel -> String -> Eff e ()
- type BuildInfoReader = Reader BuildInfo
- withBuildInfo :: (Lifted IO e, MonadBaseControl IO (Eff e), Member B9ConfigReader e, Member ExcB9 e, Member EnvironmentReader e, Member LoggerReader e, HasCallStack) => Eff (BuildInfoReader ': e) a -> Eff e a
- getBuildId :: Member BuildInfoReader e => Eff e String
- getBuildDate :: Member BuildInfoReader e => Eff e String
- getBuildDir :: Member BuildInfoReader e => Eff e FilePath
- type IsB9 e = (HasCallStack, Lifted IO e, CommandIO e, B9Eff <:: e)
- type B9Eff = '[SelectedRemoteRepoReader, RepoCacheReader, BuildInfoReader, LoggerReader, B9ConfigReader, EnvironmentReader, ExcB9, Lift IO]
- type B9 a = Eff B9Eff a
- runB9 :: HasCallStack => B9 a -> B9ConfigAction a
- class ToContentGenerator c where
- toContentGenerator :: (HasCallStack, IsB9 e) => c -> Eff e Text
- type ContentGenerator = B9 Text
- cmd :: CommandIO e => String -> Eff e ()
- newtype FilePathGlob = FileExtension String
- data Repository
- toRemoteRepository :: RemoteRepo -> Repository
- repoSearch :: forall e. (CommandIO e, Member RepoCacheReader e) => FilePath -> FilePathGlob -> Eff e [(Repository, [FilePath])]
- pushToRepo :: CommandIO e => RemoteRepo -> FilePath -> FilePath -> Eff e ()
- pullFromRepo :: CommandIO e => RemoteRepo -> FilePath -> FilePath -> Eff e ()
- pullGlob :: (CommandIO e, Member RepoCacheReader e) => FilePath -> FilePathGlob -> RemoteRepo -> Eff e ()
- data SourceFileConversion
- data SourceFile = Source SourceFileConversion FilePath
- readTemplateFile :: (MonadIO (Eff e), '[ExcB9, EnvironmentReader] <:: e) => SourceFile -> Eff e Text
- subst :: (Member ExcB9 e, Member EnvironmentReader e) => Text -> Eff e Text
- substStr :: (Member ExcB9 e, Member EnvironmentReader e) => String -> Eff e String
- substFile :: (Member EnvironmentReader e, Member ExcB9 e, MonadIO (Eff e)) => FilePath -> FilePath -> Eff e ()
- substPath :: (Member EnvironmentReader e, Member ExcB9 e) => SystemPath -> Eff e SystemPath
- withSubstitutedStringBindings :: (Member EnvironmentReader e, Member ExcB9 e) => [(String, String)] -> Eff e s -> Eff e s
- data VmScript
- substVmScript :: forall e. (Member EnvironmentReader e, Member ExcB9 e) => VmScript -> Eff e VmScript
- substImageTarget :: forall e. (HasCallStack, Member EnvironmentReader e, Member ExcB9 e) => ImageTarget -> Eff e ImageTarget
- resolveImageSource :: IsB9 e => ImageSource -> Eff e Image
- preferredDestImageTypes :: IsB9 e => ImageSource -> Eff e [ImageType]
- preferredSourceImageTypes :: HasCallStack => ImageDestination -> [ImageType]
- ensureAbsoluteImageDirExists :: IsB9 e => Image -> Eff e Image
- materializeImageSource :: IsB9 e => ImageSource -> Image -> Eff e ()
- createDestinationImage :: IsB9 e => Image -> ImageDestination -> Eff e ()
- resizeImage :: IsB9 e => ImageResize -> Image -> Eff e ()
- importImage :: IsB9 e => Image -> Image -> Eff e ()
- exportImage :: IsB9 e => Image -> Image -> Eff e ()
- exportAndRemoveImage :: IsB9 e => Image -> Image -> Eff e ()
- convertImage :: IsB9 e => Image -> Image -> Eff e ()
- shareImage :: IsB9 e => Image -> SharedImageName -> Eff e SharedImage
- pushSharedImageLatestVersion :: IsB9 e => SharedImageName -> Eff e ()
- pullRemoteRepos :: IsB9 e => Eff e ()
- pullLatestImage :: IsB9 e => SharedImageName -> Eff e (Maybe SharedImageBuildId)
- getSharedImages :: IsB9 e => Eff e [(Repository, [SharedImage])]
- lookupSharedImages :: IsB9 e => (Repository -> Bool) -> (SharedImage -> Bool) -> Eff e [(Repository, SharedImage)]
- getSelectedRepos :: IsB9 e => Eff e [RemoteRepo]
- getSharedImagesCacheDir :: IsB9 e => Eff e FilePath
- class FromAST a where
- fromAST :: (IsB9 e, ToContentGenerator c) => AST c a -> Eff e a
- data AST c a
- newtype YamlObject = YamlObject {}
- newtype ErlangPropList = ErlangPropList SimpleErlangTerm
- textToErlangAst :: Text -> AST c ErlangPropList
- stringToErlangAst :: String -> AST c ErlangPropList
- newtype CloudConfigYaml = MkCloudConfigYaml {}
- cloudConfigFileHeader :: Text
- type ErlangAst = AST Content ErlangPropList
- data Content
- data ArtifactSource
- getArtifactSourceFiles :: ArtifactSource -> [FilePath]
- data AssemblyOutput
- data CloudInitType
- data ArtifactTarget
- data AssembledArtifact = AssembledArtifact InstanceId [ArtifactTarget]
- data ArtifactAssembly
- newtype InstanceId = IID String
- data ArtifactGenerator
- = Sources [ArtifactSource] [ArtifactGenerator]
- | Let [(String, String)] [ArtifactGenerator]
- | LetX [(String, [String])] [ArtifactGenerator]
- | Each [(String, [String])] [ArtifactGenerator]
- | EachT [String] [[String]] [ArtifactGenerator]
- | Artifact InstanceId ArtifactAssembly
- | EmptyArtifact
- instanceIdKey :: String
- buildIdKey :: String
- buildDateKey :: String
- getAssemblyOutput :: ArtifactAssembly -> [AssemblyOutput]
- buildWithVm :: IsB9 e => InstanceId -> [ImageTarget] -> FilePath -> VmScript -> Eff e Bool
- data InstanceGenerator e = IG InstanceId e ArtifactAssembly
- data InstanceSources = InstanceSources {
- isEnv :: Environment
- isSources :: [ArtifactSource]
- buildArtifacts :: ArtifactGenerator -> B9 String
- getArtifactOutputFiles :: ArtifactGenerator -> Either SomeException [FilePath]
- assemble :: ArtifactGenerator -> B9 [AssembledArtifact]
- runArtifactGenerator :: Environment -> String -> String -> ArtifactGenerator -> Either SomeException [InstanceGenerator [TextFileWriter]]
- runInstanceGenerator :: IsB9 e => InstanceGenerator FilePath -> Eff e AssembledArtifact
- runArtifactAssembly :: IsB9 e => InstanceId -> FilePath -> ArtifactAssembly -> Eff e [ArtifactTarget]
Documentation
b9VersionString :: String Source #
Return the cabal package version of the B9 library,
formatted using showVersion.
runShowVersion :: MonadIO m => m () Source #
Just print the b9VersionString
runBuildArtifacts :: [FilePath] -> B9ConfigAction String Source #
Execute the artifact generators defined in a list of text files.
Read the text files in the list and parse them as ArtifactGenerators
then mappend them and apply buildArtifacts to them.
runFormatBuildFiles :: MonadIO m => [FilePath] -> m () Source #
Read all text files and parse them as ArtifactGenerators.
Then overwrite the files with their contents but _pretty printed_
(i.e. formatted).
runPush :: SharedImageName -> B9ConfigAction () Source #
Upload a SharedImageName to the default remote repository.
Note: The remote repository is specified in the B9Config.
runPull :: Maybe SharedImageName -> B9ConfigAction () Source #
Either pull a list of available SharedImageNames from the remote
repository if Nothing is passed as parameter, or pull the latest version
of the image from the remote repository. Note: The remote repository is
specified in the B9Config.
runRun :: SharedImageName -> [String] -> B9ConfigAction String Source #
Execute an interactive root shell in a running container from a
SharedImageName.
runGcLocalRepoCache :: B9ConfigAction () Source #
Delete all obsolete versions of all SharedImageNames.
runGcRemoteRepoCache :: B9ConfigAction () Source #
Clear the shared image cache for a remote. Note: The remote repository is
specified in the B9Config.
runListSharedImages :: B9ConfigAction [SharedImage] Source #
Print a list of shared images cached locally or remotely, if a remote
repository was selected. Note: The remote repository is
specified in the B9Config.
runAddRepo :: RemoteRepo -> B9ConfigAction () Source #
Check the SSH settings for a remote repository and add it to the user wide B9 configuration file.
runLookupLocalSharedImage :: SharedImageName -> B9ConfigAction (Maybe SharedImageBuildId) Source #
Find the most recent version of a SharedImageName in the local image cache.
(++) :: [a] -> [a] -> [a] infixr 5 #
Append two lists, i.e.,
[x1, ..., xm] ++ [y1, ..., yn] == [x1, ..., xm, y1, ..., yn] [x1, ..., xm] ++ [y1, ...] == [x1, ..., xm, y1, ...]
If the first list is not finite, the result is the first list.
filter :: (a -> Bool) -> [a] -> [a] #
filter, applied to a predicate and a list, returns the list of
those elements that satisfy the predicate; i.e.,
filter p xs = [ x | x <- xs, p x]
map :: (a -> b) -> [a] -> [b] #
map f xs is the list obtained by applying f to each element
of xs, i.e.,
map f [x1, x2, ..., xn] == [f x1, f x2, ..., f xn] map f [x1, x2, ...] == [f x1, f x2, ...]
guard :: Alternative f => Bool -> f () #
Conditional failure of Alternative computations. Defined by
guard True =pure() guard False =empty
Examples
Common uses of guard include conditionally signaling an error in
an error monad and conditionally rejecting the current choice in an
Alternative-based parser.
As an example of signaling an error in the error monad Maybe,
consider a safe division function safeDiv x y that returns
Nothing when the denominator y is zero and Just (x `div`
y)
>>> safeDiv 4 0 Nothing >>> safeDiv 4 2 Just 2
A definition of safeDiv using guards, but not guard:
safeDiv :: Int -> Int -> Maybe Int
safeDiv x y | y /= 0 = Just (x `div` y)
| otherwise = Nothing
A definition of safeDiv using guard and Monad do-notation:
safeDiv :: Int -> Int -> Maybe Int safeDiv x y = do guard (y /= 0) return (x `div` y)
join :: Monad m => m (m a) -> m a #
The join function is the conventional monad join operator. It
is used to remove one level of monadic structure, projecting its
bound argument into the outer level.
Examples
A common use of join is to run an IO computation returned from
an STM transaction, since STM transactions
can't perform IO directly. Recall that
atomically :: STM a -> IO a
is used to run STM transactions atomically. So, by
specializing the types of atomically and join to
atomically:: STM (IO b) -> IO (IO b)join:: IO (IO b) -> IO b
we can compose them as
join.atomically:: STM (IO b) -> IO b
class Applicative m => Monad (m :: Type -> Type) where #
The Monad class defines the basic operations over a monad,
a concept from a branch of mathematics known as category theory.
From the perspective of a Haskell programmer, however, it is best to
think of a monad as an abstract datatype of actions.
Haskell's do expressions provide a convenient syntax for writing
monadic expressions.
Instances of Monad should satisfy the following laws:
Furthermore, the Monad and Applicative operations should relate as follows:
The above laws imply:
and that pure and (<*>) satisfy the applicative functor laws.
The instances of Monad for lists, Maybe and IO
defined in the Prelude satisfy these laws.
Minimal complete definition
Methods
(>>=) :: m a -> (a -> m b) -> m b infixl 1 #
Sequentially compose two actions, passing any value produced by the first as an argument to the second.
(>>) :: m a -> m b -> m b infixl 1 #
Sequentially compose two actions, discarding any value produced by the first, like sequencing operators (such as the semicolon) in imperative languages.
Inject a value into the monadic type.
Fail with a message. This operation is not part of the
mathematical definition of a monad, but is invoked on pattern-match
failure in a do expression.
As part of the MonadFail proposal (MFP), this function is moved
to its own class MonadFail (see Control.Monad.Fail for more
details). The definition here will be removed in a future
release.
Instances
| Monad [] | Since: base-2.1 |
| Monad Maybe | Since: base-2.1 |
| Monad IO | Since: base-2.1 |
| Monad Par1 | Since: base-4.9.0.0 |
| Monad Q | |
| Monad Rose | |
| Monad Gen | |
| Monad IResult | |
| Monad Result | |
| Monad Parser | |
| Monad Complex | Since: base-4.9.0.0 |
| Monad Min | Since: base-4.9.0.0 |
| Monad Max | Since: base-4.9.0.0 |
| Monad First | Since: base-4.9.0.0 |
| Monad Last | Since: base-4.9.0.0 |
| Monad Option | Since: base-4.9.0.0 |
| Monad Identity | Since: base-4.8.0.0 |
| Monad STM | Since: base-4.3.0.0 |
| Monad First | Since: base-4.8.0.0 |
| Monad Last | Since: base-4.8.0.0 |
| Monad Dual | Since: base-4.8.0.0 |
| Monad Sum | Since: base-4.8.0.0 |
| Monad Product | Since: base-4.8.0.0 |
| Monad Down | Since: base-4.11.0.0 |
| Monad ReadPrec | Since: base-2.1 |
| Monad ReadP | Since: base-2.1 |
| Monad NonEmpty | Since: base-4.9.0.0 |
| Monad PutM | |
| Monad Get | |
| Monad Tree | |
| Monad Seq | |
| Monad DList | |
| Monad Eval | |
| Monad Vector | |
| Monad SmallArray | |
Defined in Data.Primitive.SmallArray Methods (>>=) :: SmallArray a -> (a -> SmallArray b) -> SmallArray b # (>>) :: SmallArray a -> SmallArray b -> SmallArray b # return :: a -> SmallArray a # fail :: String -> SmallArray a # | |
| Monad Array | |
| Monad Rules | |
| Monad Action | |
| Monad Id | |
| Monad Box | |
| Monad P | Since: base-2.1 |
| Monad (Either e) | Since: base-4.4.0.0 |
| Monad (U1 :: Type -> Type) | Since: base-4.9.0.0 |
| Monoid a => Monad ((,) a) | Since: base-4.9.0.0 |
| Monad (ST s) | Since: base-2.1 |
| Representable f => Monad (Co f) | |
| Monad (Parser i) | |
| Monad (ST s) | Since: base-2.1 |
| Monad m => Monad (WrappedMonad m) | Since: base-4.7.0.0 |
Defined in Control.Applicative Methods (>>=) :: WrappedMonad m a -> (a -> WrappedMonad m b) -> WrappedMonad m b # (>>) :: WrappedMonad m a -> WrappedMonad m b -> WrappedMonad m b # return :: a -> WrappedMonad m a # fail :: String -> WrappedMonad m a # | |
| ArrowApply a => Monad (ArrowMonad a) | Since: base-2.1 |
Defined in Control.Arrow Methods (>>=) :: ArrowMonad a a0 -> (a0 -> ArrowMonad a b) -> ArrowMonad a b # (>>) :: ArrowMonad a a0 -> ArrowMonad a b -> ArrowMonad a b # return :: a0 -> ArrowMonad a a0 # fail :: String -> ArrowMonad a a0 # | |
| Monad (Proxy :: Type -> Type) | Since: base-4.7.0.0 |
| Monad m => Monad (MaybeT m) | |
| Monad m => Monad (ResourceT m) | |
| Monad (Eff r) | |
| Alternative f => Monad (Cofree f) | |
| Functor f => Monad (Free f) | |
| Monad m => Monad (Yoneda m) | |
| Monad (ReifiedGetter s) | |
Defined in Control.Lens.Reified Methods (>>=) :: ReifiedGetter s a -> (a -> ReifiedGetter s b) -> ReifiedGetter s b # (>>) :: ReifiedGetter s a -> ReifiedGetter s b -> ReifiedGetter s b # return :: a -> ReifiedGetter s a # fail :: String -> ReifiedGetter s a # | |
| Monad (ReifiedFold s) | |
Defined in Control.Lens.Reified Methods (>>=) :: ReifiedFold s a -> (a -> ReifiedFold s b) -> ReifiedFold s b # (>>) :: ReifiedFold s a -> ReifiedFold s b -> ReifiedFold s b # return :: a -> ReifiedFold s a # fail :: String -> ReifiedFold s a # | |
| Monad m => Monad (ListT m) | |
| (Monad (Rep p), Representable p) => Monad (Prep p) | |
| Monad f => Monad (Rec1 f) | Since: base-4.9.0.0 |
| Monad f => Monad (Ap f) | Since: base-4.12.0.0 |
| Monad f => Monad (Alt f) | Since: base-4.8.0.0 |
| Monad m => Monad (IdentityT m) | |
| (Monoid w, Monad m) => Monad (WriterT w m) | |
| (Monoid w, Monad m) => Monad (WriterT w m) | |
| Monad m => Monad (StateT s m) | |
| Monad m => Monad (StateT s m) | |
| Monad m => Monad (ExceptT e m) | |
| (Applicative f, Monad f) => Monad (WhenMissing f x) | Equivalent to Since: containers-0.5.9 |
Defined in Data.IntMap.Internal Methods (>>=) :: WhenMissing f x a -> (a -> WhenMissing f x b) -> WhenMissing f x b # (>>) :: WhenMissing f x a -> WhenMissing f x b -> WhenMissing f x b # return :: a -> WhenMissing f x a # fail :: String -> WhenMissing f x a # | |
| (Functor f, Monad m) => Monad (FreeT f m) | |
| (Alternative f, Monad w) => Monad (CofreeT f w) | |
| (Monad m, Error e) => Monad (ErrorT e m) | |
| Monad (Indexed i a) | |
| Monad (RAW ro rw) | |
| Monad (Tagged s) | |
| (Monoid w, Functor m, Monad m) => Monad (AccumT w m) | |
| Monad m => Monad (SelectT r m) | |
| Monad ((->) r :: Type -> Type) | Since: base-2.1 |
| (Monad f, Monad g) => Monad (f :*: g) | Since: base-4.9.0.0 |
| (Monad f, Monad g) => Monad (Product f g) | Since: base-4.9.0.0 |
| Monad m => Monad (ReaderT r m) | |
| Monad (ConduitT i o m) | |
| (Monad f, Applicative f) => Monad (WhenMatched f x y) | Equivalent to Since: containers-0.5.9 |
Defined in Data.IntMap.Internal Methods (>>=) :: WhenMatched f x y a -> (a -> WhenMatched f x y b) -> WhenMatched f x y b # (>>) :: WhenMatched f x y a -> WhenMatched f x y b -> WhenMatched f x y b # return :: a -> WhenMatched f x y a # fail :: String -> WhenMatched f x y a # | |
| (Applicative f, Monad f) => Monad (WhenMissing f k x) | Equivalent to Since: containers-0.5.9 |
Defined in Data.Map.Internal Methods (>>=) :: WhenMissing f k x a -> (a -> WhenMissing f k x b) -> WhenMissing f k x b # (>>) :: WhenMissing f k x a -> WhenMissing f k x b -> WhenMissing f k x b # return :: a -> WhenMissing f k x a # fail :: String -> WhenMissing f k x a # | |
| Monad (ContT r m) | |
| Monad (ParsecT s u m) | |
| Monad f => Monad (M1 i c f) | Since: base-4.9.0.0 |
| (Monoid w, Monad m) => Monad (RWST r w s m) | |
| (Monoid w, Monad m) => Monad (RWST r w s m) | |
| (Monad f, Applicative f) => Monad (WhenMatched f k x y) | Equivalent to Since: containers-0.5.9 |
Defined in Data.Map.Internal Methods (>>=) :: WhenMatched f k x y a -> (a -> WhenMatched f k x y b) -> WhenMatched f k x y b # (>>) :: WhenMatched f k x y a -> WhenMatched f k x y b -> WhenMatched f k x y b # return :: a -> WhenMatched f k x y a # fail :: String -> WhenMatched f k x y a # | |
| Monad m => Monad (Pipe l i o u m) | |
class Functor (f :: Type -> Type) where #
The Functor class is used for types that can be mapped over.
Instances of Functor should satisfy the following laws:
fmap id == id fmap (f . g) == fmap f . fmap g
The instances of Functor for lists, Maybe and IO
satisfy these laws.
Minimal complete definition
Instances
class Functor f => Applicative (f :: Type -> Type) where #
A functor with application, providing operations to
A minimal complete definition must include implementations of pure
and of either <*> or liftA2. If it defines both, then they must behave
the same as their default definitions:
(<*>) =liftA2id
liftA2f x y = f<$>x<*>y
Further, any definition must satisfy the following:
- identity
pureid<*>v = v- composition
pure(.)<*>u<*>v<*>w = u<*>(v<*>w)- homomorphism
puref<*>purex =pure(f x)- interchange
u
<*>purey =pure($y)<*>u
The other methods have the following default definitions, which may be overridden with equivalent specialized implementations:
As a consequence of these laws, the Functor instance for f will satisfy
It may be useful to note that supposing
forall x y. p (q x y) = f x . g y
it follows from the above that
liftA2p (liftA2q u v) =liftA2f u .liftA2g v
If f is also a Monad, it should satisfy
(which implies that pure and <*> satisfy the applicative functor laws).
Methods
Lift a value.
(<*>) :: f (a -> b) -> f a -> f b infixl 4 #
Sequential application.
A few functors support an implementation of <*> that is more
efficient than the default one.
liftA2 :: (a -> b -> c) -> f a -> f b -> f c #
Lift a binary function to actions.
Some functors support an implementation of liftA2 that is more
efficient than the default one. In particular, if fmap is an
expensive operation, it is likely better to use liftA2 than to
fmap over the structure and then use <*>.
(*>) :: f a -> f b -> f b infixl 4 #
Sequence actions, discarding the value of the first argument.
(<*) :: f a -> f b -> f a infixl 4 #
Sequence actions, discarding the value of the second argument.
Instances
| Applicative [] | Since: base-2.1 |
| Applicative Maybe | Since: base-2.1 |
| Applicative IO | Since: base-2.1 |
| Applicative Par1 | Since: base-4.9.0.0 |
| Applicative Q | |
| Applicative Rose | |
| Applicative Gen | |
| Applicative IResult | |
| Applicative Result | |
| Applicative Parser | |
| Applicative Concurrently | |
Defined in Control.Concurrent.Async Methods pure :: a -> Concurrently a # (<*>) :: Concurrently (a -> b) -> Concurrently a -> Concurrently b # liftA2 :: (a -> b -> c) -> Concurrently a -> Concurrently b -> Concurrently c # (*>) :: Concurrently a -> Concurrently b -> Concurrently b # (<*) :: Concurrently a -> Concurrently b -> Concurrently a # | |
| Applicative Complex | Since: base-4.9.0.0 |
| Applicative Min | Since: base-4.9.0.0 |
| Applicative Max | Since: base-4.9.0.0 |
| Applicative First | Since: base-4.9.0.0 |
| Applicative Last | Since: base-4.9.0.0 |
| Applicative Option | Since: base-4.9.0.0 |
| Applicative ZipList | f '<$>' 'ZipList' xs1 '<*>' ... '<*>' 'ZipList' xsN
= 'ZipList' (zipWithN f xs1 ... xsN)where (\a b c -> stimes c [a, b]) <$> ZipList "abcd" <*> ZipList "567" <*> ZipList [1..]
= ZipList (zipWith3 (\a b c -> stimes c [a, b]) "abcd" "567" [1..])
= ZipList {getZipList = ["a5","b6b6","c7c7c7"]}Since: base-2.1 |
| Applicative Identity | Since: base-4.8.0.0 |
| Applicative STM | Since: base-4.8.0.0 |
| Applicative First | Since: base-4.8.0.0 |
| Applicative Last | Since: base-4.8.0.0 |
| Applicative Dual | Since: base-4.8.0.0 |
| Applicative Sum | Since: base-4.8.0.0 |
| Applicative Product | Since: base-4.8.0.0 |
| Applicative Down | Since: base-4.11.0.0 |
| Applicative ReadPrec | Since: base-4.6.0.0 |
| Applicative ReadP | Since: base-4.6.0.0 |
| Applicative NonEmpty | Since: base-4.9.0.0 |
| Applicative PutM | |
| Applicative Get | |
| Applicative Tree | |
| Applicative Seq | Since: containers-0.5.4 |
| Applicative DList | |
| Applicative Eval | |
| Applicative Vector | |
| Applicative SmallArray | |
Defined in Data.Primitive.SmallArray Methods pure :: a -> SmallArray a # (<*>) :: SmallArray (a -> b) -> SmallArray a -> SmallArray b # liftA2 :: (a -> b -> c) -> SmallArray a -> SmallArray b -> SmallArray c # (*>) :: SmallArray a -> SmallArray b -> SmallArray b # (<*) :: SmallArray a -> SmallArray b -> SmallArray a # | |
| Applicative Array | |
| Applicative Rules | |
| Applicative Action | |
| Applicative Id | |
| Applicative Box | |
| Applicative P | Since: base-4.5.0.0 |
| Applicative (Either e) | Since: base-3.0 |
| Applicative (U1 :: Type -> Type) | Since: base-4.9.0.0 |
| Monoid a => Applicative ((,) a) | For tuples, the ("hello ", (+15)) <*> ("world!", 2002)
("hello world!",2017)Since: base-2.1 |
| Applicative (ST s) | Since: base-4.4.0.0 |
| Representable f => Applicative (Co f) | |
| Applicative (Parser i) | |
| Applicative (ST s) | Since: base-2.1 |
| Monad m => Applicative (WrappedMonad m) | Since: base-2.1 |
Defined in Control.Applicative Methods pure :: a -> WrappedMonad m a # (<*>) :: WrappedMonad m (a -> b) -> WrappedMonad m a -> WrappedMonad m b # liftA2 :: (a -> b -> c) -> WrappedMonad m a -> WrappedMonad m b -> WrappedMonad m c # (*>) :: WrappedMonad m a -> WrappedMonad m b -> WrappedMonad m b # (<*) :: WrappedMonad m a -> WrappedMonad m b -> WrappedMonad m a # | |
| Arrow a => Applicative (ArrowMonad a) | Since: base-4.6.0.0 |
Defined in Control.Arrow Methods pure :: a0 -> ArrowMonad a a0 # (<*>) :: ArrowMonad a (a0 -> b) -> ArrowMonad a a0 -> ArrowMonad a b # liftA2 :: (a0 -> b -> c) -> ArrowMonad a a0 -> ArrowMonad a b -> ArrowMonad a c # (*>) :: ArrowMonad a a0 -> ArrowMonad a b -> ArrowMonad a b # (<*) :: ArrowMonad a a0 -> ArrowMonad a b -> ArrowMonad a a0 # | |
| Applicative (Proxy :: Type -> Type) | Since: base-4.7.0.0 |
| (Functor m, Monad m) => Applicative (MaybeT m) | |
| Monad m => Applicative (ZipSource m) | |
Defined in Data.Conduit.Internal.Conduit | |
| Applicative m => Applicative (ResourceT m) | |
Defined in Control.Monad.Trans.Resource.Internal | |
| Applicative (Eff r) | |
| Alternative f => Applicative (Cofree f) | |
| Functor f => Applicative (Free f) | |
| Applicative f => Applicative (Yoneda f) | |
| Applicative (ReifiedGetter s) | |
Defined in Control.Lens.Reified Methods pure :: a -> ReifiedGetter s a # (<*>) :: ReifiedGetter s (a -> b) -> ReifiedGetter s a -> ReifiedGetter s b # liftA2 :: (a -> b -> c) -> ReifiedGetter s a -> ReifiedGetter s b -> ReifiedGetter s c # (*>) :: ReifiedGetter s a -> ReifiedGetter s b -> ReifiedGetter s b # (<*) :: ReifiedGetter s a -> ReifiedGetter s b -> ReifiedGetter s a # | |
| Applicative (ReifiedFold s) | |
Defined in Control.Lens.Reified Methods pure :: a -> ReifiedFold s a # (<*>) :: ReifiedFold s (a -> b) -> ReifiedFold s a -> ReifiedFold s b # liftA2 :: (a -> b -> c) -> ReifiedFold s a -> ReifiedFold s b -> ReifiedFold s c # (*>) :: ReifiedFold s a -> ReifiedFold s b -> ReifiedFold s b # (<*) :: ReifiedFold s a -> ReifiedFold s b -> ReifiedFold s a # | |
| Applicative f => Applicative (Indexing f) | |
Defined in Control.Lens.Internal.Indexed | |
| Applicative f => Applicative (Indexing64 f) | |
Defined in Control.Lens.Internal.Indexed Methods pure :: a -> Indexing64 f a # (<*>) :: Indexing64 f (a -> b) -> Indexing64 f a -> Indexing64 f b # liftA2 :: (a -> b -> c) -> Indexing64 f a -> Indexing64 f b -> Indexing64 f c # (*>) :: Indexing64 f a -> Indexing64 f b -> Indexing64 f b # (<*) :: Indexing64 f a -> Indexing64 f b -> Indexing64 f a # | |
| Applicative m => Applicative (ListT m) | |
| (Applicative (Rep p), Representable p) => Applicative (Prep p) | |
| Applicative f => Applicative (Rec1 f) | Since: base-4.9.0.0 |
| Arrow a => Applicative (WrappedArrow a b) | Since: base-2.1 |
Defined in Control.Applicative Methods pure :: a0 -> WrappedArrow a b a0 # (<*>) :: WrappedArrow a b (a0 -> b0) -> WrappedArrow a b a0 -> WrappedArrow a b b0 # liftA2 :: (a0 -> b0 -> c) -> WrappedArrow a b a0 -> WrappedArrow a b b0 -> WrappedArrow a b c # (*>) :: WrappedArrow a b a0 -> WrappedArrow a b b0 -> WrappedArrow a b b0 # (<*) :: WrappedArrow a b a0 -> WrappedArrow a b b0 -> WrappedArrow a b a0 # | |
| Monoid m => Applicative (Const m :: Type -> Type) | Since: base-2.0.1 |
| Applicative f => Applicative (Ap f) | Since: base-4.12.0.0 |
| Applicative f => Applicative (Alt f) | Since: base-4.8.0.0 |
| Biapplicative p => Applicative (Join p) | |
| Biapplicative p => Applicative (Fix p) | |
| Applicative m => Applicative (IdentityT m) | |
Defined in Control.Monad.Trans.Identity | |
| (Monoid w, Applicative m) => Applicative (WriterT w m) | |
Defined in Control.Monad.Trans.Writer.Strict | |
| (Monoid w, Applicative m) => Applicative (WriterT w m) | |
Defined in Control.Monad.Trans.Writer.Lazy | |
| (Functor m, Monad m) => Applicative (StateT s m) | |
Defined in Control.Monad.Trans.State.Strict | |
| (Functor m, Monad m) => Applicative (StateT s m) | |
Defined in Control.Monad.Trans.State.Lazy | |
| (Functor m, Monad m) => Applicative (ExceptT e m) | |
Defined in Control.Monad.Trans.Except | |
| Monad m => Applicative (ZipSink i m) | |
Defined in Data.Conduit.Internal.Conduit | |
| (Applicative f, Monad f) => Applicative (WhenMissing f x) | Equivalent to Since: containers-0.5.9 |
Defined in Data.IntMap.Internal Methods pure :: a -> WhenMissing f x a # (<*>) :: WhenMissing f x (a -> b) -> WhenMissing f x a -> WhenMissing f x b # liftA2 :: (a -> b -> c) -> WhenMissing f x a -> WhenMissing f x b -> WhenMissing f x c # (*>) :: WhenMissing f x a -> WhenMissing f x b -> WhenMissing f x b # (<*) :: WhenMissing f x a -> WhenMissing f x b -> WhenMissing f x a # | |
| (Functor f, Monad m) => Applicative (FreeT f m) | |
Defined in Control.Monad.Trans.Free | |
| (Alternative f, Applicative w) => Applicative (CofreeT f w) | |
Defined in Control.Comonad.Trans.Cofree | |
| (Applicative f, Applicative g) => Applicative (Day f g) | |
| (Functor m, Monad m) => Applicative (ErrorT e m) | |
Defined in Control.Monad.Trans.Error | |
| Applicative (Mafic a b) | |
Defined in Control.Lens.Internal.Magma | |
| Applicative (Flows i b) | This is an illegal |
Defined in Control.Lens.Internal.Level | |
| Applicative (Indexed i a) | |
Defined in Control.Lens.Internal.Indexed | |
| Applicative (RAW ro rw) | |
Defined in Development.Shake.Internal.Core.Monad | |
| Applicative (Tagged s) | |
| (Monoid w, Functor m, Monad m) => Applicative (AccumT w m) | |
Defined in Control.Monad.Trans.Accum | |
| (Functor m, Monad m) => Applicative (SelectT r m) | |
Defined in Control.Monad.Trans.Select | |
| Applicative (Mag a b) | |
| Monoid m => Applicative (Holes t m) | |
| Applicative ((->) a :: Type -> Type) | Since: base-2.1 |
| Monoid c => Applicative (K1 i c :: Type -> Type) | Since: base-4.12.0.0 |
| (Applicative f, Applicative g) => Applicative (f :*: g) | Since: base-4.9.0.0 |
| (Applicative f, Applicative g) => Applicative (Product f g) | Since: base-4.9.0.0 |
Defined in Data.Functor.Product | |
| Applicative m => Applicative (ReaderT r m) | |
Defined in Control.Monad.Trans.Reader | |
| Applicative (ConduitT i o m) | |
Defined in Data.Conduit.Internal.Conduit Methods pure :: a -> ConduitT i o m a # (<*>) :: ConduitT i o m (a -> b) -> ConduitT i o m a -> ConduitT i o m b # liftA2 :: (a -> b -> c) -> ConduitT i o m a -> ConduitT i o m b -> ConduitT i o m c # (*>) :: ConduitT i o m a -> ConduitT i o m b -> ConduitT i o m b # (<*) :: ConduitT i o m a -> ConduitT i o m b -> ConduitT i o m a # | |
| Monad m => Applicative (ZipConduit i o m) | |
Defined in Data.Conduit.Internal.Conduit Methods pure :: a -> ZipConduit i o m a # (<*>) :: ZipConduit i o m (a -> b) -> ZipConduit i o m a -> ZipConduit i o m b # liftA2 :: (a -> b -> c) -> ZipConduit i o m a -> ZipConduit i o m b -> ZipConduit i o m c # (*>) :: ZipConduit i o m a -> ZipConduit i o m b -> ZipConduit i o m b # (<*) :: ZipConduit i o m a -> ZipConduit i o m b -> ZipConduit i o m a # | |
| (Monad f, Applicative f) => Applicative (WhenMatched f x y) | Equivalent to Since: containers-0.5.9 |
Defined in Data.IntMap.Internal Methods pure :: a -> WhenMatched f x y a # (<*>) :: WhenMatched f x y (a -> b) -> WhenMatched f x y a -> WhenMatched f x y b # liftA2 :: (a -> b -> c) -> WhenMatched f x y a -> WhenMatched f x y b -> WhenMatched f x y c # (*>) :: WhenMatched f x y a -> WhenMatched f x y b -> WhenMatched f x y b # (<*) :: WhenMatched f x y a -> WhenMatched f x y b -> WhenMatched f x y a # | |
| (Applicative f, Monad f) => Applicative (WhenMissing f k x) | Equivalent to Since: containers-0.5.9 |
Defined in Data.Map.Internal Methods pure :: a -> WhenMissing f k x a # (<*>) :: WhenMissing f k x (a -> b) -> WhenMissing f k x a -> WhenMissing f k x b # liftA2 :: (a -> b -> c) -> WhenMissing f k x a -> WhenMissing f k x b -> WhenMissing f k x c # (*>) :: WhenMissing f k x a -> WhenMissing f k x b -> WhenMissing f k x b # (<*) :: WhenMissing f k x a -> WhenMissing f k x b -> WhenMissing f k x a # | |
| Applicative (Molten i a b) | |
Defined in Control.Lens.Internal.Magma Methods pure :: a0 -> Molten i a b a0 # (<*>) :: Molten i a b (a0 -> b0) -> Molten i a b a0 -> Molten i a b b0 # liftA2 :: (a0 -> b0 -> c) -> Molten i a b a0 -> Molten i a b b0 -> Molten i a b c # (*>) :: Molten i a b a0 -> Molten i a b b0 -> Molten i a b b0 # (<*) :: Molten i a b a0 -> Molten i a b b0 -> Molten i a b a0 # | |
| Applicative (Bazaar p a b) | |
Defined in Control.Lens.Internal.Bazaar Methods pure :: a0 -> Bazaar p a b a0 # (<*>) :: Bazaar p a b (a0 -> b0) -> Bazaar p a b a0 -> Bazaar p a b b0 # liftA2 :: (a0 -> b0 -> c) -> Bazaar p a b a0 -> Bazaar p a b b0 -> Bazaar p a b c # (*>) :: Bazaar p a b a0 -> Bazaar p a b b0 -> Bazaar p a b b0 # (<*) :: Bazaar p a b a0 -> Bazaar p a b b0 -> Bazaar p a b a0 # | |
| Applicative (ContT r m) | |
Defined in Control.Monad.Trans.Cont | |
| Applicative (ParsecT s u m) | |
Defined in Text.Parsec.Prim Methods pure :: a -> ParsecT s u m a # (<*>) :: ParsecT s u m (a -> b) -> ParsecT s u m a -> ParsecT s u m b # liftA2 :: (a -> b -> c) -> ParsecT s u m a -> ParsecT s u m b -> ParsecT s u m c # (*>) :: ParsecT s u m a -> ParsecT s u m b -> ParsecT s u m b # (<*) :: ParsecT s u m a -> ParsecT s u m b -> ParsecT s u m a # | |
| Applicative f => Applicative (M1 i c f) | Since: base-4.9.0.0 |
| (Applicative f, Applicative g) => Applicative (f :.: g) | Since: base-4.9.0.0 |
| (Applicative f, Applicative g) => Applicative (Compose f g) | Since: base-4.9.0.0 |
Defined in Data.Functor.Compose | |
| (Monoid w, Functor m, Monad m) => Applicative (RWST r w s m) | |
Defined in Control.Monad.Trans.RWS.Strict | |
| (Monoid w, Functor m, Monad m) => Applicative (RWST r w s m) | |
Defined in Control.Monad.Trans.RWS.Lazy | |
| (Monad f, Applicative f) => Applicative (WhenMatched f k x y) | Equivalent to Since: containers-0.5.9 |
Defined in Data.Map.Internal Methods pure :: a -> WhenMatched f k x y a # (<*>) :: WhenMatched f k x y (a -> b) -> WhenMatched f k x y a -> WhenMatched f k x y b # liftA2 :: (a -> b -> c) -> WhenMatched f k x y a -> WhenMatched f k x y b -> WhenMatched f k x y c # (*>) :: WhenMatched f k x y a -> WhenMatched f k x y b -> WhenMatched f k x y b # (<*) :: WhenMatched f k x y a -> WhenMatched f k x y b -> WhenMatched f k x y a # | |
| Applicative (TakingWhile p f a b) | |
Defined in Control.Lens.Internal.Magma Methods pure :: a0 -> TakingWhile p f a b a0 # (<*>) :: TakingWhile p f a b (a0 -> b0) -> TakingWhile p f a b a0 -> TakingWhile p f a b b0 # liftA2 :: (a0 -> b0 -> c) -> TakingWhile p f a b a0 -> TakingWhile p f a b b0 -> TakingWhile p f a b c # (*>) :: TakingWhile p f a b a0 -> TakingWhile p f a b b0 -> TakingWhile p f a b b0 # (<*) :: TakingWhile p f a b a0 -> TakingWhile p f a b b0 -> TakingWhile p f a b a0 # | |
| Applicative (BazaarT p g a b) | |
Defined in Control.Lens.Internal.Bazaar Methods pure :: a0 -> BazaarT p g a b a0 # (<*>) :: BazaarT p g a b (a0 -> b0) -> BazaarT p g a b a0 -> BazaarT p g a b b0 # liftA2 :: (a0 -> b0 -> c) -> BazaarT p g a b a0 -> BazaarT p g a b b0 -> BazaarT p g a b c # (*>) :: BazaarT p g a b a0 -> BazaarT p g a b b0 -> BazaarT p g a b b0 # (<*) :: BazaarT p g a b a0 -> BazaarT p g a b b0 -> BazaarT p g a b a0 # | |
| Reifies s (ReifiedApplicative f) => Applicative (ReflectedApplicative f s) | |
Defined in Data.Reflection Methods pure :: a -> ReflectedApplicative f s a # (<*>) :: ReflectedApplicative f s (a -> b) -> ReflectedApplicative f s a -> ReflectedApplicative f s b # liftA2 :: (a -> b -> c) -> ReflectedApplicative f s a -> ReflectedApplicative f s b -> ReflectedApplicative f s c # (*>) :: ReflectedApplicative f s a -> ReflectedApplicative f s b -> ReflectedApplicative f s b # (<*) :: ReflectedApplicative f s a -> ReflectedApplicative f s b -> ReflectedApplicative f s a # | |
| Monad m => Applicative (Pipe l i o u m) | |
Defined in Data.Conduit.Internal.Pipe Methods pure :: a -> Pipe l i o u m a # (<*>) :: Pipe l i o u m (a -> b) -> Pipe l i o u m a -> Pipe l i o u m b # liftA2 :: (a -> b -> c) -> Pipe l i o u m a -> Pipe l i o u m b -> Pipe l i o u m c # (*>) :: Pipe l i o u m a -> Pipe l i o u m b -> Pipe l i o u m b # (<*) :: Pipe l i o u m a -> Pipe l i o u m b -> Pipe l i o u m a # | |
foldr :: Foldable t => (a -> b -> b) -> b -> t a -> b #
Right-associative fold of a structure.
In the case of lists, foldr, when applied to a binary operator, a
starting value (typically the right-identity of the operator), and a
list, reduces the list using the binary operator, from right to left:
foldr f z [x1, x2, ..., xn] == x1 `f` (x2 `f` ... (xn `f` z)...)
Note that, since the head of the resulting expression is produced by
an application of the operator to the first element of the list,
foldr can produce a terminating expression from an infinite list.
For a general Foldable structure this should be semantically identical
to,
foldr f z =foldrf z .toList
length :: Foldable t => t a -> Int #
Returns the size/length of a finite structure as an Int. The
default implementation is optimized for structures that are similar to
cons-lists, because there is no general way to do better.
null :: Foldable t => t a -> Bool #
Test whether the structure is empty. The default implementation is optimized for structures that are similar to cons-lists, because there is no general way to do better.
foldl :: Foldable t => (b -> a -> b) -> b -> t a -> b #
Left-associative fold of a structure.
In the case of lists, foldl, when applied to a binary
operator, a starting value (typically the left-identity of the operator),
and a list, reduces the list using the binary operator, from left to
right:
foldl f z [x1, x2, ..., xn] == (...((z `f` x1) `f` x2) `f`...) `f` xn
Note that to produce the outermost application of the operator the
entire input list must be traversed. This means that foldl' will
diverge if given an infinite list.
Also note that if you want an efficient left-fold, you probably want to
use foldl' instead of foldl. The reason for this is that latter does
not force the "inner" results (e.g. z in the above example)
before applying them to the operator (e.g. to f x1(). This results
in a thunk chain f x2)O(n) elements long, which then must be evaluated from
the outside-in.
For a general Foldable structure this should be semantically identical
to,
foldl f z =foldlf z .toList
foldl' :: Foldable t => (b -> a -> b) -> b -> t a -> b #
Left-associative fold of a structure but with strict application of the operator.
This ensures that each step of the fold is forced to weak head normal
form before being applied, avoiding the collection of thunks that would
otherwise occur. This is often what you want to strictly reduce a finite
list to a single, monolithic result (e.g. length).
For a general Foldable structure this should be semantically identical
to,
foldl f z =foldl'f z .toList
sum :: (Foldable t, Num a) => t a -> a #
The sum function computes the sum of the numbers of a structure.
product :: (Foldable t, Num a) => t a -> a #
The product function computes the product of the numbers of a
structure.
mapM :: (Traversable t, Monad m) => (a -> m b) -> t a -> m (t b) #
Map each element of a structure to a monadic action, evaluate
these actions from left to right, and collect the results. For
a version that ignores the results see mapM_.
sequence :: (Traversable t, Monad m) => t (m a) -> m (t a) #
Evaluate each monadic action in the structure from left to
right, and collect the results. For a version that ignores the
results see sequence_.
class Semigroup a => Monoid a where #
The class of monoids (types with an associative binary operation that has an identity). Instances should satisfy the following laws:
x
<>mempty= xmempty<>x = xx(<>(y<>z) = (x<>y)<>zSemigrouplaw)mconcat=foldr'(<>)'mempty
The method names refer to the monoid of lists under concatenation, but there are many other instances.
Some types can be viewed as a monoid in more than one way,
e.g. both addition and multiplication on numbers.
In such cases we often define newtypes and make those instances
of Monoid, e.g. Sum and Product.
NOTE: Semigroup is a superclass of Monoid since base-4.11.0.0.
Minimal complete definition
Methods
Identity of mappend
An associative operation
NOTE: This method is redundant and has the default
implementation mappend = '(<>)'
Fold a list using the monoid.
For most types, the default definition for mconcat will be
used, but the function is included in the class definition so
that an optimized version can be provided for specific types.
Instances
The Maybe type encapsulates an optional value. A value of type
Maybe aa (represented as Just aNothing). Using Maybe is a good way to
deal with errors or exceptional cases without resorting to drastic
measures such as error.
The Maybe type is also a monad. It is a simple kind of error
monad, where all errors are represented by Nothing. A richer
error monad can be built using the Either type.
Instances
| Monad Maybe | Since: base-2.1 |
| Functor Maybe | Since: base-2.1 |
| MonadFix Maybe | Since: base-2.1 |
Defined in Control.Monad.Fix | |
| MonadFail Maybe | Since: base-4.9.0.0 |
Defined in Control.Monad.Fail | |
| Applicative Maybe | Since: base-2.1 |
| Foldable Maybe | Since: base-2.1 |
Defined in Data.Foldable Methods fold :: Monoid m => Maybe m -> m # foldMap :: Monoid m => (a -> m) -> Maybe a -> m # foldr :: (a -> b -> b) -> b -> Maybe a -> b # foldr' :: (a -> b -> b) -> b -> Maybe a -> b # foldl :: (b -> a -> b) -> b -> Maybe a -> b # foldl' :: (b -> a -> b) -> b -> Maybe a -> b # foldr1 :: (a -> a -> a) -> Maybe a -> a # foldl1 :: (a -> a -> a) -> Maybe a -> a # elem :: Eq a => a -> Maybe a -> Bool # maximum :: Ord a => Maybe a -> a # minimum :: Ord a => Maybe a -> a # | |
| Traversable Maybe | Since: base-2.1 |
| Arbitrary1 Maybe | |
Defined in Test.QuickCheck.Arbitrary | |
| ToJSON1 Maybe | |
Defined in Data.Aeson.Types.ToJSON Methods liftToJSON :: (a -> Value) -> ([a] -> Value) -> Maybe a -> Value # liftToJSONList :: (a -> Value) -> ([a] -> Value) -> [Maybe a] -> Value # liftToEncoding :: (a -> Encoding) -> ([a] -> Encoding) -> Maybe a -> Encoding # liftToEncodingList :: (a -> Encoding) -> ([a] -> Encoding) -> [Maybe a] -> Encoding # | |
| FromJSON1 Maybe | |
| Alternative Maybe | Since: base-2.1 |
| MonadPlus Maybe | Since: base-2.1 |
| Eq1 Maybe | Since: base-4.9.0.0 |
| Ord1 Maybe | Since: base-4.9.0.0 |
Defined in Data.Functor.Classes | |
| Read1 Maybe | Since: base-4.9.0.0 |
Defined in Data.Functor.Classes | |
| Show1 Maybe | Since: base-4.9.0.0 |
| MonadThrow Maybe | |
Defined in Control.Monad.Catch | |
| NFData1 Maybe | Since: deepseq-1.4.3.0 |
Defined in Control.DeepSeq | |
| Hashable1 Maybe | |
Defined in Data.Hashable.Class | |
| MonadBaseControl Maybe Maybe | |
| MonadError () Maybe | Since: mtl-2.2.2 |
Defined in Control.Monad.Error.Class | |
| FunctorWithIndex () Maybe | |
Defined in Control.Lens.Indexed | |
| FoldableWithIndex () Maybe | |
| TraversableWithIndex () Maybe | |
Defined in Control.Lens.Indexed Methods itraverse :: Applicative f => (() -> a -> f b) -> Maybe a -> f (Maybe b) # itraversed :: IndexedTraversal () (Maybe a) (Maybe b) a b # | |
| MonadBase Maybe Maybe | |
Defined in Control.Monad.Base | |
| (Selector s, GToJSON enc arity (K1 i (Maybe a) :: Type -> Type), KeyValuePair enc pairs, Monoid pairs) => RecordToPairs enc pairs arity (S1 s (K1 i (Maybe a) :: Type -> Type)) | |
Defined in Data.Aeson.Types.ToJSON | |
| (Selector s, FromJSON a) => FromRecord arity (S1 s (K1 i (Maybe a) :: Type -> Type)) | |
Defined in Data.Aeson.Types.FromJSON | |
| Eq a => Eq (Maybe a) | Since: base-2.1 |
| Data a => Data (Maybe a) | Since: base-4.0.0.0 |
Defined in Data.Data Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Maybe a -> c (Maybe a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Maybe a) # toConstr :: Maybe a -> Constr # dataTypeOf :: Maybe a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Maybe a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Maybe a)) # gmapT :: (forall b. Data b => b -> b) -> Maybe a -> Maybe a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Maybe a -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Maybe a -> r # gmapQ :: (forall d. Data d => d -> u) -> Maybe a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Maybe a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Maybe a -> m (Maybe a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Maybe a -> m (Maybe a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Maybe a -> m (Maybe a) # | |
| Ord a => Ord (Maybe a) | Since: base-2.1 |
| Read a => Read (Maybe a) | Since: base-2.1 |
| Show a => Show (Maybe a) | Since: base-2.1 |
| Generic (Maybe a) | |
| Semigroup a => Semigroup (Maybe a) | Since: base-4.9.0.0 |
| Semigroup a => Monoid (Maybe a) | Lift a semigroup into Since 4.11.0: constraint on inner Since: base-2.1 |
| Lift a => Lift (Maybe a) | |
| Testable prop => Testable (Maybe prop) | |
| Function a => Function (Maybe a) | |
| Arbitrary a => Arbitrary (Maybe a) | |
| CoArbitrary a => CoArbitrary (Maybe a) | |
Defined in Test.QuickCheck.Arbitrary Methods coarbitrary :: Maybe a -> Gen b -> Gen b # | |
| Hashable a => Hashable (Maybe a) | |
Defined in Data.Hashable.Class | |
| ToJSON a => ToJSON (Maybe a) | |
Defined in Data.Aeson.Types.ToJSON | |
| FromJSON a => FromJSON (Maybe a) | |
| SingKind a => SingKind (Maybe a) | Since: base-4.9.0.0 |
Defined in GHC.Generics | |
| Binary a => Binary (Maybe a) | |
| NFData a => NFData (Maybe a) | |
Defined in Control.DeepSeq | |
| Ixed (Maybe a) | |
Defined in Control.Lens.At | |
| At (Maybe a) | |
| AsEmpty (Maybe a) | |
Defined in Control.Lens.Empty | |
| MonoFunctor (Maybe a) | |
| MonoFoldable (Maybe a) | |
Defined in Data.MonoTraversable Methods ofoldMap :: Monoid m => (Element (Maybe a) -> m) -> Maybe a -> m # ofoldr :: (Element (Maybe a) -> b -> b) -> b -> Maybe a -> b # ofoldl' :: (a0 -> Element (Maybe a) -> a0) -> a0 -> Maybe a -> a0 # otoList :: Maybe a -> [Element (Maybe a)] # oall :: (Element (Maybe a) -> Bool) -> Maybe a -> Bool # oany :: (Element (Maybe a) -> Bool) -> Maybe a -> Bool # olength64 :: Maybe a -> Int64 # ocompareLength :: Integral i => Maybe a -> i -> Ordering # otraverse_ :: Applicative f => (Element (Maybe a) -> f b) -> Maybe a -> f () # ofor_ :: Applicative f => Maybe a -> (Element (Maybe a) -> f b) -> f () # omapM_ :: Applicative m => (Element (Maybe a) -> m ()) -> Maybe a -> m () # oforM_ :: Applicative m => Maybe a -> (Element (Maybe a) -> m ()) -> m () # ofoldlM :: Monad m => (a0 -> Element (Maybe a) -> m a0) -> a0 -> Maybe a -> m a0 # ofoldMap1Ex :: Semigroup m => (Element (Maybe a) -> m) -> Maybe a -> m # ofoldr1Ex :: (Element (Maybe a) -> Element (Maybe a) -> Element (Maybe a)) -> Maybe a -> Element (Maybe a) # ofoldl1Ex' :: (Element (Maybe a) -> Element (Maybe a) -> Element (Maybe a)) -> Maybe a -> Element (Maybe a) # headEx :: Maybe a -> Element (Maybe a) # lastEx :: Maybe a -> Element (Maybe a) # unsafeHead :: Maybe a -> Element (Maybe a) # unsafeLast :: Maybe a -> Element (Maybe a) # maximumByEx :: (Element (Maybe a) -> Element (Maybe a) -> Ordering) -> Maybe a -> Element (Maybe a) # minimumByEx :: (Element (Maybe a) -> Element (Maybe a) -> Ordering) -> Maybe a -> Element (Maybe a) # | |
| MonoTraversable (Maybe a) | |
| MonoPointed (Maybe a) | |
| PrettyVal a => PrettyVal (Maybe a) | |
| IsCmdArgument a => IsCmdArgument (Maybe a) | |
Defined in Development.Shake.Command Methods toCmdArgument :: Maybe a -> CmdArgument # | |
| Generic1 Maybe | |
| SingI (Nothing :: Maybe a) | Since: base-4.9.0.0 |
Defined in GHC.Generics | |
| Each (Maybe a) (Maybe b) a b |
|
| SingI a2 => SingI (Just a2 :: Maybe a1) | Since: base-4.9.0.0 |
Defined in GHC.Generics | |
| type StM Maybe a | |
Defined in Control.Monad.Trans.Control | |
| type Rep (Maybe a) | Since: base-4.6.0.0 |
| data Sing (b :: Maybe a) | |
| type DemoteRep (Maybe a) | |
Defined in GHC.Generics | |
| type Index (Maybe a) | |
Defined in Control.Lens.At | |
| type IxValue (Maybe a) | |
Defined in Control.Lens.At | |
| type Element (Maybe a) | |
Defined in Data.MonoTraversable | |
| type Rep1 Maybe | Since: base-4.6.0.0 |
lines breaks a string up into a list of strings at newline
characters. The resulting strings do not contain newlines.
Note that after splitting the string at newline characters, the last part of the string is considered a line even if it doesn't end with a newline. For example,
>>>lines ""[]
>>>lines "\n"[""]
>>>lines "one"["one"]
>>>lines "one\n"["one"]
>>>lines "one\n\n"["one",""]
>>>lines "one\ntwo"["one","two"]
>>>lines "one\ntwo\n"["one","two"]
Thus lines ss.
A Version represents the version of a software entity.
An instance of Eq is provided, which implements exact equality
modulo reordering of the tags in the versionTags field.
An instance of Ord is also provided, which gives lexicographic
ordering on the versionBranch fields (i.e. 2.1 > 2.0, 1.2.3 > 1.2.2,
etc.). This is expected to be sufficient for many uses, but note that
you may need to use a more specific ordering for your versioning
scheme. For example, some versioning schemes may include pre-releases
which have tags "pre1", "pre2", and so on, and these would need to
be taken into account when determining ordering. In some cases, date
ordering may be more appropriate, so the application would have to
look for date tags in the versionTags field and compare those.
The bottom line is, don't always assume that compare and other Ord
operations are the right thing for every Version.
Similarly, concrete representations of versions may differ. One
possible concrete representation is provided (see showVersion and
parseVersion), but depending on the application a different concrete
representation may be more appropriate.
Constructors
| Version | |
Fields
| |
Instances
| IsList Version | Since: base-4.8.0.0 |
| Eq Version | Since: base-2.1 |
| Data Version | Since: base-4.7.0.0 |
Defined in Data.Data Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Version -> c Version # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Version # toConstr :: Version -> Constr # dataTypeOf :: Version -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Version) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Version) # gmapT :: (forall b. Data b => b -> b) -> Version -> Version # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r # gmapQ :: (forall d. Data d => d -> u) -> Version -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Version -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Version -> m Version # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version # | |
| Ord Version | Since: base-2.1 |
| Read Version | Since: base-2.1 |
| Show Version | Since: base-2.1 |
| Generic Version | |
| Arbitrary Version | Generates |
| CoArbitrary Version | |
Defined in Test.QuickCheck.Arbitrary Methods coarbitrary :: Version -> Gen b -> Gen b # | |
| Hashable Version | |
Defined in Data.Hashable.Class | |
| ToJSON Version | |
Defined in Data.Aeson.Types.ToJSON | |
| ToJSONKey Version | |
Defined in Data.Aeson.Types.ToJSON | |
| FromJSON Version | |
| FromJSONKey Version | |
Defined in Data.Aeson.Types.FromJSON Methods | |
| Binary Version | Since: 0.8.0.0 |
| NFData Version | Since: deepseq-1.3.0.0 |
Defined in Control.DeepSeq | |
| type Rep Version | Since: base-4.9.0.0 |
Defined in Data.Version type Rep Version = D1 (MetaData "Version" "Data.Version" "base" False) (C1 (MetaCons "Version" PrefixI True) (S1 (MetaSel (Just "versionBranch") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Int]) :*: S1 (MetaSel (Just "versionTags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]))) | |
| type Item Version | |
Arguments
| :: MonadReader r m | |
| => (r -> r) | The function to modify the environment. |
| -> m a |
|
| -> m a |
Executes a computation in a modified environment.
ask :: MonadReader r m => m r #
Retrieves the monad environment.
data ByteString #
A space-efficient representation of a Word8 vector, supporting many
efficient operations.
A ByteString contains 8-bit bytes, or by using the operations from
Data.ByteString.Char8 it can be interpreted as containing 8-bit
characters.
Instances
(<$>) :: Functor f => (a -> b) -> f a -> f b infixl 4 #
An infix synonym for fmap.
The name of this operator is an allusion to $.
Note the similarities between their types:
($) :: (a -> b) -> a -> b (<$>) :: Functor f => (a -> b) -> f a -> f b
Whereas $ is function application, <$> is function
application lifted over a Functor.
Examples
Convert from a Maybe IntMaybe Stringshow:
>>>show <$> NothingNothing>>>show <$> Just 3Just "3"
Convert from an Either Int IntEither IntString using show:
>>>show <$> Left 17Left 17>>>show <$> Right 17Right "17"
Double each element of a list:
>>>(*2) <$> [1,2,3][2,4,6]
Apply even to the second element of a pair:
>>>even <$> (2,2)(2,True)
A space efficient, packed, unboxed Unicode text type.
Instances
class Applicative f => Alternative (f :: Type -> Type) where #
A monoid on applicative functors.
If defined, some and many should be the least solutions
of the equations:
Methods
The identity of <|>
(<|>) :: f a -> f a -> f a infixl 3 #
An associative binary operation
One or more.
Zero or more.
Instances
class (Alternative m, Monad m) => MonadPlus (m :: Type -> Type) where #
Monads that also support choice and failure.
Minimal complete definition
Nothing
Methods
The identity of mplus. It should also satisfy the equations
mzero >>= f = mzero v >> mzero = mzero
The default definition is
mzero = empty
An associative operation. The default definition is
mplus = (<|>)
Instances
class Monad m => MonadIO (m :: Type -> Type) 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:
Instances
exitWith :: ExitCode -> IO a #
Computation exitWith code throws ExitCode code.
Normally this terminates the program, returning code to the
program's caller.
On program termination, the standard Handles stdout and
stderr are flushed automatically; any other buffered Handles
need to be flushed manually, otherwise the buffered data will be
discarded.
A program that fails in any other way is treated as if it had
called exitFailure.
A program that terminates successfully without calling exitWith
explicitly is treated as if it had called exitWith ExitSuccess.
As an ExitCode is not an IOException, exitWith bypasses
the error handling in the IO monad and cannot be intercepted by
catch from the Prelude. However it is a SomeException, and can
be caught using the functions of Control.Exception. This means
that cleanup computations added with bracket
(from Control.Exception) are also executed properly on exitWith.
Note: in GHC, exitWith should be called from the main program
thread in order to exit the process. When called from another
thread, exitWith will throw an ExitException as normal, but the
exception will not cause the process itself to exit.
printf :: PrintfType r => String -> r #
Format a variable number of arguments with the C-style formatting string.
>>>printf "%s, %d, %.4f" "hello" 123 pihello, 123, 3.1416
The return value is either String or ( (which
should be IO a)(, but Haskell's type system
makes this hard).IO '()')
The format string consists of ordinary characters and
conversion specifications, which specify how to format
one of the arguments to printf in the output string. A
format specification is introduced by the % character;
this character can be self-escaped into the format string
using %%. A format specification ends with a /format
character/ that provides the primary information about
how to format the value. The rest of the conversion
specification is optional. In order, one may have flag
characters, a width specifier, a precision specifier, and
type-specific modifier characters.
Unlike C printf(3), the formatting of this printf
is driven by the argument type; formatting is type specific. The
types formatted by printf "out of the box" are:
printf is also extensible to support other types: see below.
A conversion specification begins with the
character %, followed by zero or more of the following flags:
- left adjust (default is right adjust) + always use a sign (+ or -) for signed conversions space leading space for positive numbers in signed conversions 0 pad with zeros rather than spaces # use an \"alternate form\": see below
When both flags are given, - overrides 0 and + overrides space.
A negative width specifier in a * conversion is treated as
positive but implies the left adjust flag.
The "alternate form" for unsigned radix conversions is
as in C printf(3):
%o prefix with a leading 0 if needed %x prefix with a leading 0x if nonzero %X prefix with a leading 0X if nonzero %b prefix with a leading 0b if nonzero %[eEfFgG] ensure that the number contains a decimal point
Any flags are followed optionally by a field width:
num field width * as num, but taken from argument list
The field width is a minimum, not a maximum: it will be expanded as needed to avoid mutilating a value.
Any field width is followed optionally by a precision:
.num precision . same as .0 .* as num, but taken from argument list
Negative precision is taken as 0. The meaning of the precision depends on the conversion type.
Integral minimum number of digits to show RealFloat number of digits after the decimal point String maximum number of characters
The precision for Integral types is accomplished by zero-padding. If both precision and zero-pad are given for an Integral field, the zero-pad is ignored.
Any precision is followed optionally for Integral types by a width modifier; the only use of this modifier being to set the implicit size of the operand for conversion of a negative operand to unsigned:
hh Int8 h Int16 l Int32 ll Int64 L Int64
The specification ends with a format character:
c character Integral d decimal Integral o octal Integral x hexadecimal Integral X hexadecimal Integral b binary Integral u unsigned decimal Integral f floating point RealFloat F floating point RealFloat g general format float RealFloat G general format float RealFloat e exponent format float RealFloat E exponent format float RealFloat s string String v default format any type
The "%v" specifier is provided for all built-in types, and should be provided for user-defined type formatters as well. It picks a "best" representation for the given type. For the built-in types the "%v" specifier is converted as follows:
c Char u other unsigned Integral d other signed Integral g RealFloat s String
Mismatch between the argument types and the format string, as well as any other syntactic or semantic errors in the format string, will cause an exception to be thrown at runtime.
Note that the formatting for RealFloat types is
currently a bit different from that of C printf(3),
conforming instead to showEFloat,
showFFloat and showGFloat (and their
alternate versions showFFloatAlt and
showGFloatAlt). This is hard to fix: the fixed
versions would format in a backward-incompatible way.
In any case the Haskell behavior is generally more
sensible than the C behavior. A brief summary of some
key differences:
- Haskell
printfnever uses the default "6-digit" precision used by C printf. - Haskell
printftreats the "precision" specifier as indicating the number of digits after the decimal point. - Haskell
printfprints the exponent of e-format numbers without a gratuitous plus sign, and with the minimum possible number of digits. - Haskell
printfwill place a zero after a decimal point when possible.
unless :: Applicative f => Bool -> f () -> f () #
The reverse of when.
replicateM_ :: Applicative m => Int -> m a -> m () #
Like replicateM, but discards the result.
replicateM :: Applicative m => Int -> m a -> m [a] #
replicateM n actn times,
gathering the results.
foldM_ :: (Foldable t, Monad m) => (b -> a -> m b) -> b -> t a -> m () #
Like foldM, but discards the result.
foldM :: (Foldable t, Monad m) => (b -> a -> m b) -> b -> t a -> m b #
The foldM function is analogous to foldl, except that its result is
encapsulated in a monad. Note that foldM works from left-to-right over
the list arguments. This could be an issue where ( and the `folded
function' are not commutative.>>)
foldM f a1 [x1, x2, ..., xm] == do a2 <- f a1 x1 a3 <- f a2 x2 ... f am xm
If right-to-left evaluation is required, the input list should be reversed.
zipWithM_ :: Applicative m => (a -> b -> m c) -> [a] -> [b] -> m () #
zipWithM :: Applicative m => (a -> b -> m c) -> [a] -> [b] -> m [c] #
mapAndUnzipM :: Applicative m => (a -> m (b, c)) -> [a] -> m ([b], [c]) #
The mapAndUnzipM function maps its first argument over a list, returning
the result as a pair of lists. This function is mainly used with complicated
data structures or a state-transforming monad.
forever :: Applicative f => f a -> f b #
Repeat an action indefinitely.
Examples
A common use of forever is to process input from network sockets,
Handles, and channels
(e.g. MVar and
Chan).
For example, here is how we might implement an echo
server, using
forever both to listen for client connections on a network socket
and to echo client input on client connection handles:
echoServer :: Socket -> IO () echoServer socket =forever$ do client <- accept socketforkFinally(echo client) (\_ -> hClose client) where echo :: Handle -> IO () echo client =forever$ hGetLine client >>= hPutStrLn client
(>=>) :: Monad m => (a -> m b) -> (b -> m c) -> a -> m c infixr 1 #
Left-to-right composition of Kleisli arrows.
filterM :: Applicative m => (a -> m Bool) -> [a] -> m [a] #
This generalizes the list-based filter function.
makeVersion :: [Int] -> Version #
Construct tag-less Version
Since: base-4.8.0.0
parseVersion :: ReadP Version #
A parser for versions in the format produced by showVersion.
showVersion :: Version -> String #
Provides one possible concrete representation for Version. For
a version with versionBranch = [1,2,3] and versionTags
= ["tag1","tag2"], the output will be 1.2.3-tag1-tag2.
isSubsequenceOf :: Eq a => [a] -> [a] -> Bool #
The isSubsequenceOf function takes two lists and returns True if all
the elements of the first list occur, in order, in the second. The
elements do not have to occur consecutively.
isSubsequenceOf x yelem x (subsequences y)
Examples
>>>isSubsequenceOf "GHC" "The Glorious Haskell Compiler"True>>>isSubsequenceOf ['a','d'..'z'] ['a'..'z']True>>>isSubsequenceOf [1..10] [10,9..0]False
Since: base-4.8.0.0
mapAccumR :: Traversable t => (a -> b -> (a, c)) -> a -> t b -> (a, t c) #
mapAccumL :: Traversable t => (a -> b -> (a, c)) -> a -> t b -> (a, t c) #
forM :: (Traversable t, Monad m) => t a -> (a -> m b) -> m (t b) #
optional :: Alternative f => f a -> f (Maybe a) #
One or none.
newtype WrappedMonad (m :: Type -> Type) a #
Constructors
| WrapMonad | |
Fields
| |
Instances
newtype WrappedArrow (a :: Type -> Type -> Type) b c #
Constructors
| WrapArrow | |
Fields
| |
Instances
Lists, but with an Applicative functor based on zipping.
Constructors
| ZipList | |
Fields
| |
Instances
| Functor ZipList | Since: base-2.1 |
| Applicative ZipList | f '<$>' 'ZipList' xs1 '<*>' ... '<*>' 'ZipList' xsN
= 'ZipList' (zipWithN f xs1 ... xsN)where (\a b c -> stimes c [a, b]) <$> ZipList "abcd" <*> ZipList "567" <*> ZipList [1..]
= ZipList (zipWith3 (\a b c -> stimes c [a, b]) "abcd" "567" [1..])
= ZipList {getZipList = ["a5","b6b6","c7c7c7"]}Since: base-2.1 |
| Foldable ZipList | Since: base-4.9.0.0 |
Defined in Control.Applicative Methods fold :: Monoid m => ZipList m -> m # foldMap :: Monoid m => (a -> m) -> ZipList a -> m # foldr :: (a -> b -> b) -> b -> ZipList a -> b # foldr' :: (a -> b -> b) -> b -> ZipList a -> b # foldl :: (b -> a -> b) -> b -> ZipList a -> b # foldl' :: (b -> a -> b) -> b -> ZipList a -> b # foldr1 :: (a -> a -> a) -> ZipList a -> a # foldl1 :: (a -> a -> a) -> ZipList a -> a # elem :: Eq a => a -> ZipList a -> Bool # maximum :: Ord a => ZipList a -> a # minimum :: Ord a => ZipList a -> a # | |
| Traversable ZipList | Since: base-4.9.0.0 |
| Arbitrary1 ZipList | |
Defined in Test.QuickCheck.Arbitrary Methods liftArbitrary :: Gen a -> Gen (ZipList a) # liftShrink :: (a -> [a]) -> ZipList a -> [ZipList a] # | |
| Alternative ZipList | Since: base-4.11.0.0 |
| NFData1 ZipList | Since: deepseq-1.4.3.0 |
Defined in Control.DeepSeq | |
| FunctorWithIndex Int ZipList | Same instance as for |
| FoldableWithIndex Int ZipList | |
Defined in Control.Lens.Indexed | |
| TraversableWithIndex Int ZipList | |
Defined in Control.Lens.Indexed Methods itraverse :: Applicative f => (Int -> a -> f b) -> ZipList a -> f (ZipList b) # itraversed :: IndexedTraversal Int (ZipList a) (ZipList b) a b # | |
| Eq a => Eq (ZipList a) | Since: base-4.7.0.0 |
| Ord a => Ord (ZipList a) | Since: base-4.7.0.0 |
| Read a => Read (ZipList a) | Since: base-4.7.0.0 |
| Show a => Show (ZipList a) | Since: base-4.7.0.0 |
| Generic (ZipList a) | |
| Arbitrary a => Arbitrary (ZipList a) | |
| CoArbitrary a => CoArbitrary (ZipList a) | |
Defined in Test.QuickCheck.Arbitrary Methods coarbitrary :: ZipList a -> Gen b -> Gen b # | |
| NFData a => NFData (ZipList a) | Since: deepseq-1.4.0.0 |
Defined in Control.DeepSeq | |
| Wrapped (ZipList a) | |
| AsEmpty (ZipList a) | |
Defined in Control.Lens.Empty | |
| MonoFunctor (ZipList a) | |
| MonoPointed (ZipList a) | |
| Generic1 ZipList | |
| t ~ ZipList b => Rewrapped (ZipList a) t | |
Defined in Control.Lens.Wrapped | |
| Cons (ZipList a) (ZipList b) a b | |
| Snoc (ZipList a) (ZipList b) a b | |
| type Rep (ZipList a) | Since: base-4.7.0.0 |
Defined in Control.Applicative | |
| type Unwrapped (ZipList a) | |
Defined in Control.Lens.Wrapped | |
| type Element (ZipList a) | |
Defined in Data.MonoTraversable | |
| type Rep1 ZipList | Since: base-4.7.0.0 |
Defined in Control.Applicative | |
Defines the exit codes that a program can return.
Constructors
| ExitSuccess | indicates successful termination; |
| ExitFailure Int | indicates program failure with an exit code. The exact interpretation of the code is operating-system dependent. In particular, some values may be prohibited (e.g. 0 on a POSIX-compliant system). |
Instances
| Eq ExitCode | |
| Ord ExitCode | |
Defined in GHC.IO.Exception | |
| Read ExitCode | |
| Show ExitCode | |
| Generic ExitCode | |
| Arbitrary ExitCode | |
| Exception ExitCode | Since: base-4.1.0.0 |
Defined in GHC.IO.Exception Methods toException :: ExitCode -> SomeException # fromException :: SomeException -> Maybe ExitCode # displayException :: ExitCode -> String # | |
| NFData ExitCode | Since: deepseq-1.4.2.0 |
Defined in Control.DeepSeq | |
| CmdResult ExitCode | |
Defined in Development.Shake.Command | |
| type Rep ExitCode | |
Defined in GHC.IO.Exception | |
newtype Const a (b :: k) :: forall k. Type -> k -> Type #
The Const functor.
Instances
| Generic1 (Const a :: k -> Type) | |
| Arbitrary2 (Const :: Type -> Type -> Type) | |
Defined in Test.QuickCheck.Arbitrary Methods liftArbitrary2 :: Gen a -> Gen b -> Gen (Const a b) # liftShrink2 :: (a -> [a]) -> (b -> [b]) -> Const a b -> [Const a b] # | |
| ToJSON2 (Const :: Type -> Type -> Type) | |
Defined in Data.Aeson.Types.ToJSON Methods liftToJSON2 :: (a -> Value) -> ([a] -> Value) -> (b -> Value) -> ([b] -> Value) -> Const a b -> Value # liftToJSONList2 :: (a -> Value) -> ([a] -> Value) -> (b -> Value) -> ([b] -> Value) -> [Const a b] -> Value # liftToEncoding2 :: (a -> Encoding) -> ([a] -> Encoding) -> (b -> Encoding) -> ([b] -> Encoding) -> Const a b -> Encoding # liftToEncodingList2 :: (a -> Encoding) -> ([a] -> Encoding) -> (b -> Encoding) -> ([b] -> Encoding) -> [Const a b] -> Encoding # | |
| FromJSON2 (Const :: Type -> Type -> Type) | |
Defined in Data.Aeson.Types.FromJSON | |
| Bifunctor (Const :: Type -> Type -> Type) | Since: base-4.8.0.0 |
| Eq2 (Const :: Type -> Type -> Type) | Since: base-4.9.0.0 |
| Ord2 (Const :: Type -> Type -> Type) | Since: base-4.9.0.0 |
Defined in Data.Functor.Classes | |
| Read2 (Const :: Type -> Type -> Type) | Since: base-4.9.0.0 |
Defined in Data.Functor.Classes Methods liftReadsPrec2 :: (Int -> ReadS a) -> ReadS [a] -> (Int -> ReadS b) -> ReadS [b] -> Int -> ReadS (Const a b) # liftReadList2 :: (Int -> ReadS a) -> ReadS [a] -> (Int -> ReadS b) -> ReadS [b] -> ReadS [Const a b] # liftReadPrec2 :: ReadPrec a -> ReadPrec [a] -> ReadPrec b -> ReadPrec [b] -> ReadPrec (Const a b) # liftReadListPrec2 :: ReadPrec a -> ReadPrec [a] -> ReadPrec b -> ReadPrec [b] -> ReadPrec [Const a b] # | |
| Show2 (Const :: Type -> Type -> Type) | Since: base-4.9.0.0 |
| Biapplicative (Const :: Type -> Type -> Type) | |
Defined in Data.Biapplicative | |
| NFData2 (Const :: Type -> Type -> Type) | Since: deepseq-1.4.3.0 |
Defined in Control.DeepSeq | |
| Hashable2 (Const :: Type -> Type -> Type) | |
Defined in Data.Hashable.Class | |
| Bitraversable1 (Const :: Type -> Type -> Type) | |
Defined in Data.Semigroup.Traversable.Class Methods bitraverse1 :: Apply f => (a -> f b) -> (c -> f d) -> Const a c -> f (Const b d) # bisequence1 :: Apply f => Const (f a) (f b) -> f (Const a b) # | |
| Functor (Const m :: Type -> Type) | Since: base-2.1 |
| Monoid m => Applicative (Const m :: Type -> Type) | Since: base-2.0.1 |
| Foldable (Const m :: Type -> Type) | Since: base-4.7.0.0 |
Defined in Data.Functor.Const Methods fold :: Monoid m0 => Const m m0 -> m0 # foldMap :: Monoid m0 => (a -> m0) -> Const m a -> m0 # foldr :: (a -> b -> b) -> b -> Const m a -> b # foldr' :: (a -> b -> b) -> b -> Const m a -> b # foldl :: (b -> a -> b) -> b -> Const m a -> b # foldl' :: (b -> a -> b) -> b -> Const m a -> b # foldr1 :: (a -> a -> a) -> Const m a -> a # foldl1 :: (a -> a -> a) -> Const m a -> a # elem :: Eq a => a -> Const m a -> Bool # maximum :: Ord a => Const m a -> a # minimum :: Ord a => Const m a -> a # | |
| Traversable (Const m :: Type -> Type) | Since: base-4.7.0.0 |
| Arbitrary a => Arbitrary1 (Const a :: Type -> Type) | |
Defined in Test.QuickCheck.Arbitrary Methods liftArbitrary :: Gen a0 -> Gen (Const a a0) # liftShrink :: (a0 -> [a0]) -> Const a a0 -> [Const a a0] # | |
| Contravariant (Const a :: Type -> Type) | |
| ToJSON a => ToJSON1 (Const a :: Type -> Type) | |
Defined in Data.Aeson.Types.ToJSON Methods liftToJSON :: (a0 -> Value) -> ([a0] -> Value) -> Const a a0 -> Value # liftToJSONList :: (a0 -> Value) -> ([a0] -> Value) -> [Const a a0] -> Value # liftToEncoding :: (a0 -> Encoding) -> ([a0] -> Encoding) -> Const a a0 -> Encoding # liftToEncodingList :: (a0 -> Encoding) -> ([a0] -> Encoding) -> [Const a a0] -> Encoding # | |
| FromJSON a => FromJSON1 (Const a :: Type -> Type) | |
| Eq a => Eq1 (Const a :: Type -> Type) | Since: base-4.9.0.0 |
| Ord a => Ord1 (Const a :: Type -> Type) | Since: base-4.9.0.0 |
Defined in Data.Functor.Classes | |
| Read a => Read1 (Const a :: Type -> Type) | Since: base-4.9.0.0 |
Defined in Data.Functor.Classes Methods liftReadsPrec :: (Int -> ReadS a0) -> ReadS [a0] -> Int -> ReadS (Const a a0) # liftReadList :: (Int -> ReadS a0) -> ReadS [a0] -> ReadS [Const a a0] # liftReadPrec :: ReadPrec a0 -> ReadPrec [a0] -> ReadPrec (Const a a0) # liftReadListPrec :: ReadPrec a0 -> ReadPrec [a0] -> ReadPrec [Const a a0] # | |
| Show a => Show1 (Const a :: Type -> Type) | Since: base-4.9.0.0 |
| NFData a => NFData1 (Const a :: Type -> Type) | Since: deepseq-1.4.3.0 |
Defined in Control.DeepSeq | |
| Hashable a => Hashable1 (Const a :: Type -> Type) | |
Defined in Data.Hashable.Class | |
| Bounded a => Bounded (Const a b) | Since: base-4.9.0.0 |
| Enum a => Enum (Const a b) | Since: base-4.9.0.0 |
Defined in Data.Functor.Const Methods succ :: Const a b -> Const a b # pred :: Const a b -> Const a b # fromEnum :: Const a b -> Int # enumFrom :: Const a b -> [Const a b] # enumFromThen :: Const a b -> Const a b -> [Const a b] # enumFromTo :: Const a b -> Const a b -> [Const a b] # enumFromThenTo :: Const a b -> Const a b -> Const a b -> [Const a b] # | |
| Eq a => Eq (Const a b) | Since: base-4.9.0.0 |
| Floating a => Floating (Const a b) | Since: base-4.9.0.0 |
Defined in Data.Functor.Const Methods exp :: Const a b -> Const a b # log :: Const a b -> Const a b # sqrt :: Const a b -> Const a b # (**) :: Const a b -> Const a b -> Const a b # logBase :: Const a b -> Const a b -> Const a b # sin :: Const a b -> Const a b # cos :: Const a b -> Const a b # tan :: Const a b -> Const a b # asin :: Const a b -> Const a b # acos :: Const a b -> Const a b # atan :: Const a b -> Const a b # sinh :: Const a b -> Const a b # cosh :: Const a b -> Const a b # tanh :: Const a b -> Const a b # asinh :: Const a b -> Const a b # acosh :: Const a b -> Const a b # atanh :: Const a b -> Const a b # log1p :: Const a b -> Const a b # expm1 :: Const a b -> Const a b # | |
| Fractional a => Fractional (Const a b) | Since: base-4.9.0.0 |
| Integral a => Integral (Const a b) | Since: base-4.9.0.0 |
Defined in Data.Functor.Const Methods quot :: Const a b -> Const a b -> Const a b # rem :: Const a b -> Const a b -> Const a b # div :: Const a b -> Const a b -> Const a b # mod :: Const a b -> Const a b -> Const a b # quotRem :: Const a b -> Const a b -> (Const a b, Const a b) # divMod :: Const a b -> Const a b -> (Const a b, Const a b) # | |
| (Typeable k, Data a, Typeable b) => Data (Const a b) | Since: base-4.10.0.0 |
Defined in Data.Data Methods gfoldl :: (forall d b0. Data d => c (d -> b0) -> d -> c b0) -> (forall g. g -> c g) -> Const a b -> c (Const a b) # gunfold :: (forall b0 r. Data b0 => c (b0 -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Const a b) # toConstr :: Const a b -> Constr # dataTypeOf :: Const a b -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Const a b)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Const a b)) # gmapT :: (forall b0. Data b0 => b0 -> b0) -> Const a b -> Const a b # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Const a b -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Const a b -> r # gmapQ :: (forall d. Data d => d -> u) -> Const a b -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Const a b -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Const a b -> m (Const a b) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Const a b -> m (Const a b) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Const a b -> m (Const a b) # | |
| Num a => Num (Const a b) | Since: base-4.9.0.0 |
Defined in Data.Functor.Const | |
| Ord a => Ord (Const a b) | Since: base-4.9.0.0 |
| Read a => Read (Const a b) | This instance would be equivalent to the derived instances of the
Since: base-4.8.0.0 |
| Real a => Real (Const a b) | Since: base-4.9.0.0 |
Defined in Data.Functor.Const Methods toRational :: Const a b -> Rational # | |
| RealFloat a => RealFloat (Const a b) | Since: base-4.9.0.0 |
Defined in Data.Functor.Const Methods floatRadix :: Const a b -> Integer # floatDigits :: Const a b -> Int # floatRange :: Const a b -> (Int, Int) # decodeFloat :: Const a b -> (Integer, Int) # encodeFloat :: Integer -> Int -> Const a b # exponent :: Const a b -> Int # significand :: Const a b -> Const a b # scaleFloat :: Int -> Const a b -> Const a b # isInfinite :: Const a b -> Bool # isDenormalized :: Const a b -> Bool # isNegativeZero :: Const a b -> Bool # | |
| RealFrac a => RealFrac (Const a b) | Since: base-4.9.0.0 |
| Show a => Show (Const a b) | This instance would be equivalent to the derived instances of the
Since: base-4.8.0.0 |
| Ix a => Ix (Const a b) | Since: base-4.9.0.0 |
Defined in Data.Functor.Const Methods range :: (Const a b, Const a b) -> [Const a b] # index :: (Const a b, Const a b) -> Const a b -> Int # unsafeIndex :: (Const a b, Const a b) -> Const a b -> Int inRange :: (Const a b, Const a b) -> Const a b -> Bool # rangeSize :: (Const a b, Const a b) -> Int # unsafeRangeSize :: (Const a b, Const a b) -> Int | |
| IsString a => IsString (Const a b) | Since: base-4.9.0.0 |
Defined in Data.String Methods fromString :: String -> Const a b # | |
| Generic (Const a b) | |
| Semigroup a => Semigroup (Const a b) | Since: base-4.9.0.0 |
| Monoid a => Monoid (Const a b) | Since: base-4.9.0.0 |
| Function a => Function (Const a b) | |
| Arbitrary a => Arbitrary (Const a b) | |
| CoArbitrary a => CoArbitrary (Const a b) | |
Defined in Test.QuickCheck.Arbitrary Methods coarbitrary :: Const a b -> Gen b0 -> Gen b0 # | |
| Hashable a => Hashable (Const a b) | |
Defined in Data.Hashable.Class | |
| ToJSON a => ToJSON (Const a b) | |
Defined in Data.Aeson.Types.ToJSON | |
| FromJSON a => FromJSON (Const a b) | |
| Storable a => Storable (Const a b) | Since: base-4.9.0.0 |
Defined in Data.Functor.Const | |
| Bits a => Bits (Const a b) | Since: base-4.9.0.0 |
Defined in Data.Functor.Const Methods (.&.) :: Const a b -> Const a b -> Const a b # (.|.) :: Const a b -> Const a b -> Const a b # xor :: Const a b -> Const a b -> Const a b # complement :: Const a b -> Const a b # shift :: Const a b -> Int -> Const a b # rotate :: Const a b -> Int -> Const a b # setBit :: Const a b -> Int -> Const a b # clearBit :: Const a b -> Int -> Const a b # complementBit :: Const a b -> Int -> Const a b # testBit :: Const a b -> Int -> Bool # bitSizeMaybe :: Const a b -> Maybe Int # isSigned :: Const a b -> Bool # shiftL :: Const a b -> Int -> Const a b # unsafeShiftL :: Const a b -> Int -> Const a b # shiftR :: Const a b -> Int -> Const a b # unsafeShiftR :: Const a b -> Int -> Const a b # rotateL :: Const a b -> Int -> Const a b # | |
| FiniteBits a => FiniteBits (Const a b) | Since: base-4.9.0.0 |
Defined in Data.Functor.Const Methods finiteBitSize :: Const a b -> Int # countLeadingZeros :: Const a b -> Int # countTrailingZeros :: Const a b -> Int # | |
| NFData a => NFData (Const a b) | Since: deepseq-1.4.0.0 |
Defined in Control.DeepSeq | |
| Wrapped (Const a x) | |
| MonoFunctor (Const m a) | |
| MonoFoldable (Const m a) | |
Defined in Data.MonoTraversable Methods ofoldMap :: Monoid m0 => (Element (Const m a) -> m0) -> Const m a -> m0 # ofoldr :: (Element (Const m a) -> b -> b) -> b -> Const m a -> b # ofoldl' :: (a0 -> Element (Const m a) -> a0) -> a0 -> Const m a -> a0 # otoList :: Const m a -> [Element (Const m a)] # oall :: (Element (Const m a) -> Bool) -> Const m a -> Bool # oany :: (Element (Const m a) -> Bool) -> Const m a -> Bool # olength64 :: Const m a -> Int64 # ocompareLength :: Integral i => Const m a -> i -> Ordering # otraverse_ :: Applicative f => (Element (Const m a) -> f b) -> Const m a -> f () # ofor_ :: Applicative f => Const m a -> (Element (Const m a) -> f b) -> f () # omapM_ :: Applicative m0 => (Element (Const m a) -> m0 ()) -> Const m a -> m0 () # oforM_ :: Applicative m0 => Const m a -> (Element (Const m a) -> m0 ()) -> m0 () # ofoldlM :: Monad m0 => (a0 -> Element (Const m a) -> m0 a0) -> a0 -> Const m a -> m0 a0 # ofoldMap1Ex :: Semigroup m0 => (Element (Const m a) -> m0) -> Const m a -> m0 # ofoldr1Ex :: (Element (Const m a) -> Element (Const m a) -> Element (Const m a)) -> Const m a -> Element (Const m a) # ofoldl1Ex' :: (Element (Const m a) -> Element (Const m a) -> Element (Const m a)) -> Const m a -> Element (Const m a) # headEx :: Const m a -> Element (Const m a) # lastEx :: Const m a -> Element (Const m a) # unsafeHead :: Const m a -> Element (Const m a) # unsafeLast :: Const m a -> Element (Const m a) # maximumByEx :: (Element (Const m a) -> Element (Const m a) -> Ordering) -> Const m a -> Element (Const m a) # minimumByEx :: (Element (Const m a) -> Element (Const m a) -> Ordering) -> Const m a -> Element (Const m a) # | |
| MonoTraversable (Const m a) | |
| Monoid m => MonoPointed (Const m a) | |
| t ~ Const a' x' => Rewrapped (Const a x) t | |
Defined in Control.Lens.Wrapped | |
| type Rep1 (Const a :: k -> Type) | Since: base-4.9.0.0 |
Defined in Data.Functor.Const | |
| type Rep (Const a b) | Since: base-4.9.0.0 |
Defined in Data.Functor.Const | |
| type Unwrapped (Const a x) | |
Defined in Control.Lens.Wrapped | |
| type Element (Const m a) | |
Defined in Data.MonoTraversable | |
minimumBy :: Foldable t => (a -> a -> Ordering) -> t a -> a #
The least element of a non-empty structure with respect to the given comparison function.
maximumBy :: Foldable t => (a -> a -> Ordering) -> t a -> a #
The largest element of a non-empty structure with respect to the given comparison function.
all :: Foldable t => (a -> Bool) -> t a -> Bool #
Determines whether all elements of the structure satisfy the predicate.
any :: Foldable t => (a -> Bool) -> t a -> Bool #
Determines whether any element of the structure satisfies the predicate.
concatMap :: Foldable t => (a -> [b]) -> t a -> [b] #
Map a function over all the elements of a container and concatenate the resulting lists.
concat :: Foldable t => t [a] -> [a] #
The concatenation of all the elements of a container of lists.
sequence_ :: (Foldable t, Monad m) => t (m a) -> m () #
Evaluate each monadic action in the structure from left to right,
and ignore the results. For a version that doesn't ignore the
results see sequence.
As of base 4.8.0.0, sequence_ is just sequenceA_, specialized
to Monad.
Maybe monoid returning the leftmost non-Nothing value.
First aAlt Maybe a
>>>getFirst (First (Just "hello") <> First Nothing <> First (Just "world"))Just "hello"
Use of this type is discouraged. Note the following equivalence:
Data.Monoid.First x === Maybe (Data.Semigroup.First x)
In addition to being equivalent in the structural sense, the two
also have Monoid instances that behave the same. This type will
be marked deprecated in GHC 8.8, and removed in GHC 8.10.
Users are advised to use the variant from Data.Semigroup and wrap
it in Maybe.
Instances
| Monad First | Since: base-4.8.0.0 |
| Functor First | Since: base-4.8.0.0 |
| MonadFix First | Since: base-4.8.0.0 |
Defined in Control.Monad.Fix | |
| Applicative First | Since: base-4.8.0.0 |
| Foldable First | Since: base-4.8.0.0 |
Defined in Data.Foldable Methods fold :: Monoid m => First m -> m # foldMap :: Monoid m => (a -> m) -> First a -> m # foldr :: (a -> b -> b) -> b -> First a -> b # foldr' :: (a -> b -> b) -> b -> First a -> b # foldl :: (b -> a -> b) -> b -> First a -> b # foldl' :: (b -> a -> b) -> b -> First a -> b # foldr1 :: (a -> a -> a) -> First a -> a # foldl1 :: (a -> a -> a) -> First a -> a # elem :: Eq a => a -> First a -> Bool # maximum :: Ord a => First a -> a # minimum :: Ord a => First a -> a # | |
| Traversable First | Since: base-4.8.0.0 |
| ToJSON1 First | |
Defined in Data.Aeson.Types.ToJSON Methods liftToJSON :: (a -> Value) -> ([a] -> Value) -> First a -> Value # liftToJSONList :: (a -> Value) -> ([a] -> Value) -> [First a] -> Value # liftToEncoding :: (a -> Encoding) -> ([a] -> Encoding) -> First a -> Encoding # liftToEncodingList :: (a -> Encoding) -> ([a] -> Encoding) -> [First a] -> Encoding # | |
| FromJSON1 First | |
| NFData1 First | Since: deepseq-1.4.3.0 |
Defined in Control.DeepSeq | |
| Eq a => Eq (First a) | Since: base-2.1 |
| Data a => Data (First a) | Since: base-4.8.0.0 |
Defined in Data.Data Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> First a -> c (First a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (First a) # toConstr :: First a -> Constr # dataTypeOf :: First a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (First a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (First a)) # gmapT :: (forall b. Data b => b -> b) -> First a -> First a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> First a -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> First a -> r # gmapQ :: (forall d. Data d => d -> u) -> First a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> First a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> First a -> m (First a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> First a -> m (First a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> First a -> m (First a) # | |
| Ord a => Ord (First a) | Since: base-2.1 |
| Read a => Read (First a) | Since: base-2.1 |
| Show a => Show (First a) | Since: base-2.1 |
| Generic (First a) | |
| Semigroup (First a) | Since: base-4.9.0.0 |
| Monoid (First a) | Since: base-2.1 |
| Function a => Function (First a) | |
| Arbitrary a => Arbitrary (First a) | |
| CoArbitrary a => CoArbitrary (First a) | |
Defined in Test.QuickCheck.Arbitrary Methods coarbitrary :: First a -> Gen b -> Gen b # | |
| ToJSON a => ToJSON (First a) | |
Defined in Data.Aeson.Types.ToJSON | |
| FromJSON a => FromJSON (First a) | |
| Binary a => Binary (First a) | Since: 0.8.4.0 |
| NFData a => NFData (First a) | Since: deepseq-1.4.0.0 |
Defined in Control.DeepSeq | |
| Wrapped (First a) | |
| AsEmpty (First a) | |
Defined in Control.Lens.Empty | |
| Generic1 First | |
| t ~ First b => Rewrapped (First a) t | |
Defined in Control.Lens.Wrapped | |
| type Rep (First a) | Since: base-4.7.0.0 |
Defined in Data.Monoid | |
| type Unwrapped (First a) | |
Defined in Control.Lens.Wrapped | |
| type Rep1 First | Since: base-4.7.0.0 |
Defined in Data.Monoid | |
Maybe monoid returning the rightmost non-Nothing value.
Last aDual (First a)Dual (Alt Maybe a)
>>>getLast (Last (Just "hello") <> Last Nothing <> Last (Just "world"))Just "world"
Use of this type is discouraged. Note the following equivalence:
Data.Monoid.Last x === Maybe (Data.Semigroup.Last x)
In addition to being equivalent in the structural sense, the two
also have Monoid instances that behave the same. This type will
be marked deprecated in GHC 8.8, and removed in GHC 8.10.
Users are advised to use the variant from Data.Semigroup and wrap
it in Maybe.
Instances
| Monad Last | Since: base-4.8.0.0 |
| Functor Last | Since: base-4.8.0.0 |
| MonadFix Last | Since: base-4.8.0.0 |
Defined in Control.Monad.Fix | |
| Applicative Last | Since: base-4.8.0.0 |
| Foldable Last | Since: base-4.8.0.0 |
Defined in Data.Foldable Methods fold :: Monoid m => Last m -> m # foldMap :: Monoid m => (a -> m) -> Last a -> m # foldr :: (a -> b -> b) -> b -> Last a -> b # foldr' :: (a -> b -> b) -> b -> Last a -> b # foldl :: (b -> a -> b) -> b -> Last a -> b # foldl' :: (b -> a -> b) -> b -> Last a -> b # foldr1 :: (a -> a -> a) -> Last a -> a # foldl1 :: (a -> a -> a) -> Last a -> a # elem :: Eq a => a -> Last a -> Bool # maximum :: Ord a => Last a -> a # | |
| Traversable Last | Since: base-4.8.0.0 |
| ToJSON1 Last | |
Defined in Data.Aeson.Types.ToJSON Methods liftToJSON :: (a -> Value) -> ([a] -> Value) -> Last a -> Value # liftToJSONList :: (a -> Value) -> ([a] -> Value) -> [Last a] -> Value # liftToEncoding :: (a -> Encoding) -> ([a] -> Encoding) -> Last a -> Encoding # liftToEncodingList :: (a -> Encoding) -> ([a] -> Encoding) -> [Last a] -> Encoding # | |
| FromJSON1 Last | |
| NFData1 Last | Since: deepseq-1.4.3.0 |
Defined in Control.DeepSeq | |
| Eq a => Eq (Last a) | Since: base-2.1 |
| Data a => Data (Last a) | Since: base-4.8.0.0 |
Defined in Data.Data Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Last a -> c (Last a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Last a) # toConstr :: Last a -> Constr # dataTypeOf :: Last a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Last a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Last a)) # gmapT :: (forall b. Data b => b -> b) -> Last a -> Last a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Last a -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Last a -> r # gmapQ :: (forall d. Data d => d -> u) -> Last a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Last a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Last a -> m (Last a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Last a -> m (Last a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Last a -> m (Last a) # | |
| Ord a => Ord (Last a) | Since: base-2.1 |
| Read a => Read (Last a) | Since: base-2.1 |
| Show a => Show (Last a) | Since: base-2.1 |
| Generic (Last a) | |
| Semigroup (Last a) | Since: base-4.9.0.0 |
| Monoid (Last a) | Since: base-2.1 |
| Function a => Function (Last a) | |
| Arbitrary a => Arbitrary (Last a) | |
| CoArbitrary a => CoArbitrary (Last a) | |
Defined in Test.QuickCheck.Arbitrary Methods coarbitrary :: Last a -> Gen b -> Gen b # | |
| ToJSON a => ToJSON (Last a) | |
Defined in Data.Aeson.Types.ToJSON | |
| FromJSON a => FromJSON (Last a) | |
| Binary a => Binary (Last a) | Since: 0.8.4.0 |
| NFData a => NFData (Last a) | Since: deepseq-1.4.0.0 |
Defined in Control.DeepSeq | |
| Wrapped (Last a) | |
| AsEmpty (Last a) | |
Defined in Control.Lens.Empty | |
| Generic1 Last | |
| t ~ Last b => Rewrapped (Last a) t | |
Defined in Control.Lens.Wrapped | |
| type Rep (Last a) | Since: base-4.7.0.0 |
Defined in Data.Monoid | |
| type Unwrapped (Last a) | |
Defined in Control.Lens.Wrapped | |
| type Rep1 Last | Since: base-4.7.0.0 |
Defined in Data.Monoid | |
newtype Ap (f :: k -> Type) (a :: k) :: forall k. (k -> Type) -> k -> Type #
This data type witnesses the lifting of a Monoid into an
Applicative pointwise.
Since: base-4.12.0.0
Instances
| Generic1 (Ap f :: k -> Type) | |
| Monad f => Monad (Ap f) | Since: base-4.12.0.0 |
| Functor f => Functor (Ap f) | Since: base-4.12.0.0 |
| MonadFix f => MonadFix (Ap f) | Since: base-4.12.0.0 |
Defined in Control.Monad.Fix | |
| MonadFail f => MonadFail (Ap f) | Since: base-4.12.0.0 |
Defined in Data.Monoid | |
| Applicative f => Applicative (Ap f) | Since: base-4.12.0.0 |
| Foldable f => Foldable (Ap f) | Since: base-4.12.0.0 |
Defined in Data.Foldable Methods fold :: Monoid m => Ap f m -> m # foldMap :: Monoid m => (a -> m) -> Ap f a -> m # foldr :: (a -> b -> b) -> b -> Ap f a -> b # foldr' :: (a -> b -> b) -> b -> Ap f a -> b # foldl :: (b -> a -> b) -> b -> Ap f a -> b # foldl' :: (b -> a -> b) -> b -> Ap f a -> b # foldr1 :: (a -> a -> a) -> Ap f a -> a # foldl1 :: (a -> a -> a) -> Ap f a -> a # elem :: Eq a => a -> Ap f a -> Bool # maximum :: Ord a => Ap f a -> a # | |
| Traversable f => Traversable (Ap f) | Since: base-4.12.0.0 |
| Alternative f => Alternative (Ap f) | Since: base-4.12.0.0 |
| MonadPlus f => MonadPlus (Ap f) | Since: base-4.12.0.0 |
| (Applicative f, Bounded a) => Bounded (Ap f a) | Since: base-4.12.0.0 |
| Enum (f a) => Enum (Ap f a) | Since: base-4.12.0.0 |
Defined in Data.Monoid | |
| Eq (f a) => Eq (Ap f a) | Since: base-4.12.0.0 |
| (Data (f a), Data a, Typeable f) => Data (Ap f a) | Since: base-4.12.0.0 |
Defined in Data.Data Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Ap f a -> c (Ap f a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Ap f a) # toConstr :: Ap f a -> Constr # dataTypeOf :: Ap f a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Ap f a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Ap f a)) # gmapT :: (forall b. Data b => b -> b) -> Ap f a -> Ap f a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Ap f a -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Ap f a -> r # gmapQ :: (forall d. Data d => d -> u) -> Ap f a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Ap f a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Ap f a -> m (Ap f a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Ap f a -> m (Ap f a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Ap f a -> m (Ap f a) # | |
| (Applicative f, Num a) => Num (Ap f a) | Since: base-4.12.0.0 |
| Ord (f a) => Ord (Ap f a) | Since: base-4.12.0.0 |
| Read (f a) => Read (Ap f a) | Since: base-4.12.0.0 |
| Show (f a) => Show (Ap f a) | Since: base-4.12.0.0 |
| Generic (Ap f a) | |
| (Applicative f, Semigroup a) => Semigroup (Ap f a) | Since: base-4.12.0.0 |
| (Applicative f, Monoid a) => Monoid (Ap f a) | Since: base-4.12.0.0 |
| type Rep1 (Ap f :: k -> Type) | Since: base-4.12.0.0 |
Defined in Data.Monoid | |
| type Rep (Ap f a) | Since: base-4.12.0.0 |
Defined in Data.Monoid | |
The dual of a Monoid, obtained by swapping the arguments of mappend.
>>>getDual (mappend (Dual "Hello") (Dual "World"))"WorldHello"
Instances
| Monad Dual | Since: base-4.8.0.0 |
| Functor Dual | Since: base-4.8.0.0 |
| MonadFix Dual | Since: base-4.8.0.0 |
Defined in Control.Monad.Fix | |
| Applicative Dual | Since: base-4.8.0.0 |
| Foldable Dual | Since: base-4.8.0.0 |
Defined in Data.Foldable Methods fold :: Monoid m => Dual m -> m # foldMap :: Monoid m => (a -> m) -> Dual a -> m # foldr :: (a -> b -> b) -> b -> Dual a -> b # foldr' :: (a -> b -> b) -> b -> Dual a -> b # foldl :: (b -> a -> b) -> b -> Dual a -> b # foldl' :: (b -> a -> b) -> b -> Dual a -> b # foldr1 :: (a -> a -> a) -> Dual a -> a # foldl1 :: (a -> a -> a) -> Dual a -> a # elem :: Eq a => a -> Dual a -> Bool # maximum :: Ord a => Dual a -> a # | |
| Traversable Dual | Since: base-4.8.0.0 |
| Representable Dual | |
| ToJSON1 Dual | |
Defined in Data.Aeson.Types.ToJSON Methods liftToJSON :: (a -> Value) -> ([a] -> Value) -> Dual a -> Value # liftToJSONList :: (a -> Value) -> ([a] -> Value) -> [Dual a] -> Value # liftToEncoding :: (a -> Encoding) -> ([a] -> Encoding) -> Dual a -> Encoding # liftToEncodingList :: (a -> Encoding) -> ([a] -> Encoding) -> [Dual a] -> Encoding # | |
| FromJSON1 Dual | |
| NFData1 Dual | Since: deepseq-1.4.3.0 |
Defined in Control.DeepSeq | |
| Traversable1 Dual | |
| Bounded a => Bounded (Dual a) | Since: base-2.1 |
| Eq a => Eq (Dual a) | Since: base-2.1 |
| Data a => Data (Dual a) | Since: base-4.8.0.0 |
Defined in Data.Data Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Dual a -> c (Dual a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Dual a) # toConstr :: Dual a -> Constr # dataTypeOf :: Dual a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Dual a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Dual a)) # gmapT :: (forall b. Data b => b -> b) -> Dual a -> Dual a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Dual a -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Dual a -> r # gmapQ :: (forall d. Data d => d -> u) -> Dual a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Dual a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Dual a -> m (Dual a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Dual a -> m (Dual a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Dual a -> m (Dual a) # | |
| Ord a => Ord (Dual a) | Since: base-2.1 |
| Read a => Read (Dual a) | Since: base-2.1 |
| Show a => Show (Dual a) | Since: base-2.1 |
| Generic (Dual a) | |
| Semigroup a => Semigroup (Dual a) | Since: base-4.9.0.0 |
| Monoid a => Monoid (Dual a) | Since: base-2.1 |
| Function a => Function (Dual a) | |
| Arbitrary a => Arbitrary (Dual a) | |
| CoArbitrary a => CoArbitrary (Dual a) | |
Defined in Test.QuickCheck.Arbitrary Methods coarbitrary :: Dual a -> Gen b -> Gen b # | |
| ToJSON a => ToJSON (Dual a) | |
Defined in Data.Aeson.Types.ToJSON | |
| FromJSON a => FromJSON (Dual a) | |
| Binary a => Binary (Dual a) | Since: 0.8.4.0 |
| NFData a => NFData (Dual a) | Since: deepseq-1.4.0.0 |
Defined in Control.DeepSeq | |
| Wrapped (Dual a) | |
| AsEmpty a => AsEmpty (Dual a) | |
Defined in Control.Lens.Empty | |
| Generic1 Dual | |
| t ~ Dual b => Rewrapped (Dual a) t | |
Defined in Control.Lens.Wrapped | |
| type Rep Dual | |
Defined in Data.Functor.Rep | |
| type Rep (Dual a) | Since: base-4.7.0.0 |
Defined in Data.Semigroup.Internal | |
| type Unwrapped (Dual a) | |
Defined in Control.Lens.Wrapped | |
| type Rep1 Dual | Since: base-4.7.0.0 |
Defined in Data.Semigroup.Internal | |
The monoid of endomorphisms under composition.
>>>let computation = Endo ("Hello, " ++) <> Endo (++ "!")>>>appEndo computation "Haskell""Hello, Haskell!"
Instances
| Generic (Endo a) | |
| Semigroup (Endo a) | Since: base-4.9.0.0 |
| Monoid (Endo a) | Since: base-2.1 |
| (Arbitrary a, CoArbitrary a) => Arbitrary (Endo a) | |
| (Arbitrary a, CoArbitrary a) => CoArbitrary (Endo a) | |
Defined in Test.QuickCheck.Arbitrary Methods coarbitrary :: Endo a -> Gen b -> Gen b # | |
| Wrapped (Endo a) | |
| t ~ Endo b => Rewrapped (Endo a) t | |
Defined in Control.Lens.Wrapped | |
| type Rep (Endo a) | Since: base-4.7.0.0 |
Defined in Data.Semigroup.Internal | |
| type Unwrapped (Endo a) | |
Defined in Control.Lens.Wrapped | |
Boolean monoid under conjunction (&&).
>>>getAll (All True <> mempty <> All False)False
>>>getAll (mconcat (map (\x -> All (even x)) [2,4,6,7,8]))False
Instances
| Bounded All | Since: base-2.1 |
| Eq All | Since: base-2.1 |
| Data All | Since: base-4.8.0.0 |
Defined in Data.Data Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> All -> c All # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c All # dataTypeOf :: All -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c All) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c All) # gmapT :: (forall b. Data b => b -> b) -> All -> All # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> All -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> All -> r # gmapQ :: (forall d. Data d => d -> u) -> All -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> All -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> All -> m All # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> All -> m All # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> All -> m All # | |
| Ord All | Since: base-2.1 |
| Read All | Since: base-2.1 |
| Show All | Since: base-2.1 |
| Generic All | |
| Semigroup All | Since: base-4.9.0.0 |
| Monoid All | Since: base-2.1 |
| Function All | |
| Arbitrary All | |
| CoArbitrary All | |
Defined in Test.QuickCheck.Arbitrary Methods coarbitrary :: All -> Gen b -> Gen b # | |
| Binary All | Since: 0.8.4.0 |
| NFData All | Since: deepseq-1.4.0.0 |
Defined in Control.DeepSeq | |
| Wrapped All | |
| AsEmpty All | |
Defined in Control.Lens.Empty | |
| t ~ All => Rewrapped All t | |
Defined in Control.Lens.Wrapped | |
| type Rep All | Since: base-4.7.0.0 |
Defined in Data.Semigroup.Internal | |
| type Unwrapped All | |
Defined in Control.Lens.Wrapped | |
Boolean monoid under disjunction (||).
>>>getAny (Any True <> mempty <> Any False)True
>>>getAny (mconcat (map (\x -> Any (even x)) [2,4,6,7,8]))True
Instances
| Bounded Any | Since: base-2.1 |
| Eq Any | Since: base-2.1 |
| Data Any | Since: base-4.8.0.0 |
Defined in Data.Data Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Any -> c Any # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Any # dataTypeOf :: Any -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Any) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Any) # gmapT :: (forall b. Data b => b -> b) -> Any -> Any # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Any -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Any -> r # gmapQ :: (forall d. Data d => d -> u) -> Any -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Any -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Any -> m Any # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Any -> m Any # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Any -> m Any # | |
| Ord Any | Since: base-2.1 |
| Read Any | Since: base-2.1 |
| Show Any | Since: base-2.1 |
| Generic Any | |
| Semigroup Any | Since: base-4.9.0.0 |
| Monoid Any | Since: base-2.1 |
| Function Any | |
| Arbitrary Any | |
| CoArbitrary Any | |
Defined in Test.QuickCheck.Arbitrary Methods coarbitrary :: Any -> Gen b -> Gen b # | |
| Binary Any | Since: 0.8.4.0 |
| NFData Any | Since: deepseq-1.4.0.0 |
Defined in Control.DeepSeq | |
| Wrapped Any | |
| AsEmpty Any | |
Defined in Control.Lens.Empty | |
| t ~ Any => Rewrapped Any t | |
Defined in Control.Lens.Wrapped | |
| type Rep Any | Since: base-4.7.0.0 |
Defined in Data.Semigroup.Internal | |
| type Unwrapped Any | |
Defined in Control.Lens.Wrapped | |
Monoid under addition.
>>>getSum (Sum 1 <> Sum 2 <> mempty)3
Instances
| Monad Sum | Since: base-4.8.0.0 |
| Functor Sum | Since: base-4.8.0.0 |
| MonadFix Sum | Since: base-4.8.0.0 |
Defined in Control.Monad.Fix | |
| Applicative Sum | Since: base-4.8.0.0 |
| Foldable Sum | Since: base-4.8.0.0 |
Defined in Data.Foldable Methods fold :: Monoid m => Sum m -> m # foldMap :: Monoid m => (a -> m) -> Sum a -> m # foldr :: (a -> b -> b) -> b -> Sum a -> b # foldr' :: (a -> b -> b) -> b -> Sum a -> b # foldl :: (b -> a -> b) -> b -> Sum a -> b # foldl' :: (b -> a -> b) -> b -> Sum a -> b # foldr1 :: (a -> a -> a) -> Sum a -> a # foldl1 :: (a -> a -> a) -> Sum a -> a # elem :: Eq a => a -> Sum a -> Bool # maximum :: Ord a => Sum a -> a # | |
| Traversable Sum | Since: base-4.8.0.0 |
| Representable Sum | |
| NFData1 Sum | Since: deepseq-1.4.3.0 |
Defined in Control.DeepSeq | |
| Traversable1 Sum | |
| Bounded a => Bounded (Sum a) | Since: base-2.1 |
| Eq a => Eq (Sum a) | Since: base-2.1 |
| Data a => Data (Sum a) | Since: base-4.8.0.0 |
Defined in Data.Data Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Sum a -> c (Sum a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Sum a) # dataTypeOf :: Sum a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Sum a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Sum a)) # gmapT :: (forall b. Data b => b -> b) -> Sum a -> Sum a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Sum a -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Sum a -> r # gmapQ :: (forall d. Data d => d -> u) -> Sum a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Sum a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Sum a -> m (Sum a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Sum a -> m (Sum a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Sum a -> m (Sum a) # | |
| Num a => Num (Sum a) | Since: base-4.7.0.0 |
| Ord a => Ord (Sum a) | Since: base-2.1 |
| Read a => Read (Sum a) | Since: base-2.1 |
| Show a => Show (Sum a) | Since: base-2.1 |
| Generic (Sum a) | |
| Num a => Semigroup (Sum a) | Since: base-4.9.0.0 |
| Num a => Monoid (Sum a) | Since: base-2.1 |
| Function a => Function (Sum a) | |
| Arbitrary a => Arbitrary (Sum a) | |
| CoArbitrary a => CoArbitrary (Sum a) | |
Defined in Test.QuickCheck.Arbitrary Methods coarbitrary :: Sum a -> Gen b -> Gen b # | |
| Binary a => Binary (Sum a) | Since: 0.8.4.0 |
| NFData a => NFData (Sum a) | Since: deepseq-1.4.0.0 |
Defined in Control.DeepSeq | |
| Wrapped (Sum a) | |
| (Eq a, Num a) => AsEmpty (Sum a) | |
Defined in Control.Lens.Empty | |
| Generic1 Sum | |
| t ~ Sum b => Rewrapped (Sum a) t | |
Defined in Control.Lens.Wrapped | |
| type Rep Sum | |
Defined in Data.Functor.Rep | |
| type Rep (Sum a) | Since: base-4.7.0.0 |
Defined in Data.Semigroup.Internal | |
| type Unwrapped (Sum a) | |
Defined in Control.Lens.Wrapped | |
| type Rep1 Sum | Since: base-4.7.0.0 |
Defined in Data.Semigroup.Internal | |
Monoid under multiplication.
>>>getProduct (Product 3 <> Product 4 <> mempty)12
Constructors
| Product | |
Fields
| |
Instances
| Monad Product | Since: base-4.8.0.0 |
| Functor Product | Since: base-4.8.0.0 |
| MonadFix Product | Since: base-4.8.0.0 |
Defined in Control.Monad.Fix | |
| Applicative Product | Since: base-4.8.0.0 |
| Foldable Product | Since: base-4.8.0.0 |
Defined in Data.Foldable Methods fold :: Monoid m => Product m -> m # foldMap :: Monoid m => (a -> m) -> Product a -> m # foldr :: (a -> b -> b) -> b -> Product a -> b # foldr' :: (a -> b -> b) -> b -> Product a -> b # foldl :: (b -> a -> b) -> b -> Product a -> b # foldl' :: (b -> a -> b) -> b -> Product a -> b # foldr1 :: (a -> a -> a) -> Product a -> a # foldl1 :: (a -> a -> a) -> Product a -> a # elem :: Eq a => a -> Product a -> Bool # maximum :: Ord a => Product a -> a # minimum :: Ord a => Product a -> a # | |
| Traversable Product | Since: base-4.8.0.0 |
| Representable Product | |
| NFData1 Product | Since: deepseq-1.4.3.0 |
Defined in Control.DeepSeq | |
| Traversable1 Product | |
| Bounded a => Bounded (Product a) | Since: base-2.1 |
| Eq a => Eq (Product a) | Since: base-2.1 |
| Data a => Data (Product a) | Since: base-4.8.0.0 |
Defined in Data.Data Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Product a -> c (Product a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Product a) # toConstr :: Product a -> Constr # dataTypeOf :: Product a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Product a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Product a)) # gmapT :: (forall b. Data b => b -> b) -> Product a -> Product a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Product a -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Product a -> r # gmapQ :: (forall d. Data d => d -> u) -> Product a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Product a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Product a -> m (Product a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Product a -> m (Product a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Product a -> m (Product a) # | |
| Num a => Num (Product a) | Since: base-4.7.0.0 |
Defined in Data.Semigroup.Internal | |
| Ord a => Ord (Product a) | Since: base-2.1 |
| Read a => Read (Product a) | Since: base-2.1 |
| Show a => Show (Product a) | Since: base-2.1 |
| Generic (Product a) | |
| Num a => Semigroup (Product a) | Since: base-4.9.0.0 |
| Num a => Monoid (Product a) | Since: base-2.1 |
| Function a => Function (Product a) | |
| Arbitrary a => Arbitrary (Product a) | |
| CoArbitrary a => CoArbitrary (Product a) | |
Defined in Test.QuickCheck.Arbitrary Methods coarbitrary :: Product a -> Gen b -> Gen b # | |
| Binary a => Binary (Product a) | Since: 0.8.4.0 |
| NFData a => NFData (Product a) | Since: deepseq-1.4.0.0 |
Defined in Control.DeepSeq | |
| Wrapped (Product a) | |
| (Eq a, Num a) => AsEmpty (Product a) | |
Defined in Control.Lens.Empty | |
| Generic1 Product | |
| t ~ Product b => Rewrapped (Product a) t | |
Defined in Control.Lens.Wrapped | |
| type Rep Product | |
Defined in Data.Functor.Rep | |
| type Rep (Product a) | Since: base-4.7.0.0 |
Defined in Data.Semigroup.Internal | |
| type Unwrapped (Product a) | |
Defined in Control.Lens.Wrapped | |
| type Rep1 Product | Since: base-4.7.0.0 |
Defined in Data.Semigroup.Internal | |
newtype Alt (f :: k -> Type) (a :: k) :: forall k. (k -> Type) -> k -> Type #
Monoid under <|>.
Since: base-4.8.0.0
Instances
| Generic1 (Alt f :: k -> Type) | |
| Monad f => Monad (Alt f) | Since: base-4.8.0.0 |
| Functor f => Functor (Alt f) | Since: base-4.8.0.0 |
| MonadFix f => MonadFix (Alt f) | Since: base-4.8.0.0 |
Defined in Control.Monad.Fix | |
| Applicative f => Applicative (Alt f) | Since: base-4.8.0.0 |
| Foldable f => Foldable (Alt f) | Since: base-4.12.0.0 |
Defined in Data.Foldable Methods fold :: Monoid m => Alt f m -> m # foldMap :: Monoid m => (a -> m) -> Alt f a -> m # foldr :: (a -> b -> b) -> b -> Alt f a -> b # foldr' :: (a -> b -> b) -> b -> Alt f a -> b # foldl :: (b -> a -> b) -> b -> Alt f a -> b # foldl' :: (b -> a -> b) -> b -> Alt f a -> b # foldr1 :: (a -> a -> a) -> Alt f a -> a # foldl1 :: (a -> a -> a) -> Alt f a -> a # elem :: Eq a => a -> Alt f a -> Bool # maximum :: Ord a => Alt f a -> a # minimum :: Ord a => Alt f a -> a # | |
| Traversable f => Traversable (Alt f) | Since: base-4.12.0.0 |
| Contravariant f => Contravariant (Alt f) | |
| Alternative f => Alternative (Alt f) | Since: base-4.8.0.0 |
| MonadPlus f => MonadPlus (Alt f) | Since: base-4.8.0.0 |
| Traversable1 f => Traversable1 (Alt f) | |
| Enum (f a) => Enum (Alt f a) | Since: base-4.8.0.0 |
| Eq (f a) => Eq (Alt f a) | Since: base-4.8.0.0 |
| (Data (f a), Data a, Typeable f) => Data (Alt f a) | Since: base-4.8.0.0 |
Defined in Data.Data Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Alt f a -> c (Alt f a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Alt f a) # toConstr :: Alt f a -> Constr # dataTypeOf :: Alt f a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Alt f a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Alt f a)) # gmapT :: (forall b. Data b => b -> b) -> Alt f a -> Alt f a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Alt f a -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Alt f a -> r # gmapQ :: (forall d. Data d => d -> u) -> Alt f a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Alt f a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Alt f a -> m (Alt f a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Alt f a -> m (Alt f a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Alt f a -> m (Alt f a) # | |
| Num (f a) => Num (Alt f a) | Since: base-4.8.0.0 |
| Ord (f a) => Ord (Alt f a) | Since: base-4.8.0.0 |
Defined in Data.Semigroup.Internal | |
| Read (f a) => Read (Alt f a) | Since: base-4.8.0.0 |
| Show (f a) => Show (Alt f a) | Since: base-4.8.0.0 |
| Generic (Alt f a) | |
| Alternative f => Semigroup (Alt f a) | Since: base-4.9.0.0 |
| Alternative f => Monoid (Alt f a) | Since: base-4.8.0.0 |
| Function (f a) => Function (Alt f a) | |
| Arbitrary (f a) => Arbitrary (Alt f a) | |
| CoArbitrary (f a) => CoArbitrary (Alt f a) | |
Defined in Test.QuickCheck.Arbitrary Methods coarbitrary :: Alt f a -> Gen b -> Gen b # | |
| Binary (f a) => Binary (Alt f a) | Since: 0.8.4.0 |
| Wrapped (Alt f a) | |
| t ~ Alt g b => Rewrapped (Alt f a) t | |
Defined in Control.Lens.Wrapped | |
| type Rep1 (Alt f :: k -> Type) | Since: base-4.8.0.0 |
Defined in Data.Semigroup.Internal | |
| type Rep (Alt f a) | Since: base-4.8.0.0 |
Defined in Data.Semigroup.Internal | |
| type Unwrapped (Alt f a) | |
Defined in Control.Lens.Wrapped | |
words breaks a string up into a list of words, which were delimited
by white space.
>>>words "Lorem ipsum\ndolor"["Lorem","ipsum","dolor"]
unfoldr :: (b -> Maybe (a, b)) -> b -> [a] #
The unfoldr function is a `dual' to foldr: while foldr
reduces a list to a summary value, unfoldr builds a list from
a seed value. The function takes the element and returns Nothing
if it is done producing the list or returns Just (a,b), in which
case, a is a prepended to the list and b is used as the next
element in a recursive call. For example,
iterate f == unfoldr (\x -> Just (x, f x))
In some cases, unfoldr can undo a foldr operation:
unfoldr f' (foldr f z xs) == xs
if the following holds:
f' (f x y) = Just (x,y) f' z = Nothing
A simple use of unfoldr:
>>>unfoldr (\b -> if b == 0 then Nothing else Just (b, b-1)) 10[10,9,8,7,6,5,4,3,2,1]
sortOn :: Ord b => (a -> b) -> [a] -> [a] #
Sort a list by comparing the results of a key function applied to each
element. sortOn f is equivalent to sortBy (comparing f), but has the
performance advantage of only evaluating f once for each element in the
input list. This is called the decorate-sort-undecorate paradigm, or
Schwartzian transform.
Elements are arranged from from lowest to highest, keeping duplicates in the order they appeared in the input.
>>>sortOn fst [(2, "world"), (4, "!"), (1, "Hello")][(1,"Hello"),(2,"world"),(4,"!")]
Since: base-4.8.0.0
The sort function implements a stable sorting algorithm.
It is a special case of sortBy, which allows the programmer to supply
their own comparison function.
Elements are arranged from from lowest to highest, keeping duplicates in the order they appeared in the input.
>>>sort [1,6,4,3,2,5][1,2,3,4,5,6]
permutations :: [a] -> [[a]] #
The permutations function returns the list of all permutations of the argument.
>>>permutations "abc"["abc","bac","cba","bca","cab","acb"]
subsequences :: [a] -> [[a]] #
The subsequences function returns the list of all subsequences of the argument.
>>>subsequences "abc"["","a","b","ab","c","ac","bc","abc"]
group :: Eq a => [a] -> [[a]] #
The group function takes a list and returns a list of lists such
that the concatenation of the result is equal to the argument. Moreover,
each sublist in the result contains only equal elements. For example,
>>>group "Mississippi"["M","i","ss","i","ss","i","pp","i"]
It is a special case of groupBy, which allows the programmer to supply
their own equality test.
deleteFirstsBy :: (a -> a -> Bool) -> [a] -> [a] -> [a] #
The deleteFirstsBy function takes a predicate and two lists and
returns the first list with the first occurrence of each element of
the second list removed.
zipWith7 :: (a -> b -> c -> d -> e -> f -> g -> h) -> [a] -> [b] -> [c] -> [d] -> [e] -> [f] -> [g] -> [h] #
genericReplicate :: Integral i => i -> a -> [a] #
The genericReplicate function is an overloaded version of replicate,
which accepts any Integral value as the number of repetitions to make.
genericIndex :: Integral i => [a] -> i -> a #
The genericIndex function is an overloaded version of !!, which
accepts any Integral value as the index.
genericSplitAt :: Integral i => i -> [a] -> ([a], [a]) #
The genericSplitAt function is an overloaded version of splitAt, which
accepts any Integral value as the position at which to split.
genericDrop :: Integral i => i -> [a] -> [a] #
The genericDrop function is an overloaded version of drop, which
accepts any Integral value as the number of elements to drop.
genericTake :: Integral i => i -> [a] -> [a] #
The genericTake function is an overloaded version of take, which
accepts any Integral value as the number of elements to take.
genericLength :: Num i => [a] -> i #
The genericLength function is an overloaded version of length. In
particular, instead of returning an Int, it returns any type which is
an instance of Num. It is, however, less efficient than length.
insert :: Ord a => a -> [a] -> [a] #
The insert function takes an element and a list and inserts the
element into the list at the first position where it is less
than or equal to the next element. In particular, if the list
is sorted before the call, the result will also be sorted.
It is a special case of insertBy, which allows the programmer to
supply their own comparison function.
>>>insert 4 [1,2,3,5,6,7][1,2,3,4,5,6,7]
partition :: (a -> Bool) -> [a] -> ([a], [a]) #
The partition function takes a predicate a list and returns
the pair of lists of elements which do and do not satisfy the
predicate, respectively; i.e.,
partition p xs == (filter p xs, filter (not . p) xs)
>>>partition (`elem` "aeiou") "Hello World!"("eoo","Hll Wrld!")
The transpose function transposes the rows and columns of its argument.
For example,
>>>transpose [[1,2,3],[4,5,6]][[1,4],[2,5],[3,6]]
If some of the rows are shorter than the following rows, their elements are skipped:
>>>transpose [[10,11],[20],[],[30,31,32]][[10,20,30],[11,31],[32]]
intercalate :: [a] -> [[a]] -> [a] #
intercalate xs xss is equivalent to (.
It inserts the list concat (intersperse xs xss))xs in between the lists in xss and concatenates the
result.
>>>intercalate ", " ["Lorem", "ipsum", "dolor"]"Lorem, ipsum, dolor"
intersperse :: a -> [a] -> [a] #
The intersperse function takes an element and a list and
`intersperses' that element between the elements of the list.
For example,
>>>intersperse ',' "abcde""a,b,c,d,e"
intersectBy :: (a -> a -> Bool) -> [a] -> [a] -> [a] #
The intersectBy function is the non-overloaded version of intersect.
intersect :: Eq a => [a] -> [a] -> [a] #
The intersect function takes the list intersection of two lists.
For example,
>>>[1,2,3,4] `intersect` [2,4,6,8][2,4]
If the first list contains duplicates, so will the result.
>>>[1,2,2,3,4] `intersect` [6,4,4,2][2,2,4]
It is a special case of intersectBy, which allows the programmer to
supply their own equality test. If the element is found in both the first
and the second list, the element from the first list will be used.
union :: Eq a => [a] -> [a] -> [a] #
The union function returns the list union of the two lists.
For example,
>>>"dog" `union` "cow""dogcw"
Duplicates, and elements of the first list, are removed from the
the second list, but if the first list contains duplicates, so will
the result.
It is a special case of unionBy, which allows the programmer to supply
their own equality test.
(\\) :: Eq a => [a] -> [a] -> [a] infix 5 #
The \\ function is list difference (non-associative).
In the result of xs \\ ys, the first occurrence of each element of
ys in turn (if any) has been removed from xs. Thus
(xs ++ ys) \\ xs == ys.
>>>"Hello World!" \\ "ell W""Hoorld!"
It is a special case of deleteFirstsBy, which allows the programmer
to supply their own equality test.
O(n^2). The nub function removes duplicate elements from a list.
In particular, it keeps only the first occurrence of each element.
(The name nub means `essence'.)
It is a special case of nubBy, which allows the programmer to supply
their own equality test.
>>>nub [1,2,3,4,3,2,1,2,4,3,5][1,2,3,4,5]
isSuffixOf :: Eq a => [a] -> [a] -> Bool #
The isSuffixOf function takes two lists and returns True iff
the first list is a suffix of the second. The second list must be
finite.
>>>"ld!" `isSuffixOf` "Hello World!"True
>>>"World" `isSuffixOf` "Hello World!"False
isPrefixOf :: Eq a => [a] -> [a] -> Bool #
The isPrefixOf function takes two lists and returns True
iff the first list is a prefix of the second.
>>>"Hello" `isPrefixOf` "Hello World!"True
>>>"Hello" `isPrefixOf` "Wello Horld!"False
findIndices :: (a -> Bool) -> [a] -> [Int] #
The findIndices function extends findIndex, by returning the
indices of all elements satisfying the predicate, in ascending order.
>>>findIndices (`elem` "aeiou") "Hello World!"[1,4,7]
elemIndices :: Eq a => a -> [a] -> [Int] #
The elemIndices function extends elemIndex, by returning the
indices of all elements equal to the query element, in ascending order.
>>>elemIndices 'o' "Hello World"[4,7]
stripPrefix :: Eq a => [a] -> [a] -> Maybe [a] #
The stripPrefix function drops the given prefix from a list.
It returns Nothing if the list did not start with the prefix
given, or Just the list after the prefix, if it does.
>>>stripPrefix "foo" "foobar"Just "bar"
>>>stripPrefix "foo" "foo"Just ""
>>>stripPrefix "foo" "barfoo"Nothing
>>>stripPrefix "foo" "barfoobaz"Nothing
dropWhileEnd :: (a -> Bool) -> [a] -> [a] #
The dropWhileEnd function drops the largest suffix of a list
in which the given predicate holds for all elements. For example:
>>>dropWhileEnd isSpace "foo\n""foo"
>>>dropWhileEnd isSpace "foo bar""foo bar"
dropWhileEnd isSpace ("foo\n" ++ undefined) == "foo" ++ undefinedSince: base-4.5.0.0
void :: Functor f => f a -> f () #
void valueIO action.
Examples
Replace the contents of a Maybe Int
>>>void NothingNothing>>>void (Just 3)Just ()
Replace the contents of an Either Int IntEither Int '()'
>>>void (Left 8675309)Left 8675309>>>void (Right 8675309)Right ()
Replace every element of a list with unit:
>>>void [1,2,3][(),(),()]
Replace the second element of a pair with unit:
>>>void (1,2)(1,())
Discard the result of an IO action:
>>>mapM print [1,2]1 2 [(),()]>>>void $ mapM print [1,2]1 2
unzip :: [(a, b)] -> ([a], [b]) #
unzip transforms a list of pairs into a list of first components
and a list of second components.
(!!) :: [a] -> Int -> a infixl 9 #
List index (subscript) operator, starting from 0.
It is an instance of the more general genericIndex,
which takes an index of any integral type.
lookup :: Eq a => a -> [(a, b)] -> Maybe b #
lookup key assocs looks up a key in an association list.
break :: (a -> Bool) -> [a] -> ([a], [a]) #
break, applied to a predicate p and a list xs, returns a tuple where
first element is longest prefix (possibly empty) of xs of elements that
do not satisfy p and second element is the remainder of the list:
break (> 3) [1,2,3,4,1,2,3,4] == ([1,2,3],[4,1,2,3,4]) break (< 9) [1,2,3] == ([],[1,2,3]) break (> 9) [1,2,3] == ([1,2,3],[])
span :: (a -> Bool) -> [a] -> ([a], [a]) #
span, applied to a predicate p and a list xs, returns a tuple where
first element is longest prefix (possibly empty) of xs of elements that
satisfy p and second element is the remainder of the list:
span (< 3) [1,2,3,4,1,2,3,4] == ([1,2],[3,4,1,2,3,4]) span (< 9) [1,2,3] == ([1,2,3],[]) span (< 0) [1,2,3] == ([],[1,2,3])
splitAt :: Int -> [a] -> ([a], [a]) #
splitAt n xs returns a tuple where first element is xs prefix of
length n and second element is the remainder of the list:
splitAt 6 "Hello World!" == ("Hello ","World!")
splitAt 3 [1,2,3,4,5] == ([1,2,3],[4,5])
splitAt 1 [1,2,3] == ([1],[2,3])
splitAt 3 [1,2,3] == ([1,2,3],[])
splitAt 4 [1,2,3] == ([1,2,3],[])
splitAt 0 [1,2,3] == ([],[1,2,3])
splitAt (-1) [1,2,3] == ([],[1,2,3])It is equivalent to ( when take n xs, drop n xs)n is not _|_
(splitAt _|_ xs = _|_).
splitAt is an instance of the more general genericSplitAt,
in which n may be of any integral type.
drop n xs returns the suffix of xs
after the first n elements, or [] if n > :length xs
drop 6 "Hello World!" == "World!" drop 3 [1,2,3,4,5] == [4,5] drop 3 [1,2] == [] drop 3 [] == [] drop (-1) [1,2] == [1,2] drop 0 [1,2] == [1,2]
It is an instance of the more general genericDrop,
in which n may be of any integral type.
take n, applied to a list xs, returns the prefix of xs
of length n, or xs itself if n > :length xs
take 5 "Hello World!" == "Hello" take 3 [1,2,3,4,5] == [1,2,3] take 3 [1,2] == [1,2] take 3 [] == [] take (-1) [1,2] == [] take 0 [1,2] == []
It is an instance of the more general genericTake,
in which n may be of any integral type.
takeWhile :: (a -> Bool) -> [a] -> [a] #
takeWhile, applied to a predicate p and a list xs, returns the
longest prefix (possibly empty) of xs of elements that satisfy p:
takeWhile (< 3) [1,2,3,4,1,2,3,4] == [1,2] takeWhile (< 9) [1,2,3] == [1,2,3] takeWhile (< 0) [1,2,3] == []
cycle ties a finite list into a circular one, or equivalently,
the infinite repetition of the original list. It is the identity
on infinite lists.
replicate :: Int -> a -> [a] #
replicate n x is a list of length n with x the value of
every element.
It is an instance of the more general genericReplicate,
in which n may be of any integral type.
iterate' :: (a -> a) -> a -> [a] #
'iterate\'' is the strict version of iterate.
It ensures that the result of each application of force to weak head normal form before proceeding.
Return all the elements of a list except the last one. The list must be non-empty.
mapMaybe :: (a -> Maybe b) -> [a] -> [b] #
The mapMaybe function is a version of map which can throw
out elements. In particular, the functional argument returns
something of type Maybe bNothing, no element
is added on to the result list. If it is Just bb is
included in the result list.
Examples
Using mapMaybe f xcatMaybes $ map f x
>>>import Text.Read ( readMaybe )>>>let readMaybeInt = readMaybe :: String -> Maybe Int>>>mapMaybe readMaybeInt ["1", "Foo", "3"][1,3]>>>catMaybes $ map readMaybeInt ["1", "Foo", "3"][1,3]
If we map the Just constructor, the entire list should be returned:
>>>mapMaybe Just [1,2,3][1,2,3]
catMaybes :: [Maybe a] -> [a] #
The catMaybes function takes a list of Maybes and returns
a list of all the Just values.
Examples
Basic usage:
>>>catMaybes [Just 1, Nothing, Just 3][1,3]
When constructing a list of Maybe values, catMaybes can be used
to return all of the "success" results (if the list is the result
of a map, then mapMaybe would be more appropriate):
>>>import Text.Read ( readMaybe )>>>[readMaybe x :: Maybe Int | x <- ["1", "Foo", "3"] ][Just 1,Nothing,Just 3]>>>catMaybes $ [readMaybe x :: Maybe Int | x <- ["1", "Foo", "3"] ][1,3]
listToMaybe :: [a] -> Maybe a #
The listToMaybe function returns Nothing on an empty list
or Just aa is the first element of the list.
Examples
Basic usage:
>>>listToMaybe []Nothing
>>>listToMaybe [9]Just 9
>>>listToMaybe [1,2,3]Just 1
Composing maybeToList with listToMaybe should be the identity
on singleton/empty lists:
>>>maybeToList $ listToMaybe [5][5]>>>maybeToList $ listToMaybe [][]
But not on lists with more than one element:
>>>maybeToList $ listToMaybe [1,2,3][1]
maybeToList :: Maybe a -> [a] #
The maybeToList function returns an empty list when given
Nothing or a singleton list when not given Nothing.
Examples
Basic usage:
>>>maybeToList (Just 7)[7]
>>>maybeToList Nothing[]
One can use maybeToList to avoid pattern matching when combined
with a function that (safely) works on lists:
>>>import Text.Read ( readMaybe )>>>sum $ maybeToList (readMaybe "3")3>>>sum $ maybeToList (readMaybe "")0
fromMaybe :: a -> Maybe a -> a #
The fromMaybe function takes a default value and and Maybe
value. If the Maybe is Nothing, it returns the default values;
otherwise, it returns the value contained in the Maybe.
Examples
Basic usage:
>>>fromMaybe "" (Just "Hello, World!")"Hello, World!"
>>>fromMaybe "" Nothing""
Read an integer from a string using readMaybe. If we fail to
parse an integer, we want to return 0 by default:
>>>import Text.Read ( readMaybe )>>>fromMaybe 0 (readMaybe "5")5>>>fromMaybe 0 (readMaybe "")0
maybe :: b -> (a -> b) -> Maybe a -> b #
The maybe function takes a default value, a function, and a Maybe
value. If the Maybe value is Nothing, the function returns the
default value. Otherwise, it applies the function to the value inside
the Just and returns the result.
Examples
Basic usage:
>>>maybe False odd (Just 3)True
>>>maybe False odd NothingFalse
Read an integer from a string using readMaybe. If we succeed,
return twice the integer; that is, apply (*2) to it. If instead
we fail to parse an integer, return 0 by default:
>>>import Text.Read ( readMaybe )>>>maybe 0 (*2) (readMaybe "5")10>>>maybe 0 (*2) (readMaybe "")0
Apply show to a Maybe Int. If we have Just n, we want to show
the underlying Int n. But if we have Nothing, we return the
empty string instead of (for example) "Nothing":
>>>maybe "" show (Just 5)"5">>>maybe "" show Nothing""
liftM5 :: Monad m => (a1 -> a2 -> a3 -> a4 -> a5 -> r) -> m a1 -> m a2 -> m a3 -> m a4 -> m a5 -> m r #
Promote a function to a monad, scanning the monadic arguments from
left to right (cf. liftM2).
liftM4 :: Monad m => (a1 -> a2 -> a3 -> a4 -> r) -> m a1 -> m a2 -> m a3 -> m a4 -> m r #
Promote a function to a monad, scanning the monadic arguments from
left to right (cf. liftM2).
liftM3 :: Monad m => (a1 -> a2 -> a3 -> r) -> m a1 -> m a2 -> m a3 -> m r #
Promote a function to a monad, scanning the monadic arguments from
left to right (cf. liftM2).
liftM2 :: Monad m => (a1 -> a2 -> r) -> m a1 -> m a2 -> m r #
Promote a function to a monad, scanning the monadic arguments from left to right. For example,
liftM2 (+) [0,1] [0,2] = [0,2,1,3] liftM2 (+) (Just 1) Nothing = Nothing
when :: Applicative f => Bool -> f () -> f () #
Conditional execution of Applicative expressions. For example,
when debug (putStrLn "Debugging")
will output the string Debugging if the Boolean value debug
is True, and otherwise do nothing.
(=<<) :: Monad m => (a -> m b) -> m a -> m b infixr 1 #
Same as >>=, but with the arguments interchanged.
liftA3 :: Applicative f => (a -> b -> c -> d) -> f a -> f b -> f c -> f d #
Lift a ternary function to actions.
liftA :: Applicative f => (a -> b) -> f a -> f b #
(<**>) :: Applicative f => f a -> f (a -> b) -> f b infixl 4 #
A variant of <*> with the arguments reversed.
data ReaderT r (m :: k -> Type) (a :: k) :: forall k. Type -> (k -> Type) -> k -> Type #
The reader monad transformer, which adds a read-only environment to the given monad.
The return function ignores the environment, while >>= passes
the inherited environment to both subcomputations.
Instances
(</>) :: FilePath -> FilePath -> FilePath infixr 5 #
Combine two paths with a path separator.
If the second path starts with a path separator or a drive letter, then it returns the second.
The intention is that readFile (dir will access the same file as
</> file)setCurrentDirectory dir; readFile file.
Posix: "/directory" </> "file.ext" == "/directory/file.ext"
Windows: "/directory" </> "file.ext" == "/directory\\file.ext"
"directory" </> "/file.ext" == "/file.ext"
Valid x => (takeDirectory x </> takeFileName x) `equalFilePath` xCombined:
Posix: "/" </> "test" == "/test" Posix: "home" </> "bob" == "home/bob" Posix: "x:" </> "foo" == "x:/foo" Windows: "C:\\foo" </> "bar" == "C:\\foo\\bar" Windows: "home" </> "bob" == "home\\bob"
Not combined:
Posix: "home" </> "/bob" == "/bob" Windows: "home" </> "C:\\bob" == "C:\\bob"
Not combined (tricky):
On Windows, if a filepath starts with a single slash, it is relative to the
root of the current drive. In [1], this is (confusingly) referred to as an
absolute path.
The current behavior of </> is to never combine these forms.
Windows: "home" </> "/bob" == "/bob" Windows: "home" </> "\\bob" == "\\bob" Windows: "C:\\home" </> "\\bob" == "\\bob"
On Windows, from [1]: "If a file name begins with only a disk designator
but not the backslash after the colon, it is interpreted as a relative path
to the current directory on the drive with the specified letter."
The current behavior of </> is to never combine these forms.
Windows: "D:\\foo" </> "C:bar" == "C:bar" Windows: "C:\\foo" </> "C:bar" == "C:bar"
takeDirectory :: FilePath -> FilePath #
Get the directory name, move up one level.
takeDirectory "/directory/other.ext" == "/directory"
takeDirectory x `isPrefixOf` x || takeDirectory x == "."
takeDirectory "foo" == "."
takeDirectory "/" == "/"
takeDirectory "/foo" == "/"
takeDirectory "/foo/bar/baz" == "/foo/bar"
takeDirectory "/foo/bar/baz/" == "/foo/bar/baz"
takeDirectory "foo/bar/baz" == "foo/bar"
Windows: takeDirectory "foo\\bar" == "foo"
Windows: takeDirectory "foo\\bar\\\\" == "foo\\bar"
Windows: takeDirectory "C:\\" == "C:\\"takeFileName :: FilePath -> FilePath #
Get the file name.
takeFileName "/directory/file.ext" == "file.ext" takeFileName "test/" == "" takeFileName x `isSuffixOf` x takeFileName x == snd (splitFileName x) Valid x => takeFileName (replaceFileName x "fred") == "fred" Valid x => takeFileName (x </> "fred") == "fred" Valid x => isRelative (takeFileName x)
(<.>) :: FilePath -> String -> FilePath infixr 7 #
Add an extension, even if there is already one there, equivalent to addExtension.
"/directory/path" <.> "ext" == "/directory/path.ext" "/directory/path" <.> ".ext" == "/directory/path.ext"
replaceExtension :: FilePath -> String -> FilePath #
Set the extension of a file, overwriting one if already present, equivalent to -<.>.
replaceExtension "/directory/path.txt" "ext" == "/directory/path.ext" replaceExtension "/directory/path.txt" ".ext" == "/directory/path.ext" replaceExtension "file.txt" ".bob" == "file.bob" replaceExtension "file.txt" "bob" == "file.bob" replaceExtension "file" ".bob" == "file.bob" replaceExtension "file.txt" "" == "file" replaceExtension "file.fred.bob" "txt" == "file.fred.txt" replaceExtension x y == addExtension (dropExtension x) y
(^.) :: s -> Getting a s a -> a infixl 8 #
View the value pointed to by a Getter or Lens or the
result of folding over all the results of a Fold or
Traversal that points at a monoidal values.
This is the same operation as view with the arguments flipped.
The fixity and semantics are such that subsequent field accesses can be
performed with (.).
>>>(a,b)^._2b
>>>("hello","world")^._2"world"
>>>import Data.Complex>>>((0, 1 :+ 2), 3)^._1._2.to magnitude2.23606797749979
(^.) :: s ->Getters a -> a (^.) ::Monoidm => s ->Folds m -> m (^.) :: s ->Iso's a -> a (^.) :: s ->Lens's a -> a (^.) ::Monoidm => s ->Traversal's m -> m
(.~) :: ASetter s t a b -> b -> s -> t infixr 4 #
Replace the target of a Lens or all of the targets of a Setter
or Traversal with a constant value.
This is an infix version of set, provided for consistency with (.=).
f<$a ≡mapped.~f$a
>>>(a,b,c,d) & _4 .~ e(a,b,c,e)
>>>(42,"world") & _1 .~ "hello"("hello","world")
>>>(a,b) & both .~ c(c,c)
(.~) ::Setters t a b -> b -> s -> t (.~) ::Isos t a b -> b -> s -> t (.~) ::Lenss t a b -> b -> s -> t (.~) ::Traversals t a b -> b -> s -> t
(%~) :: ASetter s t a b -> (a -> b) -> s -> t infixr 4 #
Modifies the target of a Lens or all of the targets of a Setter or
Traversal with a user supplied function.
This is an infix version of over.
fmapf ≡mapped%~ffmapDefaultf ≡traverse%~f
>>>(a,b,c) & _3 %~ f(a,b,f c)
>>>(a,b) & both %~ f(f a,f b)
>>>_2 %~ length $ (1,"hello")(1,5)
>>>traverse %~ f $ [a,b,c][f a,f b,f c]
>>>traverse %~ even $ [1,2,3][False,True,False]
>>>traverse.traverse %~ length $ [["hello","world"],["!!!"]][[5,5],[3]]
(%~) ::Setters t a b -> (a -> b) -> s -> t (%~) ::Isos t a b -> (a -> b) -> s -> t (%~) ::Lenss t a b -> (a -> b) -> s -> t (%~) ::Traversals t a b -> (a -> b) -> s -> t
type Lens s t a b = forall (f :: Type -> Type). Functor f => (a -> f b) -> s -> f t #
A Lens is actually a lens family as described in
http://comonad.com/reader/2012/mirrored-lenses/.
With great power comes great responsibility and a Lens is subject to the
three common sense Lens laws:
1) You get back what you put in:
viewl (setl v s) ≡ v
2) Putting back what you got doesn't change anything:
setl (viewl s) s ≡ s
3) Setting twice is the same as setting once:
setl v' (setl v s) ≡setl v' s
These laws are strong enough that the 4 type parameters of a Lens cannot
vary fully independently. For more on how they interact, read the "Why is
it a Lens Family?" section of
http://comonad.com/reader/2012/mirrored-lenses/.
There are some emergent properties of these laws:
1) set l ss This is a consequence of law #1
2) set lv from some s such that set s v = s
3) Given just the first two laws you can prove a weaker form of law #3 where the values v that you are setting match:
setl v (setl v s) ≡setl v s
Every Lens can be used directly as a Setter or Traversal.
You can also use a Lens for Getting as if it were a
Fold or Getter.
Since every Lens is a valid Traversal, the
Traversal laws are required of any Lens you create:
lpure≡purefmap(l f).l g ≡getCompose.l (Compose.fmapf.g)
typeLenss t a b = forall f.Functorf =>LensLikef s t a b
This is a simple runtime exception to indicate that B9 code encountered some exceptional event.
Since: 0.5.64
Constructors
| MkB9Error | |
Fields | |
Instances
| Show B9Error Source # | |
| IsString B9Error Source # | |
Defined in B9.B9Error Methods fromString :: String -> B9Error # | |
| Exception B9Error Source # | |
Defined in B9.B9Error Methods toException :: B9Error -> SomeException # fromException :: SomeException -> Maybe B9Error # displayException :: B9Error -> String # | |
type ExcB9 = Exc SomeException Source #
The exception effect used in most places in B9.
This is Exc specialized with SomeException.
Since: 0.5.64
throwSomeException :: (Member ExcB9 e, Exception x) => x -> Eff e a Source #
SomeException wrapped into Excecption Effects
Since: 0.5.64
throwSomeException_ :: (Member ExcB9 e, Exception x) => x -> Eff e () Source #
SomeException wrapped into Excecption Effects
Since: 0.5.64
throwB9Error :: Member ExcB9 e => String -> Eff e a Source #
SomeException wrapped into Excecption Effects
Since: 0.5.64
throwB9Error_ :: Member ExcB9 e => String -> Eff e () Source #
SomeException wrapped into Excecption Effects
Since: 0.5.64
catchB9Error :: Member ExcB9 e => Eff e a -> (SomeException -> Eff e a) -> Eff e a Source #
Catch exceptions.
Since: 0.5.64
catchB9ErrorAsEither :: Member ExcB9 e => Eff e a -> Eff e (Either SomeException a) Source #
Catch exceptions and return them via Either.
Since: 0.5.64
arbitraryDigit :: Gen Char Source #
newtype SharedImageBuildId Source #
Every B9 build running in a B9Monad
contains a random unique id that is generated once per build (no matter how
many artifacts are created in that build) This field contains the build id
of the build that created the shared image instance. This is A wrapper
around a string contains the build id of a SharedImage; this is purely
additional convenience and typesafety
Constructors
| SharedImageBuildId String |
newtype SharedImageDate Source #
The exact time that build job started.
This is a wrapper around a string contains the build date of a
SharedImage; this is purely additional convenience and typesafety
Constructors
| SharedImageDate String |
newtype SharedImageName Source #
The name of the image is the de-facto identifier for push, pull, From and
Share. B9 always selects the newest version the shared image identified
by that name when using a shared image as an ImageSource. This is a
wrapper around a string that identifies a SharedImage
Constructors
| SharedImageName String |
data SharedImage Source #
SharedImage holds all data necessary to describe an instance of a shared
image identified by a SharedImageName. Shared images are stored in
Repositorys.
type Mounted a = (a, MountPoint) Source #
A type alias that indicates that something of type a is mount at a
MountPoint
data ImageResize Source #
How to resize an image file.
Constructors
| ResizeImage ImageSize | Resize the image but not the file system. Note that
a file system contained in the image file might be
corrupted by this operation. To not only resize the image
file but also the fil system contained in it, use
|
| Resize ImageSize | Resize an image and the contained file system. |
| ShrinkToMinimum | Resize an image and the contained file system to the smallest size to fit the contents of the file system. |
| KeepSize | Do not change the image size. |
Instances
Enumeration of size multipliers. The exact semantics may vary depending on
what external tools look at these. E.g. the size unit is convert to a size
parameter of the qemu-img command line tool.
Instances
| Eq SizeUnit Source # | |
| Data SizeUnit Source # | |
Defined in B9.DiskImages Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SizeUnit -> c SizeUnit # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SizeUnit # toConstr :: SizeUnit -> Constr # dataTypeOf :: SizeUnit -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SizeUnit) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SizeUnit) # gmapT :: (forall b. Data b => b -> b) -> SizeUnit -> SizeUnit # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SizeUnit -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SizeUnit -> r # gmapQ :: (forall d. Data d => d -> u) -> SizeUnit -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SizeUnit -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SizeUnit -> m SizeUnit # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SizeUnit -> m SizeUnit # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SizeUnit -> m SizeUnit # | |
| Ord SizeUnit Source # | |
Defined in B9.DiskImages | |
| Read SizeUnit Source # | |
| Show SizeUnit Source # | |
| Generic SizeUnit Source # | |
| Arbitrary SizeUnit Source # | |
| Hashable SizeUnit Source # | |
Defined in B9.DiskImages | |
| Binary SizeUnit Source # | |
| NFData SizeUnit Source # | |
Defined in B9.DiskImages | |
| type Rep SizeUnit Source # | |
Defined in B9.DiskImages type Rep SizeUnit = D1 (MetaData "SizeUnit" "B9.DiskImages" "b9-0.5.68.2-H3TJySYVfAUHKSkQXiebpT" False) ((C1 (MetaCons "B" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "KB" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "MB" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "GB" PrefixI False) (U1 :: Type -> Type))) | |
A data type for image file or file system size; instead of passing Ints
around this also captures a size unit so that the Int can be kept small
Instances
| Eq ImageSize Source # | |
| Data ImageSize Source # | |
Defined in B9.DiskImages Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ImageSize -> c ImageSize # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ImageSize # toConstr :: ImageSize -> Constr # dataTypeOf :: ImageSize -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ImageSize) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ImageSize) # gmapT :: (forall b. Data b => b -> b) -> ImageSize -> ImageSize # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ImageSize -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ImageSize -> r # gmapQ :: (forall d. Data d => d -> u) -> ImageSize -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ImageSize -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ImageSize -> m ImageSize # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ImageSize -> m ImageSize # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ImageSize -> m ImageSize # | |
| Read ImageSize Source # | |
| Show ImageSize Source # | |
| Generic ImageSize Source # | |
| Arbitrary ImageSize Source # | |
| Hashable ImageSize Source # | |
Defined in B9.DiskImages | |
| Binary ImageSize Source # | |
| NFData ImageSize Source # | |
Defined in B9.DiskImages | |
| type Rep ImageSize Source # | |
Defined in B9.DiskImages type Rep ImageSize = D1 (MetaData "ImageSize" "B9.DiskImages" "b9-0.5.68.2-H3TJySYVfAUHKSkQXiebpT" False) (C1 (MetaCons "ImageSize" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SizeUnit))) | |
data FileSystem Source #
The file systems that b9 can use and convert.
Constructors
| NoFileSystem | |
| Ext4 | |
| Ext4_64 | |
| ISO9660 | |
| VFAT |
Instances
An image type defines the actual file format of a file containing file systems. These are like virtual harddrives
Instances
| Eq ImageType Source # | |
| Data ImageType Source # | |
Defined in B9.DiskImages Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ImageType -> c ImageType # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ImageType # toConstr :: ImageType -> Constr # dataTypeOf :: ImageType -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ImageType) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ImageType) # gmapT :: (forall b. Data b => b -> b) -> ImageType -> ImageType # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ImageType -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ImageType -> r # gmapQ :: (forall d. Data d => d -> u) -> ImageType -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ImageType -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ImageType -> m ImageType # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ImageType -> m ImageType # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ImageType -> m ImageType # | |
| Read ImageType Source # | |
| Show ImageType Source # | |
| Generic ImageType Source # | |
| Arbitrary ImageType Source # | |
| Hashable ImageType Source # | |
Defined in B9.DiskImages | |
| Binary ImageType Source # | |
| NFData ImageType Source # | |
Defined in B9.DiskImages | |
| type Rep ImageType Source # | |
Defined in B9.DiskImages | |
A vm disk image file consisting of a path to the image file, and the type and file system.
Constructors
| Image FilePath ImageType FileSystem |
Instances
| Eq Image Source # | |
| Data Image Source # | |
Defined in B9.DiskImages Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Image -> c Image # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Image # dataTypeOf :: Image -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Image) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Image) # gmapT :: (forall b. Data b => b -> b) -> Image -> Image # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Image -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Image -> r # gmapQ :: (forall d. Data d => d -> u) -> Image -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Image -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Image -> m Image # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Image -> m Image # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Image -> m Image # | |
| Read Image Source # | |
| Show Image Source # | |
| Generic Image Source # | |
| Arbitrary Image Source # | |
| Hashable Image Source # | |
Defined in B9.DiskImages | |
| Binary Image Source # | |
| NFData Image Source # | |
Defined in B9.DiskImages | |
| type Rep Image Source # | |
Defined in B9.DiskImages type Rep Image = D1 (MetaData "Image" "B9.DiskImages" "b9-0.5.68.2-H3TJySYVfAUHKSkQXiebpT" False) (C1 (MetaCons "Image" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ImageType) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FileSystem)))) | |
The partition to extract.
Constructors
| NoPT | There is no partition table on the image |
| Partition Int | Extract partition |
Instances
| Eq Partition Source # | |
| Data Partition Source # | |
Defined in B9.DiskImages Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Partition -> c Partition # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Partition # toConstr :: Partition -> Constr # dataTypeOf :: Partition -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Partition) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Partition) # gmapT :: (forall b. Data b => b -> b) -> Partition -> Partition # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Partition -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Partition -> r # gmapQ :: (forall d. Data d => d -> u) -> Partition -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Partition -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Partition -> m Partition # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Partition -> m Partition # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Partition -> m Partition # | |
| Read Partition Source # | |
| Show Partition Source # | |
| Generic Partition Source # | |
| Arbitrary Partition Source # | |
| Hashable Partition Source # | |
Defined in B9.DiskImages | |
| Binary Partition Source # | |
| NFData Partition Source # | |
Defined in B9.DiskImages | |
| type Rep Partition Source # | |
Defined in B9.DiskImages type Rep Partition = D1 (MetaData "Partition" "B9.DiskImages" "b9-0.5.68.2-H3TJySYVfAUHKSkQXiebpT" False) (C1 (MetaCons "NoPT" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Partition" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int))) | |
data ImageSource Source #
Specification of how the image to build is obtained.
Constructors
| EmptyImage String FileSystem ImageType ImageSize | Create an empty image file having a file system label
(first parameter), a file system type (e.g. |
| CopyOnWrite Image | DEPRECATED |
| SourceImage Image Partition ImageResize | Clone an existing image file; if the image file contains
partitions, select the partition to use, b9 will extract
that partition by reading the offset of the partition from
the partition table and extract it using |
| From String ImageResize | Use an image previously shared by via |
Instances
data ImageDestination Source #
The destination of an image.
Constructors
| Share String ImageType ImageResize | Create the image and some meta data so that other
builds can use them as |
| LiveInstallerImage String FilePath ImageResize | DEPRECATED Export a raw image that can directly be booted. |
| LocalFile Image ImageResize | Write an image file to the path in the first argument., possible resizing it, |
| Transient | Do not export the image. Usefule if the main objective of the b9 build is not an image file, but rather some artifact produced by executing by a containerize build. |
Instances
data MountPoint Source #
A mount point or NotMounted
Constructors
| MountPoint FilePath | |
| NotMounted |
Instances
data ImageTarget Source #
Build target for disk images; the destination, format and size of the image
to generate, as well as how to create or obtain the image before a
VmScript is executed with the image mounted at a MountPoint.
Constructors
| ImageTarget ImageDestination ImageSource MountPoint |
Instances
fromSharedImageName :: SharedImageName -> String Source #
Get the String representation of a SharedImageName.
fromSharedImageBuildId :: SharedImageBuildId -> String Source #
Get the String representation of a SharedImageBuildId.
getImageDestinationOutputFiles :: ImageTarget -> [FilePath] Source #
Return the files generated for a LocalFile or a LiveInstallerImage; SharedImage and Transient
are treated like they have no ouput files because the output files are manged
by B9.
imageDestinationSharedImageName :: ImageDestination -> Maybe SharedImageName Source #
Return the name of a shared image, if the ImageDestination is a Share
destination
imageSourceSharedImageName :: ImageSource -> Maybe SharedImageName Source #
Return the name of a shared source image, if the ImageSource is a From
source
itImageDestination :: ImageTarget -> ImageDestination Source #
Get the ImageDestination of an ImageTarget
itImageSource :: ImageTarget -> ImageSource Source #
Get the ImageSource of an ImageTarget
itImageMountPoint :: ImageTarget -> MountPoint Source #
Get the MountPoint of an ImageTarget
isPartitioned :: Partition -> Bool Source #
getPartition :: Partition -> Int Source #
imageFileExtension :: ImageType -> String Source #
Return the file name extension of an image file with a specific image format.
changeImageFormat :: ImageType -> Image -> Image Source #
Change the image file format and also rename the image file name to
have the appropriate file name extension. See imageFileExtension and
replaceExtension
sharedImageName :: SharedImage -> SharedImageName Source #
Return the name of a shared image.
sharedImageDate :: SharedImage -> SharedImageDate Source #
Return the build date of a shared image.
sharedImageBuildId :: SharedImage -> SharedImageBuildId Source #
Return the build id of a shared image.
prettyPrintSharedImages :: [SharedImage] -> String Source #
Print the contents of the shared image in one line
sharedImageImage :: SharedImage -> Image Source #
Return the disk image of an sharedImage
sharedImageFileName :: SharedImage -> FilePath Source #
Calculate the path to the text file holding the serialized SharedImage
relative to the directory of shared images in a repository.
sharedImageDefaultImageType :: ImageType Source #
The internal image type to use as best guess when dealing with a From
value.
transientCOWImage :: FilePath -> FilePath -> ImageTarget Source #
transientSharedImage :: SharedImageName -> FilePath -> ImageTarget Source #
Use a shared image
transientLocalImage :: FilePath -> FilePath -> ImageTarget Source #
Use a shared image
shareCOWImage :: FilePath -> SharedImageName -> FilePath -> ImageTarget Source #
shareSharedImage :: SharedImageName -> SharedImageName -> FilePath -> ImageTarget Source #
Share an image based on a shared image
shareLocalImage :: FilePath -> SharedImageName -> FilePath -> ImageTarget Source #
cowToliveInstallerImage :: String -> FilePath -> FilePath -> FilePath -> ImageTarget Source #
cowToLocalImage :: FilePath -> FilePath -> FilePath -> ImageTarget Source #
localToLocalImage :: FilePath -> FilePath -> FilePath -> ImageTarget Source #
partition1ToLocalImage :: FilePath -> FilePath -> FilePath -> ImageTarget Source #
Create a local image file from the contents of the first partition
of a local QCow2 image.
splitToIntermediateSharedImage :: ImageTarget -> SharedImageName -> (ImageTarget, ImageTarget) Source #
Split any image target into two image targets, one for creating an intermediate shared image and one from the intermediate shared image to the output image.
Constructors
| RamSize Int SizeUnit | |
| AutomaticRamSize |
Instances
| Eq RamSize Source # | |
| Data RamSize Source # | |
Defined in B9.ExecEnv Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RamSize -> c RamSize # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RamSize # toConstr :: RamSize -> Constr # dataTypeOf :: RamSize -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RamSize) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RamSize) # gmapT :: (forall b. Data b => b -> b) -> RamSize -> RamSize # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RamSize -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RamSize -> r # gmapQ :: (forall d. Data d => d -> u) -> RamSize -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RamSize -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RamSize -> m RamSize # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RamSize -> m RamSize # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RamSize -> m RamSize # | |
| Ord RamSize Source # | |
| Read RamSize Source # | |
| Show RamSize Source # | |
| Generic RamSize Source # | |
| Semigroup RamSize Source # | |
| Monoid RamSize Source # | |
| Hashable RamSize Source # | |
Defined in B9.ExecEnv | |
| Binary RamSize Source # | |
| NFData RamSize Source # | |
Defined in B9.ExecEnv | |
| type Rep RamSize Source # | |
Defined in B9.ExecEnv type Rep RamSize = D1 (MetaData "RamSize" "B9.ExecEnv" "b9-0.5.68.2-H3TJySYVfAUHKSkQXiebpT" False) (C1 (MetaCons "RamSize" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SizeUnit)) :+: C1 (MetaCons "AutomaticRamSize" PrefixI False) (U1 :: Type -> Type)) | |
Instances
| Eq CPUArch Source # | |
| Data CPUArch Source # | |
Defined in B9.ExecEnv Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CPUArch -> c CPUArch # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CPUArch # toConstr :: CPUArch -> Constr # dataTypeOf :: CPUArch -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CPUArch) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CPUArch) # gmapT :: (forall b. Data b => b -> b) -> CPUArch -> CPUArch # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CPUArch -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CPUArch -> r # gmapQ :: (forall d. Data d => d -> u) -> CPUArch -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CPUArch -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CPUArch -> m CPUArch # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CPUArch -> m CPUArch # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CPUArch -> m CPUArch # | |
| Read CPUArch Source # | |
| Show CPUArch Source # | |
| Generic CPUArch Source # | |
| Semigroup CPUArch Source # | |
| Monoid CPUArch Source # | |
| Hashable CPUArch Source # | |
Defined in B9.ExecEnv | |
| Binary CPUArch Source # | |
| NFData CPUArch Source # | |
Defined in B9.ExecEnv | |
| type Rep CPUArch Source # | |
Instances
data SharedDirectory Source #
Constructors
| SharedDirectory FilePath MountPoint | |
| SharedDirectoryRO FilePath MountPoint | |
| SharedSources MountPoint |
Constructors
| ExecEnv | |
Fields
| |
Instances
| Eq ExecEnv Source # | |
| Data ExecEnv Source # | |
Defined in B9.ExecEnv Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExecEnv -> c ExecEnv # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExecEnv # toConstr :: ExecEnv -> Constr # dataTypeOf :: ExecEnv -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ExecEnv) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExecEnv) # gmapT :: (forall b. Data b => b -> b) -> ExecEnv -> ExecEnv # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExecEnv -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExecEnv -> r # gmapQ :: (forall d. Data d => d -> u) -> ExecEnv -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ExecEnv -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExecEnv -> m ExecEnv # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecEnv -> m ExecEnv # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecEnv -> m ExecEnv # | |
| Read ExecEnv Source # | |
| Show ExecEnv Source # | |
| Generic ExecEnv Source # | |
| Hashable ExecEnv Source # | |
Defined in B9.ExecEnv | |
| Binary ExecEnv Source # | |
| NFData ExecEnv Source # | |
Defined in B9.ExecEnv | |
| type Rep ExecEnv Source # | |
Defined in B9.ExecEnv type Rep ExecEnv = D1 (MetaData "ExecEnv" "B9.ExecEnv" "b9-0.5.68.2-H3TJySYVfAUHKSkQXiebpT" False) (C1 (MetaCons "ExecEnv" PrefixI True) ((S1 (MetaSel (Just "envName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "envImageMounts") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Mounted Image])) :*: (S1 (MetaSel (Just "envSharedDirectories") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [SharedDirectory]) :*: S1 (MetaSel (Just "envResources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Resources)))) | |
Instances
| Eq User Source # | |
| Data User Source # | |
Defined in B9.ShellScript Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> User -> c User # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c User # dataTypeOf :: User -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c User) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c User) # gmapT :: (forall b. Data b => b -> b) -> User -> User # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> User -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> User -> r # gmapQ :: (forall d. Data d => d -> u) -> User -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> User -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> User -> m User # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> User -> m User # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> User -> m User # | |
| Read User Source # | |
| Show User Source # | |
| Generic User Source # | |
| Hashable User Source # | |
Defined in B9.ShellScript | |
| Binary User Source # | |
| NFData User Source # | |
Defined in B9.ShellScript | |
| type Rep User Source # | |
Defined in B9.ShellScript type Rep User = D1 (MetaData "User" "B9.ShellScript" "b9-0.5.68.2-H3TJySYVfAUHKSkQXiebpT" False) (C1 (MetaCons "User" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: C1 (MetaCons "NoUser" PrefixI False) (U1 :: Type -> Type)) | |
Instances
| Eq Cwd Source # | |
| Data Cwd Source # | |
Defined in B9.ShellScript Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Cwd -> c Cwd # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Cwd # dataTypeOf :: Cwd -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Cwd) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Cwd) # gmapT :: (forall b. Data b => b -> b) -> Cwd -> Cwd # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Cwd -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Cwd -> r # gmapQ :: (forall d. Data d => d -> u) -> Cwd -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Cwd -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Cwd -> m Cwd # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Cwd -> m Cwd # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Cwd -> m Cwd # | |
| Read Cwd Source # | |
| Show Cwd Source # | |
| Generic Cwd Source # | |
| Hashable Cwd Source # | |
Defined in B9.ShellScript | |
| Binary Cwd Source # | |
| NFData Cwd Source # | |
Defined in B9.ShellScript | |
| type Rep Cwd Source # | |
Defined in B9.ShellScript type Rep Cwd = D1 (MetaData "Cwd" "B9.ShellScript" "b9-0.5.68.2-H3TJySYVfAUHKSkQXiebpT" False) (C1 (MetaCons "Cwd" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :+: C1 (MetaCons "NoCwd" PrefixI False) (U1 :: Type -> Type)) | |
data CmdVerbosity Source #
Constructors
| Debug | |
| Verbose | |
| OnlyStdErr | |
| Quiet |
Instances
Constructors
| In FilePath [Script] | |
| As String [Script] | |
| IgnoreErrors Bool [Script] | |
| Verbosity CmdVerbosity [Script] | |
| Begin [Script] | |
| Run FilePath [String] | |
| NoOP |
Instances
writeSh :: FilePath -> Script -> IO () Source #
Convert script to bash-shell-script written to file and make file
executable.
renderScript :: Script -> String Source #
class Textual a where Source #
A class for values that can be converted to/from Text.
Since: 0.5.67
Methods
renderToText :: HasCallStack => a -> Either String Text Source #
parseFromText :: HasCallStack => Text -> Either String a Source #
Instances
Lazy texts.
A type alias to Text that can be used everywhere such that
references don't need to be qualified with the complete module name everywere.
Since: 0.5.67
type LazyByteString = ByteString Source #
Lazy byte strings.
A type alias to ByteString that can be used everywhere such that
references don't need to be qualified with the complete module name everywere.
Since: 0.5.67
writeTextFile :: (HasCallStack, MonadIO m) => FilePath -> Text -> m () Source #
Render a Text to a file.
Since: 0.5.67
unsafeRenderToText :: (Textual a, HasCallStack) => a -> Text Source #
Render a Text via renderToText and throw a runtime exception when rendering fails.
Since: 0.5.67
unsafeParseFromText :: (Textual a, HasCallStack) => Text -> a Source #
Parse a Text via parseFromText and throw a runtime exception when parsing fails.
Since: 0.5.67
encodeAsUtf8LazyByteString :: HasCallStack => String -> LazyByteString Source #
Encode a String as UTF-8 encoded into a LazyByteString.
Since: 0.5.67
parseFromTextWithErrorMessage Source #
Arguments
| :: (HasCallStack, Textual a) | |
| => String | An arbitrary string for error messages |
| -> Text | |
| -> Either String a |
Parse the given Text. -- Return Left errorMessage or Right a.
data KeyNotFound Source #
An Exception thrown by lookupOrThrow indicating that a key does not exist.
@Since 0.5.62
Constructors
| MkKeyNotFound Text Environment |
Instances
| Eq KeyNotFound Source # | |
Defined in B9.Environment | |
| Show KeyNotFound Source # | |
Defined in B9.Environment Methods showsPrec :: Int -> KeyNotFound -> ShowS # show :: KeyNotFound -> String # showList :: [KeyNotFound] -> ShowS # | |
| Exception KeyNotFound Source # | |
Defined in B9.Environment Methods toException :: KeyNotFound -> SomeException # fromException :: SomeException -> Maybe KeyNotFound # displayException :: KeyNotFound -> String # | |
data DuplicateKey Source #
An Exception thrown by addBinding indicating that a key already exists.
@Since 0.5.62
Constructors
| MkDuplicateKey | |
Fields | |
Instances
| Eq DuplicateKey Source # | |
Defined in B9.Environment | |
| Show DuplicateKey Source # | |
Defined in B9.Environment Methods showsPrec :: Int -> DuplicateKey -> ShowS # show :: DuplicateKey -> String # showList :: [DuplicateKey] -> ShowS # | |
| Exception DuplicateKey Source # | |
Defined in B9.Environment Methods toException :: DuplicateKey -> SomeException # fromException :: SomeException -> Maybe DuplicateKey # displayException :: DuplicateKey -> String # | |
type EnvironmentReader = Reader Environment Source #
A monad transformer providing a MonadReader instance for Environment
Since: 0.5.62
data Environment Source #
A map of textual keys to textual values.
Since: 0.5.62
Instances
addPositionalArguments :: [Text] -> Environment -> Environment Source #
If environment variables arg_1 .. arg_n are bound
and a list of k additional values are passed to this function,
store them with keys arg_(n+1) .. arg_(n+k).
Note that the Environment contains an index of the next position.
Since: 0.5.62
addLocalPositionalArguments :: Member EnvironmentReader e => [String] -> Eff e a -> Eff e a Source #
Convenient wrapper around addPositionalArguments and localEnvironment.
Since: 0.5.65
fromStringPairs :: [(String, String)] -> Environment Source #
Create an Environment from a list of pairs (Strings).
Duplicated entries are ignored.
Since: 0.5.62
addBinding :: Member ExcB9 e => (Text, Text) -> Environment -> Eff e Environment Source #
Insert a key value binding to the Environment.
Throw DuplicateKey if the key already exists, but
the value is not equal to the given value.
Since: 0.5.67
addStringBinding :: Member ExcB9 e => (String, String) -> Environment -> Eff e Environment Source #
Insert Strings into the Environment, see addBinding.
Since: 0.5.62
addLocalStringBinding :: (Member EnvironmentReader e, Member ExcB9 e) => (String, String) -> Eff e a -> Eff e a Source #
Insert a value into an Environment like addStringBinding,
but add it to the environment of the given effect, as in localEnvironment.
Since: 0.5.65
runEnvironmentReader :: Environment -> Eff (EnvironmentReader ': e) a -> Eff e a Source #
Run a ReaderT of Environment.
Since: 0.5.62
askEnvironment :: Member EnvironmentReader e => Eff e Environment Source #
Get the current Environment
Since: 0.5.62
localEnvironment :: Member EnvironmentReader e => (Environment -> Environment) -> Eff e a -> Eff e a Source #
Run a computation with a modified Environment
Since: 0.5.62
lookupOrThrow :: '[ExcB9, EnvironmentReader] <:: e => Text -> Eff e Text Source #
Lookup a key for a value.
throwM a KeyNotFound Exception if no value with the given key exists
in the Environment.
@Since 0.5.62
lookupEither :: Member EnvironmentReader e => Text -> Eff e (Either KeyNotFound Text) Source #
Lookup a key for a value.
Return Either Left KeyNotFound, if no value with the given key exists
in the Environment, or Right the value.
@Since 0.5.62
hasKey :: Member EnvironmentReader e => Text -> Eff e Bool Source #
A predicate that is satisfied when a key exists in the environment.
Since: 0.5.64
data SimpleErlangTerm Source #
Simplified Erlang term representation.
Constructors
| ErlString String | |
| ErlFloat Double | |
| ErlNatural Integer | |
| ErlAtom String | |
| ErlChar Char | |
| ErlBinary String | |
| ErlList [SimpleErlangTerm] | |
| ErlTuple [SimpleErlangTerm] |
Instances
parseErlTerm :: String -> Text -> Either String SimpleErlangTerm Source #
Parse a subset of valid Erlang terms. It parses no maps and binaries are restricted to either empty binaries or binaries with a string. The input encoding must be restricted to ascii compatible 8-bit characters (e.g. latin-1 or UTF8).
renderErlTerm :: SimpleErlangTerm -> Text Source #
Convert an abstract Erlang term to a pretty byte string preserving the encoding.
A bunch of numbers, enough to make globally unique IDs. Create one of these
using randomUUID.
data ConsultException Source #
Constructors
| ConsultException FilePath String |
Instances
| Show ConsultException Source # | |
Defined in System.IO.B9Extras Methods showsPrec :: Int -> ConsultException -> ShowS # show :: ConsultException -> String # showList :: [ConsultException] -> ShowS # | |
| Exception ConsultException Source # | |
Defined in System.IO.B9Extras Methods toException :: ConsultException -> SomeException # | |
data SystemPath Source #
A data type encapsulating different kinds of relative or absolute paths.
Constructors
| Path FilePath | A path that will just be passed through |
| InHomeDir FilePath | A OS specific path relative to the home directory of a user. |
| InB9UserDir FilePath | A path relative to the |
| InTempDir FilePath | A path relative to the systems temporary directory. |
Instances
| Eq SystemPath Source # | |
Defined in System.IO.B9Extras | |
| Data SystemPath Source # | |
Defined in System.IO.B9Extras Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SystemPath -> c SystemPath # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SystemPath # toConstr :: SystemPath -> Constr # dataTypeOf :: SystemPath -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SystemPath) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SystemPath) # gmapT :: (forall b. Data b => b -> b) -> SystemPath -> SystemPath # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SystemPath -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SystemPath -> r # gmapQ :: (forall d. Data d => d -> u) -> SystemPath -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SystemPath -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SystemPath -> m SystemPath # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SystemPath -> m SystemPath # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SystemPath -> m SystemPath # | |
| Read SystemPath Source # | |
Defined in System.IO.B9Extras Methods readsPrec :: Int -> ReadS SystemPath # readList :: ReadS [SystemPath] # readPrec :: ReadPrec SystemPath # readListPrec :: ReadPrec [SystemPath] # | |
| Show SystemPath Source # | |
Defined in System.IO.B9Extras Methods showsPrec :: Int -> SystemPath -> ShowS # show :: SystemPath -> String # showList :: [SystemPath] -> ShowS # | |
overSystemPath :: (FilePath -> FilePath) -> SystemPath -> SystemPath Source #
Transform a SystemPath
resolve :: MonadIO m => SystemPath -> m FilePath Source #
Convert a SystemPath to a FilePath.
getDirectoryFiles :: MonadIO m => FilePath -> m [FilePath] Source #
Get all files from dir that is get ONLY files not directories
ensureDir :: MonadIO m => FilePath -> m () Source #
Create all missing parent directories of a file path.
Note that the file path is assumed to be of a regular file, and
takeDirectory is applied before creating the directory.
consult :: (MonadIO m, Read a) => FilePath -> m a Source #
Read a value of a type that is an instance of Read from a file.
This function throws a ConsultException when the read the file failed.
newtype SshRemoteUser Source #
Constructors
| SshRemoteUser String |
Instances
newtype SshRemoteHost Source #
Constructors
| SshRemoteHost (String, Int) |
Instances
newtype SshPrivKey Source #
Constructors
| SshPrivKey FilePath |
Instances
| Eq SshPrivKey Source # | |
Defined in B9.B9Config.Repository | |
| Data SshPrivKey Source # | |
Defined in B9.B9Config.Repository Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SshPrivKey -> c SshPrivKey # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SshPrivKey # toConstr :: SshPrivKey -> Constr # dataTypeOf :: SshPrivKey -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SshPrivKey) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SshPrivKey) # gmapT :: (forall b. Data b => b -> b) -> SshPrivKey -> SshPrivKey # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SshPrivKey -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SshPrivKey -> r # gmapQ :: (forall d. Data d => d -> u) -> SshPrivKey -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SshPrivKey -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SshPrivKey -> m SshPrivKey # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SshPrivKey -> m SshPrivKey # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SshPrivKey -> m SshPrivKey # | |
| Read SshPrivKey Source # | |
Defined in B9.B9Config.Repository Methods readsPrec :: Int -> ReadS SshPrivKey # readList :: ReadS [SshPrivKey] # readPrec :: ReadPrec SshPrivKey # readListPrec :: ReadPrec [SshPrivKey] # | |
| Show SshPrivKey Source # | |
Defined in B9.B9Config.Repository Methods showsPrec :: Int -> SshPrivKey -> ShowS # show :: SshPrivKey -> String # showList :: [SshPrivKey] -> ShowS # | |
data RemoteRepo Source #
Constructors
| RemoteRepo String FilePath SshPrivKey SshRemoteHost SshRemoteUser |
Instances
| Eq RemoteRepo Source # | |
Defined in B9.B9Config.Repository | |
| Data RemoteRepo Source # | |
Defined in B9.B9Config.Repository Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RemoteRepo -> c RemoteRepo # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RemoteRepo # toConstr :: RemoteRepo -> Constr # dataTypeOf :: RemoteRepo -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RemoteRepo) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RemoteRepo) # gmapT :: (forall b. Data b => b -> b) -> RemoteRepo -> RemoteRepo # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RemoteRepo -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RemoteRepo -> r # gmapQ :: (forall d. Data d => d -> u) -> RemoteRepo -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RemoteRepo -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RemoteRepo -> m RemoteRepo # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RemoteRepo -> m RemoteRepo # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RemoteRepo -> m RemoteRepo # | |
| Read RemoteRepo Source # | |
Defined in B9.B9Config.Repository Methods readsPrec :: Int -> ReadS RemoteRepo # readList :: ReadS [RemoteRepo] # readPrec :: ReadPrec RemoteRepo # readListPrec :: ReadPrec [RemoteRepo] # | |
| Show RemoteRepo Source # | |
Defined in B9.B9Config.Repository Methods showsPrec :: Int -> RemoteRepo -> ShowS # show :: RemoteRepo -> String # showList :: [RemoteRepo] -> ShowS # | |
Instances
| Data RepoCache Source # | |
Defined in B9.B9Config.Repository Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RepoCache -> c RepoCache # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RepoCache # toConstr :: RepoCache -> Constr # dataTypeOf :: RepoCache -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RepoCache) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RepoCache) # gmapT :: (forall b. Data b => b -> b) -> RepoCache -> RepoCache # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RepoCache -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RepoCache -> r # gmapQ :: (forall d. Data d => d -> u) -> RepoCache -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RepoCache -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RepoCache -> m RepoCache # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RepoCache -> m RepoCache # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RepoCache -> m RepoCache # | |
| Read RepoCache Source # | |
| Show RepoCache Source # | |
remoteRepoRepoId :: RemoteRepo -> String Source #
remoteRepoToCPDocument :: RemoteRepo -> CPDocument -> Either CPError CPDocument Source #
Persist a repo to a configuration file.
parseRemoteRepos :: CPDocument -> Either CPError [RemoteRepo] Source #
Load a repository from a configuration file that has been written by
writeRepositoryToB9Config.
data LXCGuestCapability Source #
Available linux capabilities for lxc containers. This maps directly to the capabilities defined in 'man 7 capabilities'.
Constructors
Instances
| Eq LXCGuestCapability Source # | |
Defined in B9.B9Config.LibVirtLXC Methods (==) :: LXCGuestCapability -> LXCGuestCapability -> Bool # (/=) :: LXCGuestCapability -> LXCGuestCapability -> Bool # | |
| Read LXCGuestCapability Source # | |
Defined in B9.B9Config.LibVirtLXC Methods readsPrec :: Int -> ReadS LXCGuestCapability # readList :: ReadS [LXCGuestCapability] # | |
| Show LXCGuestCapability Source # | |
Defined in B9.B9Config.LibVirtLXC Methods showsPrec :: Int -> LXCGuestCapability -> ShowS # show :: LXCGuestCapability -> String # showList :: [LXCGuestCapability] -> ShowS # | |
data LibVirtLXCConfig Source #
Constructors
| LibVirtLXCConfig | |
Fields
| |
Instances
| Eq LibVirtLXCConfig Source # | |
Defined in B9.B9Config.LibVirtLXC Methods (==) :: LibVirtLXCConfig -> LibVirtLXCConfig -> Bool # (/=) :: LibVirtLXCConfig -> LibVirtLXCConfig -> Bool # | |
| Read LibVirtLXCConfig Source # | |
Defined in B9.B9Config.LibVirtLXC Methods readsPrec :: Int -> ReadS LibVirtLXCConfig # readList :: ReadS [LibVirtLXCConfig] # | |
| Show LibVirtLXCConfig Source # | |
Defined in B9.B9Config.LibVirtLXC Methods showsPrec :: Int -> LibVirtLXCConfig -> ShowS # show :: LibVirtLXCConfig -> String # showList :: [LibVirtLXCConfig] -> ShowS # | |
libVirtLXCConfigToCPDocument :: LibVirtLXCConfig -> CPDocument -> Either CPError CPDocument Source #
getEmulatorPath :: MonadIO m => LibVirtLXCConfig -> m FilePath Source #
Return the path to usrliblibvirtlibexec/libvirt_lxc
the emulatorK field from the config file, or set the path
in the environment variable named like the value in emulatorEnvVar
dictates.
Since: 0.5.66
data B9ConfigOverride Source #
Override b9 configuration items and/or the path of the b9 configuration file. This is useful, i.e. when dealing with command line parameters.
Constructors
| B9ConfigOverride | |
Instances
| Show B9ConfigOverride Source # | |
Defined in B9.B9Config Methods showsPrec :: Int -> B9ConfigOverride -> ShowS # show :: B9ConfigOverride -> String # showList :: [B9ConfigOverride] -> ShowS # | |
type B9ConfigReader = Reader B9Config Source #
Reader for B9Config. See getB9Config and localB9Config.
Since: 0.5.65
Constructors
Constructors
| LogTrace | |
| LogDebug | |
| LogInfo | |
| LogError | |
| LogNothing |
data ExecEnvType Source #
Constructors
| LibVirtLXC |
Instances
| Eq ExecEnvType Source # | |
Defined in B9.B9Config | |
| Ord ExecEnvType Source # | |
Defined in B9.B9Config Methods compare :: ExecEnvType -> ExecEnvType -> Ordering # (<) :: ExecEnvType -> ExecEnvType -> Bool # (<=) :: ExecEnvType -> ExecEnvType -> Bool # (>) :: ExecEnvType -> ExecEnvType -> Bool # (>=) :: ExecEnvType -> ExecEnvType -> Bool # max :: ExecEnvType -> ExecEnvType -> ExecEnvType # min :: ExecEnvType -> ExecEnvType -> ExecEnvType # | |
| Read ExecEnvType Source # | |
Defined in B9.B9Config Methods readsPrec :: Int -> ReadS ExecEnvType # readList :: ReadS [ExecEnvType] # readPrec :: ReadPrec ExecEnvType # readListPrec :: ReadPrec [ExecEnvType] # | |
| Show ExecEnvType Source # | |
Defined in B9.B9Config Methods showsPrec :: Int -> ExecEnvType -> ShowS # show :: ExecEnvType -> String # showList :: [ExecEnvType] -> ShowS # | |
runB9ConfigReader :: HasCallStack => B9Config -> Eff (B9ConfigReader ': e) a -> Eff e a Source #
Run a B9ConfigReader.
Since: 0.5.65
getB9Config :: Member B9ConfigReader e => Eff e B9Config Source #
Return the runtime configuration, that should be the configuration merged from all configuration sources. This is the configuration to be used during a VM image build.
Since: 0.5.65
localB9Config :: Member B9ConfigReader e => (B9Config -> B9Config) -> Eff e a -> Eff e a Source #
Run an action with an updated runtime configuration.
Since: 0.5.65
isInteractive :: Member B9ConfigReader e => Eff e Bool Source #
Ask whether stdin of the B9 process should be redirected to the
external commands executed during the build.
Since: 0.5.65
getExecEnvType :: Member B9ConfigReader e => Eff e ExecEnvType Source #
Ask for the ExecEnvType.
Since: 0.5.65
getRemoteRepos :: Member B9ConfigReader e => Eff e [RemoteRepo] Source #
Ask for the RemoteRepos.
Since: 0.5.65
getLogVerbosity :: Member B9ConfigReader e => Eff e (Maybe LogLevel) Source #
Ask for the LogLevel.
Since: 0.5.65
getProjectRoot :: Member B9ConfigReader e => Eff e FilePath Source #
Ask for the project root directory.
Since: 0.5.65
noB9ConfigOverride :: B9ConfigOverride Source #
An empty default B9ConfigOverride value, that will neither apply any
additional B9Config nor change the path of the configuration file.
type B9ConfigWriter = Writer (Endo B9Config) Source #
Accumulate B9Config changes that go back to the config file. See
B9ConfigAction and modifyPermanentConfig.
Since: 0.5.65
type B9ConfigAction a = Eff '[B9ConfigWriter, B9ConfigReader, EnvironmentReader, Lift IO] a Source #
A monad that gives access to the (transient) B9Config to be used at
_runtime_ with getB9Config or localB9Config, and that allows
to write permanent B9Config changes back to the configuration file using
modifyPermanentConfig. This is the amalgamation of B9ConfigWriter
B9ConfigReader and IO.
Since: 0.5.65
overrideB9ConfigPath :: SystemPath -> B9ConfigOverride -> B9ConfigOverride Source #
Convenience utility to override the B9 configuration file path.
overrideB9Config :: (B9Config -> B9Config) -> B9ConfigOverride -> B9ConfigOverride Source #
Modify the runtime configuration.
overrideWorkingDirectory :: FilePath -> B9ConfigOverride -> B9ConfigOverride Source #
Define the current working directory to be used when building.
overrideVerbosity :: LogLevel -> B9ConfigOverride -> B9ConfigOverride Source #
Overwrite the verbosity settings in the configuration with those given.
overrideKeepBuildDirs :: Bool -> B9ConfigOverride -> B9ConfigOverride Source #
Overwrite the keepTempDirs flag in the configuration with those given.
modifyPermanentConfig :: (HasCallStack, Member B9ConfigWriter e) => Endo B9Config -> Eff e () Source #
Add a modification to the permanent configuration file.
runB9ConfigActionWithOverrides :: HasCallStack => B9ConfigAction a -> B9ConfigOverride -> IO a Source #
Execute a B9ConfigAction.
It will take a B9ConfigOverride as input. The B9Config in that value is
treated as the _runtime_ configuration, and the _customConfigPath is used
as the alternative location of the configuration file.
The configuration file is read from either the path in _customB9ConfigPath
or from defaultB9ConfigFile.
Every modification done via modifyPermanentConfig is applied to
the **contents** of the configuration file
and written back to that file, note that these changes are ONLY reflected
in the configuration file and **not** in the _runtime configuration_.
See also runB9ConfigAction, which does not need the B9ConfigOverride parameter.
Since: 0.5.65
runB9ConfigAction :: HasCallStack => B9ConfigAction a -> IO a Source #
Run a B9ConfigAction using noB9ConfigOverride.
See runB9ConfigActionWithOverrides for more details.
Since: 0.5.65
openOrCreateB9Config :: (HasCallStack, MonadIO m) => FilePath -> m CPDocument Source #
Open the configuration file that contains the B9Config.
If the configuration does not exist, write a default configuration file,
and create a all missing directories.
writeB9CPDocument :: (HasCallStack, MonadIO m) => Maybe SystemPath -> CPDocument -> m () Source #
Write the configuration in the CPDocument to either the user supplied
configuration file path or to defaultB9ConfigFile.
Create all missing (parent) directories.
modifyCPDocument :: CPDocument -> Endo B9Config -> Either CPError CPDocument Source #
Parse a B9Config, modify it, and merge it back to the given CPDocument.
b9ConfigToCPDocument :: HasCallStack => B9Config -> Either CPError CPDocument Source #
Append a config file section for the B9Config to an empty CPDocument.
readB9Config :: (HasCallStack, MonadIO m) => Maybe SystemPath -> m CPDocument Source #
parseB9Config :: HasCallStack => CPDocument -> Either CPError B9Config Source #
type SelectedRemoteRepoReader = Reader SelectedRemoteRepo Source #
Alias for a Reader Effect that reads the RemoteRepo
selected by the B9Config value _repository. See withSelectedRemoteRepo.
Since: 0.5.65
newtype SelectedRemoteRepo Source #
Contains the Just the RemoteRepo selected by the B9Config value _repository,
or Nothing of no RemoteRepo was selected in the B9Config.
Since: 0.5.65
Constructors
| MkSelectedRemoteRepo | |
Fields | |
type RepoCacheReader = Reader RepoCache Source #
Alias for a Reader Effect that reads a list of RemoteRepos.
Since: 0.5.65
withRemoteRepos :: (Member B9ConfigReader e, Lifted IO e) => Eff (RepoCacheReader ': e) a -> Eff e a Source #
Initialize the local repository cache directory and the RemoteRepos.
Run the given action with a B9Config that contains the initialized
repositories in _remoteRepos.
Since: 0.5.65
getRepoCache :: Member RepoCacheReader e => Eff e RepoCache Source #
Ask for the RepoCache initialized by withRemoteRepos.
Since: 0.5.65
withSelectedRemoteRepo :: (Member B9ConfigReader e, Member ExcB9 e) => Eff (SelectedRemoteRepoReader ': e) a -> Eff e a Source #
Run a SelectedRemoteRepoReader with the SelectedRemoteRepo selected
in the B9Config.
If the selected repo does not exist, and exception is thrown.
Since: 0.5.65
getSelectedRemoteRepo :: Member SelectedRemoteRepoReader e => Eff e SelectedRemoteRepo Source #
Ask for the RemoteRepo
selected by the B9Config value _repository. See withSelectedRemoteRepo.
Since: 0.5.65
initRepoCache :: MonadIO m => SystemPath -> m RepoCache Source #
Initialize the local repository cache directory.
remoteRepoCheckSshPrivKey :: MonadIO m => RemoteRepo -> m RemoteRepo Source #
Check for existance of priv-key and make it an absolute path.
initRemoteRepo :: MonadIO m => RepoCache -> RemoteRepo -> m RemoteRepo Source #
Initialize the repository; load the corresponding settings from the config file, check that the priv key exists and create the correspondig cache directory.
cleanRemoteRepo :: MonadIO m => RepoCache -> RemoteRepo -> m () Source #
Empty the repository; load the corresponding settings from the config file, check that the priv key exists and create the correspondig cache directory.
Arguments
| :: RepoCache | The repository cache directory |
| -> String | Id of the repository |
| -> FilePath | The existing, absolute path to the cache directory |
Return the cache directory for a remote repository relative to the root cache dir.
Arguments
| :: RepoCache | The repository cache directory |
| -> FilePath | The existing, absolute path to the directory |
Return the local repository directory.
lookupRemoteRepo :: [RemoteRepo] -> String -> Maybe RemoteRepo Source #
Select the first RemoteRepo with a given repoId.
type CommandIO e = (MonadBaseControl IO (Eff e), MonadIO (Eff e), Member LoggerReader e, Member B9ConfigReader e) Source #
Convenience type alias for Effects that have a B9Config, a Logger, MonadIO and MonadBaseControl.
Since: 0.5.65
The logger to write log messages to.
Since: 0.5.65
Constructors
| MkLogger | |
Fields | |
withLogger :: (MonadBaseControl IO (Eff e), MonadIO (Eff e), Member B9ConfigReader e) => Eff (LoggerReader ': e) a -> Eff e a Source #
Lookup the selected getLogVerbosity and _logFile from the B9Config
and open it.
Then run the given action; if the action crashes, the log file will be closed.
Since: 0.5.65
type BuildInfoReader = Reader BuildInfo Source #
Type alias for a BuildInfo Reader
Since: 0.5.65
withBuildInfo :: (Lifted IO e, MonadBaseControl IO (Eff e), Member B9ConfigReader e, Member ExcB9 e, Member EnvironmentReader e, Member LoggerReader e, HasCallStack) => Eff (BuildInfoReader ': e) a -> Eff e a Source #
Create the build directories, generate (hash) the build-id and execute the given action.
Bindings added to the text template parameter environment:
projectRootthe directory that contains the sources of the project to buildbuildDirthe temporary directory used store the build artifacts passed into- or outof the build
Unless _keepTempDirs is True clean up the build directories after the actions
returns - even if the action throws a runtime exception.
Since: 0.5.65
getBuildId :: Member BuildInfoReader e => Eff e String Source #
getBuildDate :: Member BuildInfoReader e => Eff e String Source #
getBuildDir :: Member BuildInfoReader e => Eff e FilePath Source #
type IsB9 e = (HasCallStack, Lifted IO e, CommandIO e, B9Eff <:: e) Source #
A constraint that contains all effects of B9Eff
Since: 0.5.65
type B9Eff = '[SelectedRemoteRepoReader, RepoCacheReader, BuildInfoReader, LoggerReader, B9ConfigReader, EnvironmentReader, ExcB9, Lift IO] Source #
Definition of the B9 effect list. It encapsulates logging, a reader for the B9.B9Config and access to the current build id, the current build directory and the artifact to build.
This monad is used by the _effectful_ functions in this library.
Since: 0.5.65
type B9 a = Eff B9Eff a Source #
Definition of the B9 monad. See B9Eff.
This module is used by the _effectful_ functions in this library.
Since: 0.5.65
runB9 :: HasCallStack => B9 a -> B9ConfigAction a Source #
class ToContentGenerator c where Source #
Types whose values can be turned into an Effect that produces
Text, e.g. ContentGenerator
Since: 0.5.62
Methods
toContentGenerator :: (HasCallStack, IsB9 e) => c -> Eff e Text Source #
Instances
| ToContentGenerator Content Source # | |
Defined in B9.Artifact.Content.Readable Methods toContentGenerator :: (HasCallStack, IsB9 e) => Content -> Eff e Text Source # | |
cmd :: CommandIO e => String -> Eff e () Source #
Execute the given shell command.
If isInteractive is true, the standard-in will be passed to the external command,
and all output of the program will be directed to standard-out.
The command and the output is either logged to the logfile with traceL or errorL or
written to stdout.
If the command exists with non-zero exit code, the current process exists with the same exit code.
Since: 0.5.65
newtype FilePathGlob Source #
Express a pattern for file paths, used when searching repositories.
Constructors
| FileExtension String |
data Repository Source #
Instances
| Eq Repository Source # | |
Defined in B9.RepositoryIO | |
| Ord Repository Source # | |
Defined in B9.RepositoryIO Methods compare :: Repository -> Repository -> Ordering # (<) :: Repository -> Repository -> Bool # (<=) :: Repository -> Repository -> Bool # (>) :: Repository -> Repository -> Bool # (>=) :: Repository -> Repository -> Bool # max :: Repository -> Repository -> Repository # min :: Repository -> Repository -> Repository # | |
| Read Repository Source # | |
Defined in B9.RepositoryIO Methods readsPrec :: Int -> ReadS Repository # readList :: ReadS [Repository] # readPrec :: ReadPrec Repository # readListPrec :: ReadPrec [Repository] # | |
| Show Repository Source # | |
Defined in B9.RepositoryIO Methods showsPrec :: Int -> Repository -> ShowS # show :: Repository -> String # showList :: [Repository] -> ShowS # | |
toRemoteRepository :: RemoteRepo -> Repository Source #
Convert a RemoteRepo down to a mere Repository
repoSearch :: forall e. (CommandIO e, Member RepoCacheReader e) => FilePath -> FilePathGlob -> Eff e [(Repository, [FilePath])] Source #
Find files which are in subDir and match glob in the repository
cache. NOTE: This operates on the repository cache, but does not enforce a
repository cache update.
pushToRepo :: CommandIO e => RemoteRepo -> FilePath -> FilePath -> Eff e () Source #
Push a file from the cache to a remote repository
pullFromRepo :: CommandIO e => RemoteRepo -> FilePath -> FilePath -> Eff e () Source #
Pull a file from a remote repository to cache
pullGlob :: (CommandIO e, Member RepoCacheReader e) => FilePath -> FilePathGlob -> RemoteRepo -> Eff e () Source #
Push a file from the cache to a remote repository
data SourceFileConversion Source #
Constructors
| NoConversion | |
| ExpandVariables |
Instances
data SourceFile Source #
A wrapper around a file path and a flag indicating if template variable expansion should be performed when reading the file contents.
Constructors
| Source SourceFileConversion FilePath |
Instances
readTemplateFile :: (MonadIO (Eff e), '[ExcB9, EnvironmentReader] <:: e) => SourceFile -> Eff e Text Source #
subst :: (Member ExcB9 e, Member EnvironmentReader e) => Text -> Eff e Text Source #
Text template substitution.
substStr :: (Member ExcB9 e, Member EnvironmentReader e) => String -> Eff e String Source #
String template substitution
substFile :: (Member EnvironmentReader e, Member ExcB9 e, MonadIO (Eff e)) => FilePath -> FilePath -> Eff e () Source #
substPath :: (Member EnvironmentReader e, Member ExcB9 e) => SystemPath -> Eff e SystemPath Source #
withSubstitutedStringBindings :: (Member EnvironmentReader e, Member ExcB9 e) => [(String, String)] -> Eff e s -> Eff e s Source #
Extend an Environment with new bindings, where each value may contain
string templates with like "Hello $name, how is life on $planet these days?".
Since: 0.5.64
Describe a virtual machine, i.e. a set up disk images to create and a shell script to put things together.
Constructors
| VmScript CPUArch [SharedDirectory] Script | |
| NoVmScript |
Instances
substVmScript :: forall e. (Member EnvironmentReader e, Member ExcB9 e) => VmScript -> Eff e VmScript Source #
substImageTarget :: forall e. (HasCallStack, Member EnvironmentReader e, Member ExcB9 e) => ImageTarget -> Eff e ImageTarget Source #
Replace $... variables inside an ImageTarget
resolveImageSource :: IsB9 e => ImageSource -> Eff e Image Source #
Resolve an ImageSource to an Image. The ImageSource might
not exist, as is the case for EmptyImage.
preferredDestImageTypes :: IsB9 e => ImageSource -> Eff e [ImageType] Source #
Return all valid image types sorted by preference.
preferredSourceImageTypes :: HasCallStack => ImageDestination -> [ImageType] Source #
Return all supported source ImageTypes compatible to a ImageDestinaion
in the preferred order.
ensureAbsoluteImageDirExists :: IsB9 e => Image -> Eff e Image Source #
Create the parent directories for the file that contains the Image.
If the path to the image file is relative, prepend _projectRoot from
the B9Config.
materializeImageSource :: IsB9 e => ImageSource -> Image -> Eff e () Source #
Create an image from an image source. The destination image must have a compatible image type and filesystem. The directory of the image MUST be present and the image file itself MUST NOT alredy exist.
createDestinationImage :: IsB9 e => Image -> ImageDestination -> Eff e () Source #
Convert some Image, e.g. a temporary image used during the build phase
to the final destination.
resizeImage :: IsB9 e => ImageResize -> Image -> Eff e () Source #
Resize an image, including the file system inside the image.
importImage :: IsB9 e => Image -> Image -> Eff e () Source #
Import a disk image from some external source into the build directory if necessary convert the image.
exportImage :: IsB9 e => Image -> Image -> Eff e () Source #
Export a disk image from the build directory; if necessary convert the image.
exportAndRemoveImage :: IsB9 e => Image -> Image -> Eff e () Source #
Export a disk image from the build directory; if necessary convert the image.
convertImage :: IsB9 e => Image -> Image -> Eff e () Source #
Convert an image in the build directory to another format and return the new image.
shareImage :: IsB9 e => Image -> SharedImageName -> Eff e SharedImage Source #
Publish an sharedImage made from an image and image meta data to the configured repository
pushSharedImageLatestVersion :: IsB9 e => SharedImageName -> Eff e () Source #
Publish the latest version of a shared image identified by name to the selected repository from the cache.
pullRemoteRepos :: IsB9 e => Eff e () Source #
Pull metadata files from all remote repositories.
pullLatestImage :: IsB9 e => SharedImageName -> Eff e (Maybe SharedImageBuildId) Source #
Pull the latest version of an image, either from the selected remote repo or from the repo that has the latest version.
getSharedImages :: IsB9 e => Eff e [(Repository, [SharedImage])] Source #
Return a list of all existing sharedImages from cached repositories.
lookupSharedImages :: IsB9 e => (Repository -> Bool) -> (SharedImage -> Bool) -> Eff e [(Repository, SharedImage)] Source #
Find shared images and the associated repos from two predicates. The result
is the concatenated result of the sorted shared images satisfying imgPred.
getSelectedRepos :: IsB9 e => Eff e [RemoteRepo] Source #
Return either all remote repos or just the single selected repo.
getSharedImagesCacheDir :: IsB9 e => Eff e FilePath Source #
Return the path to the sub directory in the cache that contains files of shared images.
class FromAST a where Source #
Types of values that describe content, that can be created from an AST.
Instances
| FromAST YamlObject Source # | |
Defined in B9.Artifact.Content.YamlObject Methods fromAST :: (IsB9 e, ToContentGenerator c) => AST c YamlObject -> Eff e YamlObject Source # | |
| FromAST ErlangPropList Source # | |
Defined in B9.Artifact.Content.ErlangPropList Methods fromAST :: (IsB9 e, ToContentGenerator c) => AST c ErlangPropList -> Eff e ErlangPropList Source # | |
| FromAST CloudConfigYaml Source # | |
Defined in B9.Artifact.Content.CloudConfigYaml Methods fromAST :: (IsB9 e, ToContentGenerator c) => AST c CloudConfigYaml -> Eff e CloudConfigYaml Source # | |
Describe how to create structured content that has a tree-like syntactic
structure, e.g. yaml, JSON and erlang-proplists. The first parameter defines
a context into which the AST is embedded,
e.g. B9.Artifact.Content'. The second parameter defines a specifix
syntax, e.g ErlangPropList that the AST value generates.
Constructors
| ASTObj [(String, AST c a)] | Create an object similar to a Json object. |
| ASTArr [AST c a] | An array. |
| ASTMerge [AST c a] | Merge the nested elements, this is a very powerful tool that allows to combine |
| ASTEmbed c | |
| ASTString String | |
| ASTInt Int | |
| ASTParse SourceFile | |
| AST a |
Instances
newtype YamlObject Source #
A wrapper type around yaml values with a Semigroup instance useful for combining yaml documents describing system configuration like e.g. user-data.
Constructors
| YamlObject | |
Fields | |
Instances
newtype ErlangPropList Source #
A wrapper type around erlang terms with a Semigroup instance useful for combining sys.config files with OTP-application configurations in a list of the form of a proplist.
Constructors
| ErlangPropList SimpleErlangTerm |
Instances
textToErlangAst :: Text -> AST c ErlangPropList Source #
Parse a text containing an Erlang expression ending with a . and Return
an AST.
Since: 0.5.67
stringToErlangAst :: String -> AST c ErlangPropList Source #
Parse a string containing an Erlang expression ending with a . and Return
an AST.
Since: 0.5.67
newtype CloudConfigYaml Source #
Cloud-init meta-data configuration Yaml.
cloud-config yaml documents contain:
#cloud-config as first line.
@Since 0.5.62
Constructors
| MkCloudConfigYaml | |
Fields | |
Instances
cloudConfigFileHeader :: Text Source #
The header line, which must be the first line in the text file containing the cloud-config Yaml document.
@Since 0.5.62
type ErlangAst = AST Content ErlangPropList Source #
An ErlangPropList AST with Content
Since: 0.5.67
Constructors
| RenderErlang (AST Content ErlangPropList) | |
| RenderYamlObject (AST Content YamlObject) | |
| RenderCloudConfig (AST Content CloudConfigYaml) | |
| FromByteString ByteString | This data will be passed through unaltered.
This is used during the transition phase from having B9 stuff read from
files via Since: 0.5.62 |
| FromString String | Embed a literal string |
| FromTextFile SourceFile | Embed the contents of the |
| RenderBase64BinaryFile FilePath | The data in the given file will be base64 encoded. |
| RenderBase64Binary ByteString | This data will be base64 encoded. |
| FromURL String | Download the contents of the URL |
Instances
data ArtifactSource Source #
Describe how input files for artifacts to build are obtained. The general structure of each constructor is FromXXX destination source
Constructors
| FromFile FilePath SourceFile | Copy a |
| FromContent FilePath Content | Create a file from some |
| SetPermissions Int Int Int [ArtifactSource] | Set the unix file permissions to all files generated
by the nested list of |
| FromDirectory FilePath [ArtifactSource] | Assume a local directory as starting point for all
relative source files in the nested |
| IntoDirectory FilePath [ArtifactSource] | Specify an output directory for all the files
generated by the nested |
Instances
getArtifactSourceFiles :: ArtifactSource -> [FilePath] Source #
Return all source files generated by an ArtifactSource.
data AssemblyOutput Source #
The output of an ArtifactAssembly is either a set of generated files,
or it might be a directory that contains the artifacts sources.
Instances
data CloudInitType Source #
Instances
data ArtifactTarget Source #
Constructors
| CloudInitTarget CloudInitType FilePath | |
| VmImagesTarget |
Instances
data AssembledArtifact Source #
A symbolic representation of the targets assembled by
assemble from an ArtifactAssembly. There is a
list of ArtifactTargets because e.g. a single CloudInit can produce up to
three output files, a directory, an ISO image and a VFAT image.
Constructors
| AssembledArtifact InstanceId [ArtifactTarget] |
Instances
data ArtifactAssembly Source #
Define an output of a build. Assemblies are nested into
ArtifactGenerators. They contain all the files defined by the Sources
they are nested into.
Constructors
| CloudInit [CloudInitType] FilePath | Generate a cloud-init compatible directory, ISO-
or VFAT image, as specified by the list of
|
| VmImages [ImageTarget] VmScript | a set of VM-images that were created by executing a build script on them. |
Instances
newtype InstanceId Source #
Identify an artifact. Deprecated TODO: B9 does not check if all instances IDs are unique.
Instances
data ArtifactGenerator Source #
Artifacts represent the things B9 can build. A generator specifies howto generate parameterized, multiple artifacts. The general structure is:
Let [ ... bindings ... ]
[ Sources
[ ... list all input files ... ]
[ Artifact ...
, Artifact ...
, Let [ ... ] [ ... ]
]
]
The reasons why Sources takes a list of ArtifactGenerators is that
- this makes the value easier to read/write for humans
- the sources are static files used in all children (e.g. company logo image)
- the sources are parameterized by variables that bound to different values for each artifact, e.g. a template network config file which contains the host IP address.
To bind such variables use Let, Each, LetX or EachT.
String substitution of these variables is done by B9.Artifact.Content.StringTemplate.
These variables can be used as value in nested Lets, in most file names/paths
and in source files added with SourceFile
- - @deprecated TODO remove this when switching to Dhall
Constructors
| Sources [ArtifactSource] [ArtifactGenerator] | Add sources available to |
| Let [(String, String)] [ArtifactGenerator] | Bind variables, variables are available in nested generators. @deprecated TODO remove this when switching to Dhall |
| LetX [(String, [String])] [ArtifactGenerator] | A LetX [("x", ["1","2","3"]), ("y", ["a","b"])] [..]
Is equal to: Let [] [
Let [("x", "1"), ("y", "a")] [..]
Let [("x", "1"), ("y", "b")] [..]
Let [("x", "2"), ("y", "a")] [..]
Let [("x", "2"), ("y", "b")] [..]
Let [("x", "3"), ("y", "a")] [..]
Let [("x", "3"), ("y", "b")] [..]
]
@deprecated TODO remove this when switching to Dhall |
| Each [(String, [String])] [ArtifactGenerator] | Bind each variable to their first value, then each
variable to the second value, etc ... and execute the
nested generator in every step. |
| EachT [String] [[String]] [ArtifactGenerator] | The transposed version of |
| Artifact InstanceId ArtifactAssembly | Generate an artifact defined by an
|
| EmptyArtifact |
Instances
instanceIdKey :: String Source #
The variable containing the instance id. Deprecated
buildIdKey :: String Source #
The variable containing the buildId that identifies each execution of
B9. For more info about variable substitution in source files see
StringTemplate
buildDateKey :: String Source #
The variable containing the date and time a build was started. For more
info about variable substitution in source files see
StringTemplate
getAssemblyOutput :: ArtifactAssembly -> [AssemblyOutput] Source #
Return the files that the artifact assembly consist of.
buildWithVm :: IsB9 e => InstanceId -> [ImageTarget] -> FilePath -> VmScript -> Eff e Bool Source #
data InstanceGenerator e Source #
Constructors
| IG InstanceId e ArtifactAssembly |
Instances
data InstanceSources Source #
Internal data structure. Only exposed for unit testing.
Constructors
| InstanceSources | |
Fields
| |
Instances
| Eq InstanceSources Source # | |
Defined in B9.Artifact.Readable.Interpreter Methods (==) :: InstanceSources -> InstanceSources -> Bool # (/=) :: InstanceSources -> InstanceSources -> Bool # | |
| Show InstanceSources Source # | |
Defined in B9.Artifact.Readable.Interpreter Methods showsPrec :: Int -> InstanceSources -> ShowS # show :: InstanceSources -> String # showList :: [InstanceSources] -> ShowS # | |
buildArtifacts :: ArtifactGenerator -> B9 String Source #
Execute an ArtifactGenerator and return a B9Invocation that returns
the build id obtained by getBuildId.
getArtifactOutputFiles :: ArtifactGenerator -> Either SomeException [FilePath] Source #
Return a list of relative paths for the local files to be generated
by the ArtifactGenerator. This excludes Shared and Transient image targets.
assemble :: ArtifactGenerator -> B9 [AssembledArtifact] Source #
Run an artifact generator to produce the artifacts.
runArtifactGenerator :: Environment -> String -> String -> ArtifactGenerator -> Either SomeException [InstanceGenerator [TextFileWriter]] Source #
Interpret an ArtifactGenerator into a list of simple commands, i.e. InstanceGenerators
Since: 0.5.65
runInstanceGenerator :: IsB9 e => InstanceGenerator FilePath -> Eff e AssembledArtifact Source #
Run an
runArtifactAssembly :: IsB9 e => InstanceId -> FilePath -> ArtifactAssembly -> Eff e [ArtifactTarget] Source #
Create the ArtifactTarget from an ArtifactAssembly in the directory instanceDir
Since: 0.5.65