Hocker.Types

Documentation

type RegistryURI = URIRef Absolute

Docker registry URI.

type Username = Text

Docker registry username.

type Password = Text

Docker registry user password.

type Layer = Text

Docker image layer sha256 hash digest.

type StrippedDigest = Text

SHA256 hash digest with the hash algorithm identifier prefix, stripped

type Manifest = ByteString

Docker image manifest JSON.

type ImageConfigJSON = ByteString

Docker image config JSON.

type RspBS = Response ByteString

Wreq response type parameterized by the lazy bytestring type.

type Extension = String

A file extension.

type RepoNamePart = Text

RepoName is the part before the forward slash in a docker image name, e.g: library in library/debian

type ImageNamePart = Text

ImageName is the part after the forward slash in a docker image name, e.g: library in library/debian

type ConfigDigest = Base32Digest

Docker image config JSON file's sha256 hash digest in Nix's base32 encoding.

NB: it's very important to realize there's a significant difference between Nix's base32 encoding and the standard base32 encoding! (i.e, they're not compatible).

data Options w

Generic top-level optparse-generic CLI args data type and specification.

NOTE: `hocker-layer` does not use this data type because it requires an additional layer sha256 hash digest argument.

Constructors

Options

Fields

• registry :: w ::: (Maybe RegistryURI <?> "URI of registry, defaults to the Docker Hub registry")

  URI for the registry, optional

• credentials :: Maybe Credentials
• out :: w ::: (Maybe FilePath <?> "Write content to location")

  Filesystem path to write output to

• imageName :: ImageName

  Docker image name (includes the reponame, e.g: library/debian)

• imageTag :: ImageTag

  Docker image tag

Instances

Show (Options Unwrapped)

Methods

showsPrec :: Int -> Options Unwrapped -> ShowS

show :: Options Unwrapped -> String

showList :: [Options Unwrapped] -> ShowS

Generic (Options w)

Associated Types

type Rep (Options w) :: * -> *

Methods

from :: Options w -> Rep (Options w) x

to :: Rep (Options w) x -> Options w

ParseRecord (Options Wrapped)

Methods

parseRecord :: Parser (Options Wrapped)

type Rep (Options w)

type Rep (Options w) = D1 (MetaData "Options" "Hocker.Types" "hocker-1.0.5-79fexLXu3Ts3AzUVy2qF0t" False) (C1 (MetaCons "Options" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "registry") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ((:::) w ((<?>) (Maybe RegistryURI) "URI of registry, defaults to the Docker Hub registry")))) (S1 (MetaSel (Just Symbol "credentials") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Credentials)))) ((:*:) (S1 (MetaSel (Just Symbol "out") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ((:::) w ((<?>) (Maybe FilePath) "Write content to location")))) ((:*:) (S1 (MetaSel (Just Symbol "imageName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ImageName)) (S1 (MetaSel (Just Symbol "imageTag") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ImageTag))))))

newtype Hocker a

Hocker ExceptT and ReaderT transformer stack threading a HockerMeta data type.

Constructors

Hocker

Fields

• unHocker :: ReaderT HockerMeta (ExceptT HockerException IO) a

Instances

Monad Hocker

Methods

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

(>>) :: Hocker a -> Hocker b -> Hocker b

return :: a -> Hocker a

fail :: String -> Hocker a

Functor Hocker

Methods

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

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

Applicative Hocker

Methods

pure :: a -> Hocker a

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

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

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

MonadIO Hocker

Methods

liftIO :: IO a -> Hocker a

MonadReader HockerMeta Hocker

Methods

ask :: Hocker HockerMeta

local :: (HockerMeta -> HockerMeta) -> Hocker a -> Hocker a

reader :: (HockerMeta -> a) -> Hocker a

MonadError HockerException Hocker

Methods

throwError :: HockerException -> Hocker a

catchError :: Hocker a -> (HockerException -> Hocker a) -> Hocker a

runHocker :: Hocker a -> HockerMeta -> IO (Either HockerException a)

data HockerMeta

Red wagon record carrying around the environment as we fetch, transform, and assemble docker image artifacts.

Constructors

HockerMeta

Fields

• dockerRegistry :: RegistryURI
• auth :: Maybe Auth
• imageName :: ImageName
• imageTag :: ImageTag
• out :: Maybe FilePath
• outDir :: Maybe FilePath
• imageLayer :: Maybe (Digest SHA256)

Instances

Show HockerMeta

Methods

showsPrec :: Int -> HockerMeta -> ShowS

show :: HockerMeta -> String

showList :: [HockerMeta] -> ShowS

MonadReader HockerMeta Hocker

Methods

ask :: Hocker HockerMeta

local :: (HockerMeta -> HockerMeta) -> Hocker a -> Hocker a

reader :: (HockerMeta -> a) -> Hocker a

newtype Base32Digest

Newtype base32 encoding of a hash digest.

Please note, this base32 encoding is unique to Nix and not compatible with other base32 encodings.

Constructors

Base32Digest Text

Instances

Eq Base32Digest

Methods

(==) :: Base32Digest -> Base32Digest -> Bool

(/=) :: Base32Digest -> Base32Digest -> Bool

Read Base32Digest

Methods

readsPrec :: Int -> ReadS Base32Digest

readList :: ReadS [Base32Digest]

readPrec :: ReadPrec Base32Digest

readListPrec :: ReadPrec [Base32Digest]

Show Base32Digest

Methods

showsPrec :: Int -> Base32Digest -> ShowS

show :: Base32Digest -> String

showList :: [Base32Digest] -> ShowS

newtype Base16Digest

Newtype base16 encoding of a hash digest.

This encoding has no known idiosyncracies specific to Nix, it should be compatible with other tools and library's expectations.

Constructors

Base16Digest Text

Instances

Eq Base16Digest

Methods

(==) :: Base16Digest -> Base16Digest -> Bool

(/=) :: Base16Digest -> Base16Digest -> Bool

Read Base16Digest

Methods

readsPrec :: Int -> ReadS Base16Digest

readList :: ReadS [Base16Digest]

readPrec :: ReadPrec Base16Digest

readListPrec :: ReadPrec [Base16Digest]

Show Base16Digest

Methods

showsPrec :: Int -> Base16Digest -> ShowS

show :: Base16Digest -> String

showList :: [Base16Digest] -> ShowS

data Credentials

Constructors

Basic Username Password

BearerToken Text

Instances

Show Credentials

Methods

showsPrec :: Int -> Credentials -> ShowS

show :: Credentials -> String

showList :: [Credentials] -> ShowS

ParseField Credentials

Methods

parseField :: Maybe Text -> Maybe Text -> Maybe Char -> Parser Credentials

parseListOfField :: Maybe Text -> Maybe Text -> Maybe Char -> Parser [Credentials]

readField :: ReadM Credentials

ParseFields Credentials

Methods

parseFields :: Maybe Text -> Maybe Text -> Maybe Char -> Parser Credentials

ParseRecord Credentials

Methods

parseRecord :: Parser Credentials

upperFirst :: String -> String

upperFirst uppercases the first letter of the string.