Safe Haskell	None
Language	Haskell2010

Language.Docker.Syntax

Synopsis

Documentation

data Image Source #

Constructors

Image
Fields registryName :: !(Maybe Registry) imageName :: !Text

Instances

Eq Image Source #
Methods (==) :: Image -> Image -> Bool # (/=) :: Image -> Image -> Bool #
Ord Image Source #
Methods compare :: Image -> Image -> Ordering # (<) :: Image -> Image -> Bool # (<=) :: Image -> Image -> Bool # (>) :: Image -> Image -> Bool # (>=) :: Image -> Image -> Bool # max :: Image -> Image -> Image # min :: Image -> Image -> Image #
Show Image Source #
Methods showsPrec :: Int -> Image -> ShowS # show :: Image -> String # showList :: [Image] -> ShowS #
IsString Image Source #
Methods fromString :: String -> Image #

newtype Registry Source #

Constructors

Registry
Fields unRegistry :: Text

Instances

Eq Registry Source #
Methods (==) :: Registry -> Registry -> Bool # (/=) :: Registry -> Registry -> Bool #
Ord Registry Source #
Methods compare :: Registry -> Registry -> Ordering # (<) :: Registry -> Registry -> Bool # (<=) :: Registry -> Registry -> Bool # (>) :: Registry -> Registry -> Bool # (>=) :: Registry -> Registry -> Bool # max :: Registry -> Registry -> Registry # min :: Registry -> Registry -> Registry #
Show Registry Source #
Methods showsPrec :: Int -> Registry -> ShowS # show :: Registry -> String # showList :: [Registry] -> ShowS #
IsString Registry Source #
Methods fromString :: String -> Registry #

newtype Tag Source #

Constructors

Tag
Fields unTag :: Text

Instances

Eq Tag Source #
Methods (==) :: Tag -> Tag -> Bool # (/=) :: Tag -> Tag -> Bool #
Ord Tag Source #
Methods compare :: Tag -> Tag -> Ordering # (<) :: Tag -> Tag -> Bool # (<=) :: Tag -> Tag -> Bool # (>) :: Tag -> Tag -> Bool # (>=) :: Tag -> Tag -> Bool # max :: Tag -> Tag -> Tag # min :: Tag -> Tag -> Tag #
Show Tag Source #
Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
IsString Tag Source #
Methods fromString :: String -> Tag #

data Protocol Source #

Constructors

TCP
UDP

Instances

Eq Protocol Source #
Methods (==) :: Protocol -> Protocol -> Bool # (/=) :: Protocol -> Protocol -> Bool #
Ord Protocol Source #
Methods compare :: Protocol -> Protocol -> Ordering # (<) :: Protocol -> Protocol -> Bool # (<=) :: Protocol -> Protocol -> Bool # (>) :: Protocol -> Protocol -> Bool # (>=) :: Protocol -> Protocol -> Bool # max :: Protocol -> Protocol -> Protocol # min :: Protocol -> Protocol -> Protocol #
Show Protocol Source #
Methods showsPrec :: Int -> Protocol -> ShowS # show :: Protocol -> String # showList :: [Protocol] -> ShowS #

data Port Source #

Constructors

Port !Int !Protocol
PortStr !Text
PortRange !Int !Int !Protocol

Instances

Eq Port Source #
Methods (==) :: Port -> Port -> Bool # (/=) :: Port -> Port -> Bool #
Ord Port Source #
Methods compare :: Port -> Port -> Ordering # (<) :: Port -> Port -> Bool # (<=) :: Port -> Port -> Bool # (>) :: Port -> Port -> Bool # (>=) :: Port -> Port -> Bool # max :: Port -> Port -> Port # min :: Port -> Port -> Port #
Show Port Source #
Methods showsPrec :: Int -> Port -> ShowS # show :: Port -> String # showList :: [Port] -> ShowS #

newtype Ports Source #

Constructors

Ports
Fields unPorts :: [Port]

Instances

IsList Ports Source #
Associated Types type Item Ports :: * # Methods fromList :: [Item Ports] -> Ports # fromListN :: Int -> [Item Ports] -> Ports # toList :: Ports -> [Item Ports] #
Eq Ports Source #
Methods (==) :: Ports -> Ports -> Bool # (/=) :: Ports -> Ports -> Bool #
Ord Ports Source #
Methods compare :: Ports -> Ports -> Ordering # (<) :: Ports -> Ports -> Bool # (<=) :: Ports -> Ports -> Bool # (>) :: Ports -> Ports -> Bool # (>=) :: Ports -> Ports -> Bool # max :: Ports -> Ports -> Ports # min :: Ports -> Ports -> Ports #
Show Ports Source #
Methods showsPrec :: Int -> Ports -> ShowS # show :: Ports -> String # showList :: [Ports] -> ShowS #
type Item Ports Source #
type Item Ports = Port

type Directory = Text Source #

newtype ImageAlias Source #

Constructors

ImageAlias
Fields unImageAlias :: Text

Instances

Eq ImageAlias Source #
Methods (==) :: ImageAlias -> ImageAlias -> Bool # (/=) :: ImageAlias -> ImageAlias -> Bool #
Ord ImageAlias Source #
Methods compare :: ImageAlias -> ImageAlias -> Ordering # (<) :: ImageAlias -> ImageAlias -> Bool # (<=) :: ImageAlias -> ImageAlias -> Bool # (>) :: ImageAlias -> ImageAlias -> Bool # (>=) :: ImageAlias -> ImageAlias -> Bool # max :: ImageAlias -> ImageAlias -> ImageAlias # min :: ImageAlias -> ImageAlias -> ImageAlias #
Show ImageAlias Source #
Methods showsPrec :: Int -> ImageAlias -> ShowS # show :: ImageAlias -> String # showList :: [ImageAlias] -> ShowS #
IsString ImageAlias Source #
Methods fromString :: String -> ImageAlias #

data BaseImage Source #

Constructors

UntaggedImage !Image !(Maybe ImageAlias)
TaggedImage !Image !Tag !(Maybe ImageAlias)
DigestedImage !Image !Text !(Maybe ImageAlias)

Instances

Eq BaseImage Source #
Methods (==) :: BaseImage -> BaseImage -> Bool # (/=) :: BaseImage -> BaseImage -> Bool #
Ord BaseImage Source #
Methods compare :: BaseImage -> BaseImage -> Ordering # (<) :: BaseImage -> BaseImage -> Bool # (<=) :: BaseImage -> BaseImage -> Bool # (>) :: BaseImage -> BaseImage -> Bool # (>=) :: BaseImage -> BaseImage -> Bool # max :: BaseImage -> BaseImage -> BaseImage # min :: BaseImage -> BaseImage -> BaseImage #
Show BaseImage Source #
Methods showsPrec :: Int -> BaseImage -> ShowS # show :: BaseImage -> String # showList :: [BaseImage] -> ShowS #

type Dockerfile = [InstructionPos Text] Source #

Type of the Dockerfile AST

newtype SourcePath Source #

Constructors

SourcePath
Fields unSourcePath :: Text

Instances

Eq SourcePath Source #
Methods (==) :: SourcePath -> SourcePath -> Bool # (/=) :: SourcePath -> SourcePath -> Bool #
Ord SourcePath Source #
Methods compare :: SourcePath -> SourcePath -> Ordering # (<) :: SourcePath -> SourcePath -> Bool # (<=) :: SourcePath -> SourcePath -> Bool # (>) :: SourcePath -> SourcePath -> Bool # (>=) :: SourcePath -> SourcePath -> Bool # max :: SourcePath -> SourcePath -> SourcePath # min :: SourcePath -> SourcePath -> SourcePath #
Show SourcePath Source #
Methods showsPrec :: Int -> SourcePath -> ShowS # show :: SourcePath -> String # showList :: [SourcePath] -> ShowS #
IsString SourcePath Source #
Methods fromString :: String -> SourcePath #

newtype TargetPath Source #

Constructors

TargetPath
Fields unTargetPath :: Text

Instances

Eq TargetPath Source #
Methods (==) :: TargetPath -> TargetPath -> Bool # (/=) :: TargetPath -> TargetPath -> Bool #
Ord TargetPath Source #
Methods compare :: TargetPath -> TargetPath -> Ordering # (<) :: TargetPath -> TargetPath -> Bool # (<=) :: TargetPath -> TargetPath -> Bool # (>) :: TargetPath -> TargetPath -> Bool # (>=) :: TargetPath -> TargetPath -> Bool # max :: TargetPath -> TargetPath -> TargetPath # min :: TargetPath -> TargetPath -> TargetPath #
Show TargetPath Source #
Methods showsPrec :: Int -> TargetPath -> ShowS # show :: TargetPath -> String # showList :: [TargetPath] -> ShowS #
IsString TargetPath Source #
Methods fromString :: String -> TargetPath #

data Chown Source #

Constructors

Chown !Text
NoChown

Instances

Eq Chown Source #
Methods (==) :: Chown -> Chown -> Bool # (/=) :: Chown -> Chown -> Bool #
Ord Chown Source #
Methods compare :: Chown -> Chown -> Ordering # (<) :: Chown -> Chown -> Bool # (<=) :: Chown -> Chown -> Bool # (>) :: Chown -> Chown -> Bool # (>=) :: Chown -> Chown -> Bool # max :: Chown -> Chown -> Chown # min :: Chown -> Chown -> Chown #
Show Chown Source #
Methods showsPrec :: Int -> Chown -> ShowS # show :: Chown -> String # showList :: [Chown] -> ShowS #
IsString Chown Source #
Methods fromString :: String -> Chown #

data CopySource Source #

Constructors

CopySource !Text
NoSource

Instances

Eq CopySource Source #
Methods (==) :: CopySource -> CopySource -> Bool # (/=) :: CopySource -> CopySource -> Bool #
Ord CopySource Source #
Methods compare :: CopySource -> CopySource -> Ordering # (<) :: CopySource -> CopySource -> Bool # (<=) :: CopySource -> CopySource -> Bool # (>) :: CopySource -> CopySource -> Bool # (>=) :: CopySource -> CopySource -> Bool # max :: CopySource -> CopySource -> CopySource # min :: CopySource -> CopySource -> CopySource #
Show CopySource Source #
Methods showsPrec :: Int -> CopySource -> ShowS # show :: CopySource -> String # showList :: [CopySource] -> ShowS #
IsString CopySource Source #
Methods fromString :: String -> CopySource #

newtype Duration Source #

Constructors

Duration
Fields durationTime :: DiffTime

Instances

Eq Duration Source #
Methods (==) :: Duration -> Duration -> Bool # (/=) :: Duration -> Duration -> Bool #
Num Duration Source #
Methods (+) :: Duration -> Duration -> Duration # (-) :: Duration -> Duration -> Duration # (*) :: Duration -> Duration -> Duration # negate :: Duration -> Duration # abs :: Duration -> Duration # signum :: Duration -> Duration # fromInteger :: Integer -> Duration #
Ord Duration Source #
Methods compare :: Duration -> Duration -> Ordering # (<) :: Duration -> Duration -> Bool # (<=) :: Duration -> Duration -> Bool # (>) :: Duration -> Duration -> Bool # (>=) :: Duration -> Duration -> Bool # max :: Duration -> Duration -> Duration # min :: Duration -> Duration -> Duration #
Show Duration Source #
Methods showsPrec :: Int -> Duration -> ShowS # show :: Duration -> String # showList :: [Duration] -> ShowS #

newtype Retries Source #

Constructors

Retries
Fields times :: Int

Instances

Eq Retries Source #
Methods (==) :: Retries -> Retries -> Bool # (/=) :: Retries -> Retries -> Bool #
Num Retries Source #
Methods (+) :: Retries -> Retries -> Retries # (-) :: Retries -> Retries -> Retries # (*) :: Retries -> Retries -> Retries # negate :: Retries -> Retries # abs :: Retries -> Retries # signum :: Retries -> Retries # fromInteger :: Integer -> Retries #
Ord Retries Source #
Methods compare :: Retries -> Retries -> Ordering # (<) :: Retries -> Retries -> Bool # (<=) :: Retries -> Retries -> Bool # (>) :: Retries -> Retries -> Bool # (>=) :: Retries -> Retries -> Bool # max :: Retries -> Retries -> Retries # min :: Retries -> Retries -> Retries #
Show Retries Source #
Methods showsPrec :: Int -> Retries -> ShowS # show :: Retries -> String # showList :: [Retries] -> ShowS #

data CopyArgs Source #

Constructors

CopyArgs
Fields sourcePaths :: NonEmpty SourcePath targetPath :: !TargetPath chownFlag :: !Chown sourceFlag :: !CopySource

Instances

Eq CopyArgs Source #
Methods (==) :: CopyArgs -> CopyArgs -> Bool # (/=) :: CopyArgs -> CopyArgs -> Bool #
Ord CopyArgs Source #
Methods compare :: CopyArgs -> CopyArgs -> Ordering # (<) :: CopyArgs -> CopyArgs -> Bool # (<=) :: CopyArgs -> CopyArgs -> Bool # (>) :: CopyArgs -> CopyArgs -> Bool # (>=) :: CopyArgs -> CopyArgs -> Bool # max :: CopyArgs -> CopyArgs -> CopyArgs # min :: CopyArgs -> CopyArgs -> CopyArgs #
Show CopyArgs Source #
Methods showsPrec :: Int -> CopyArgs -> ShowS # show :: CopyArgs -> String # showList :: [CopyArgs] -> ShowS #

data AddArgs Source #

Constructors

AddArgs
Fields sourcePaths :: NonEmpty SourcePath targetPath :: !TargetPath chownFlag :: !Chown

Instances

Eq AddArgs Source #
Methods (==) :: AddArgs -> AddArgs -> Bool # (/=) :: AddArgs -> AddArgs -> Bool #
Ord AddArgs Source #
Methods compare :: AddArgs -> AddArgs -> Ordering # (<) :: AddArgs -> AddArgs -> Bool # (<=) :: AddArgs -> AddArgs -> Bool # (>) :: AddArgs -> AddArgs -> Bool # (>=) :: AddArgs -> AddArgs -> Bool # max :: AddArgs -> AddArgs -> AddArgs # min :: AddArgs -> AddArgs -> AddArgs #
Show AddArgs Source #
Methods showsPrec :: Int -> AddArgs -> ShowS # show :: AddArgs -> String # showList :: [AddArgs] -> ShowS #

data Check args Source #

Constructors

Check !(CheckArgs args)
NoCheck

Instances

Functor Check Source #
Methods fmap :: (a -> b) -> Check a -> Check b # (<$) :: a -> Check b -> Check a #
Eq args => Eq (Check args) Source #
Methods (==) :: Check args -> Check args -> Bool # (/=) :: Check args -> Check args -> Bool #
Ord args => Ord (Check args) Source #
Methods compare :: Check args -> Check args -> Ordering # (<) :: Check args -> Check args -> Bool # (<=) :: Check args -> Check args -> Bool # (>) :: Check args -> Check args -> Bool # (>=) :: Check args -> Check args -> Bool # max :: Check args -> Check args -> Check args # min :: Check args -> Check args -> Check args #
Show args => Show (Check args) Source #
Methods showsPrec :: Int -> Check args -> ShowS # show :: Check args -> String # showList :: [Check args] -> ShowS #

data Arguments args Source #

Constructors

ArgumentsText args
ArgumentsList args

Instances

Functor Arguments Source #
Methods fmap :: (a -> b) -> Arguments a -> Arguments b # (<$) :: a -> Arguments b -> Arguments a #
IsList (Arguments Text) Source #
Associated Types type Item (Arguments Text) :: * # Methods fromList :: [Item (Arguments Text)] -> Arguments Text # fromListN :: Int -> [Item (Arguments Text)] -> Arguments Text # toList :: Arguments Text -> [Item (Arguments Text)] #
Eq args => Eq (Arguments args) Source #
Methods (==) :: Arguments args -> Arguments args -> Bool # (/=) :: Arguments args -> Arguments args -> Bool #
Ord args => Ord (Arguments args) Source #
Methods compare :: Arguments args -> Arguments args -> Ordering # (<) :: Arguments args -> Arguments args -> Bool # (<=) :: Arguments args -> Arguments args -> Bool # (>) :: Arguments args -> Arguments args -> Bool # (>=) :: Arguments args -> Arguments args -> Bool # max :: Arguments args -> Arguments args -> Arguments args # min :: Arguments args -> Arguments args -> Arguments args #
Show args => Show (Arguments args) Source #
Methods showsPrec :: Int -> Arguments args -> ShowS # show :: Arguments args -> String # showList :: [Arguments args] -> ShowS #
IsString (Arguments Text) Source #
Methods fromString :: String -> Arguments Text #
type Item (Arguments Text) Source #
type Item (Arguments Text) = Text

data CheckArgs args Source #

Constructors

CheckArgs
Fields checkCommand :: !(Arguments args) interval :: !(Maybe Duration) timeout :: !(Maybe Duration) startPeriod :: !(Maybe Duration) retries :: !(Maybe Retries)

Instances

Functor CheckArgs Source #
Methods fmap :: (a -> b) -> CheckArgs a -> CheckArgs b # (<$) :: a -> CheckArgs b -> CheckArgs a #
Eq args => Eq (CheckArgs args) Source #
Methods (==) :: CheckArgs args -> CheckArgs args -> Bool # (/=) :: CheckArgs args -> CheckArgs args -> Bool #
Ord args => Ord (CheckArgs args) Source #
Methods compare :: CheckArgs args -> CheckArgs args -> Ordering # (<) :: CheckArgs args -> CheckArgs args -> Bool # (<=) :: CheckArgs args -> CheckArgs args -> Bool # (>) :: CheckArgs args -> CheckArgs args -> Bool # (>=) :: CheckArgs args -> CheckArgs args -> Bool # max :: CheckArgs args -> CheckArgs args -> CheckArgs args # min :: CheckArgs args -> CheckArgs args -> CheckArgs args #
Show args => Show (CheckArgs args) Source #
Methods showsPrec :: Int -> CheckArgs args -> ShowS # show :: CheckArgs args -> String # showList :: [CheckArgs args] -> ShowS #

type Pairs = [(Text, Text)] Source #

data Instruction args Source #

All commands available in Dockerfiles

Constructors

From !BaseImage
Add !AddArgs
User !Text
Label !Pairs
Stopsignal !Text
Copy !CopyArgs
Run !(Arguments args)
Cmd !(Arguments args)
Shell !(Arguments args)
Workdir !Directory
Expose !Ports
Volume !Text
Entrypoint !(Arguments args)
Maintainer !Text
Env !Pairs
Arg !Text !(Maybe Text)
Healthcheck !(Check args)
Comment !Text
OnBuild !(Instruction args)

Instances

Functor Instruction Source #
Methods fmap :: (a -> b) -> Instruction a -> Instruction b # (<$) :: a -> Instruction b -> Instruction a #
Eq args => Eq (Instruction args) Source #
Methods (==) :: Instruction args -> Instruction args -> Bool # (/=) :: Instruction args -> Instruction args -> Bool #
Ord args => Ord (Instruction args) Source #
Methods compare :: Instruction args -> Instruction args -> Ordering # (<) :: Instruction args -> Instruction args -> Bool # (<=) :: Instruction args -> Instruction args -> Bool # (>) :: Instruction args -> Instruction args -> Bool # (>=) :: Instruction args -> Instruction args -> Bool # max :: Instruction args -> Instruction args -> Instruction args # min :: Instruction args -> Instruction args -> Instruction args #
Show args => Show (Instruction args) Source #
Methods showsPrec :: Int -> Instruction args -> ShowS # show :: Instruction args -> String # showList :: [Instruction args] -> ShowS #

type Filename = Text Source #

type Linenumber = Int Source #

data InstructionPos args Source #

Instruction with additional location information required for creating good check messages

Constructors

InstructionPos
Fields instruction :: !(Instruction args) sourcename :: !Filename lineNumber :: !Linenumber

Instances

Functor InstructionPos Source #
Methods fmap :: (a -> b) -> InstructionPos a -> InstructionPos b # (<$) :: a -> InstructionPos b -> InstructionPos a #
Eq args => Eq (InstructionPos args) Source #
Methods (==) :: InstructionPos args -> InstructionPos args -> Bool # (/=) :: InstructionPos args -> InstructionPos args -> Bool #
Ord args => Ord (InstructionPos args) Source #
Methods compare :: InstructionPos args -> InstructionPos args -> Ordering # (<) :: InstructionPos args -> InstructionPos args -> Bool # (<=) :: InstructionPos args -> InstructionPos args -> Bool # (>) :: InstructionPos args -> InstructionPos args -> Bool # (>=) :: InstructionPos args -> InstructionPos args -> Bool # max :: InstructionPos args -> InstructionPos args -> InstructionPos args # min :: InstructionPos args -> InstructionPos args -> InstructionPos args #
Show args => Show (InstructionPos args) Source #
Methods showsPrec :: Int -> InstructionPos args -> ShowS # show :: InstructionPos args -> String # showList :: [InstructionPos args] -> ShowS #