Propellor.Types.Core

Documentation

data Host

Everything Propellor knows about a system: Its hostname, properties and their collected info.

Constructors

Host

Fields

• hostName :: HostName
• hostProperties :: [ChildProperty]
• hostInfo :: Info

Instances

Show Host

Methods

showsPrec :: Int -> Host -> ShowS

show :: Host -> String

showList :: [Host] -> ShowS

IsContainer Host

Methods

containerProperties :: Host -> [ChildProperty]

containerInfo :: Host -> Info

setContainerProperties :: Host -> [ChildProperty] -> Host

Conductable Host

Methods

conducts :: Host -> RevertableProperty ((* + HasInfo) UnixLike) ((* + HasInfo) UnixLike)

MonadReader Host Propellor

Methods

ask :: Propellor Host

local :: (Host -> Host) -> Propellor a -> Propellor a

reader :: (Host -> a) -> Propellor a

Conductable [Host]

Methods

conducts :: [Host] -> RevertableProperty ((* + HasInfo) UnixLike) ((* + HasInfo) UnixLike)

newtype Propellor p

Propellor's monad provides read-only access to info about the host it's running on, and a writer to accumulate EndActions.

Constructors

Propellor

Fields

• runWithHost :: RWST Host [EndAction] () IO p

Instances

Monad Propellor

Methods

(>>=) :: Propellor a -> (a -> Propellor b) -> Propellor b

(>>) :: Propellor a -> Propellor b -> Propellor b

return :: a -> Propellor a

fail :: String -> Propellor a

Functor Propellor

Methods

fmap :: (a -> b) -> Propellor a -> Propellor b

(<$) :: a -> Propellor b -> Propellor a

Applicative Propellor

Methods

pure :: a -> Propellor a

(<*>) :: Propellor (a -> b) -> Propellor a -> Propellor b

(*>) :: Propellor a -> Propellor b -> Propellor b

(<*) :: Propellor a -> Propellor b -> Propellor a

MonadIO Propellor

Methods

liftIO :: IO a -> Propellor a

MonadThrow Propellor

Methods

throwM :: Exception e => e -> Propellor a

MonadCatch Propellor

Methods

catch :: Exception e => Propellor a -> (e -> Propellor a) -> Propellor a

MonadMask Propellor

Methods

mask :: ((forall a. Propellor a -> Propellor a) -> Propellor b) -> Propellor b

uninterruptibleMask :: ((forall a. Propellor a -> Propellor a) -> Propellor b) -> Propellor b

LiftPropellor Propellor

Methods

liftPropellor :: Propellor a -> Propellor a

MonadReader Host Propellor

Methods

ask :: Propellor Host

local :: (Host -> Host) -> Propellor a -> Propellor a

reader :: (Host -> a) -> Propellor a

Monoid (Propellor Result)

When two actions are appended together, the second action is only run if the first action does not fail.

Methods

mempty :: Propellor Result

mappend :: Propellor Result -> Propellor Result -> Propellor Result

mconcat :: [Propellor Result] -> Propellor Result

MonadWriter [EndAction] Propellor

Methods

writer :: (a, [EndAction]) -> Propellor a

tell :: [EndAction] -> Propellor ()

listen :: Propellor a -> Propellor (a, [EndAction])

pass :: Propellor (a, [EndAction] -> [EndAction]) -> Propellor a

class LiftPropellor m where

Minimal complete definition

liftPropellor

Methods

liftPropellor :: m a -> Propellor a

Instances

LiftPropellor IO

Methods

liftPropellor :: IO a -> Propellor a

LiftPropellor Propellor

Methods

liftPropellor :: Propellor a -> Propellor a

data EndAction

An action that Propellor runs at the end, after trying to satisfy all properties. It's passed the combined Result of the entire Propellor run.

Constructors

EndAction Desc (Result -> Propellor Result)

Instances

MonadWriter [EndAction] Propellor

Methods

writer :: (a, [EndAction]) -> Propellor a

tell :: [EndAction] -> Propellor ()

listen :: Propellor a -> Propellor (a, [EndAction])

pass :: Propellor (a, [EndAction] -> [EndAction]) -> Propellor a

type Desc = String

data Props metatypes

Props is a combination of a list of properties, with their combined metatypes.

Constructors

Props [ChildProperty]

data ChildProperty

Since there are many different types of Properties, they cannot be put into a list. The simplified ChildProperty can be put into a list.

Constructors

ChildProperty Desc (Maybe (Propellor Result)) Info [ChildProperty]

Instances

Show ChildProperty

Methods

showsPrec :: Int -> ChildProperty -> ShowS

show :: ChildProperty -> String

showList :: [ChildProperty] -> ShowS

IsProp ChildProperty

Methods

setDesc :: ChildProperty -> Desc -> ChildProperty

getDesc :: ChildProperty -> Desc

getChildren :: ChildProperty -> [ChildProperty]

addChildren :: ChildProperty -> [ChildProperty] -> ChildProperty

getInfoRecursive :: ChildProperty -> Info

getInfo :: ChildProperty -> Info

toChildProperty :: ChildProperty -> ChildProperty

getSatisfy :: ChildProperty -> Maybe (Propellor Result)

class IsProp p where

Minimal complete definition

setDesc, getDesc, getChildren, addChildren, getInfoRecursive, getInfo, toChildProperty, getSatisfy

Methods

setDesc :: p -> Desc -> p

getDesc :: p -> Desc

getChildren :: p -> [ChildProperty]

addChildren :: p -> [ChildProperty] -> p

getInfoRecursive :: p -> Info

Gets the info of the property, combined with all info of all children properties.

getInfo :: p -> Info

Info, not including info from children.

toChildProperty :: p -> ChildProperty

Gets a ChildProperty representing the Property. You should not normally need to use this.

getSatisfy :: p -> Maybe (Propellor Result)

Gets the action that can be run to satisfy a Property. You should never run this action directly. Use ensureProperty instead.

Instances

IsProp ChildProperty

Methods

setDesc :: ChildProperty -> Desc -> ChildProperty

getDesc :: ChildProperty -> Desc

getChildren :: ChildProperty -> [ChildProperty]

addChildren :: ChildProperty -> [ChildProperty] -> ChildProperty

getInfoRecursive :: ChildProperty -> Info

getInfo :: ChildProperty -> Info

toChildProperty :: ChildProperty -> ChildProperty

getSatisfy :: ChildProperty -> Maybe (Propellor Result)

IsProp (Property metatypes)

Methods

setDesc :: Property metatypes -> Desc -> Property metatypes

getDesc :: Property metatypes -> Desc

getChildren :: Property metatypes -> [ChildProperty]

addChildren :: Property metatypes -> [ChildProperty] -> Property metatypes

getInfoRecursive :: Property metatypes -> Info

getInfo :: Property metatypes -> Info

toChildProperty :: Property metatypes -> ChildProperty

getSatisfy :: Property metatypes -> Maybe (Propellor Result)

IsProp (RevertableProperty setupmetatypes undometatypes)

Methods

setDesc :: RevertableProperty setupmetatypes undometatypes -> Desc -> RevertableProperty setupmetatypes undometatypes

getDesc :: RevertableProperty setupmetatypes undometatypes -> Desc

getChildren :: RevertableProperty setupmetatypes undometatypes -> [ChildProperty]

addChildren :: RevertableProperty setupmetatypes undometatypes -> [ChildProperty] -> RevertableProperty setupmetatypes undometatypes

getInfoRecursive :: RevertableProperty setupmetatypes undometatypes -> Info

getInfo :: RevertableProperty setupmetatypes undometatypes -> Info

toChildProperty :: RevertableProperty setupmetatypes undometatypes -> ChildProperty

getSatisfy :: RevertableProperty setupmetatypes undometatypes -> Maybe (Propellor Result)