Copyright	Profpatsch 2018
License	GPL-3
Stability	experimental
Portability	nix-prefetch-scripts 2018 (no version number)
Safe Haskell	None
Language	Haskell2010

Foreign.Nix.Shellout.Prefetch

Contents

nix-prefetch-url
nix-prefetch-git
Types
Reexports

Description

Calls to the nix-prefetch-X utilities, to parse their output into nice reusable data types.

Synopsis

url :: UrlOptions -> NixAction PrefetchError (Sha256, StorePath Realized)
data UrlOptions = UrlOptions {
- urlUrl :: Url
- urlUnpack :: Bool
- urlName :: Maybe Text
- urlExpectedHash :: Maybe Sha256
}
defaultUrlOptions :: Url -> UrlOptions
git :: GitOptions -> NixAction PrefetchError GitOutput
data GitOptions = GitOptions {
- gitUrl :: Url
- gitRev :: Maybe Text
- gitExpectedHash :: Maybe Sha256
- gitDeepClone :: Bool
- gitLeaveDotGit :: Bool
- gitFetchSubmodules :: Bool
}
defaultGitOptions :: Url -> GitOptions
data GitOutput = GitOutput {
- gitOutputRev :: Text
- gitOutputSha256 :: Sha256
- gitOuputPath :: StorePath Realized
}
data PrefetchError
newtype Url = Url {
- unUrl :: Text
}
newtype Sha256 = Sha256 {
- unSha256 :: Text
}
runNixAction :: NixAction e a -> IO (Either (Text, e) a)
newtype NixAction e a = NixAction {
- unNixAction :: ExceptT (Text, e) IO a
}

nix-prefetch-url

url :: UrlOptions -> NixAction PrefetchError (Sha256, StorePath Realized) Source #

Runs nix-prefetch-url.

data UrlOptions Source #

Constructors

UrlOptions
Fields urlUrl :: Url the URL urlUnpack :: Bool whether to unpack before hashing (useful for prefetching `fetchTarball`) urlName :: Maybe Text name of the store path urlExpectedHash :: Maybe Sha256 the hash we are expecting

defaultUrlOptions :: Url -> UrlOptions Source #

Takes the URL, doesn’t unpack and uses the default name.

nix-prefetch-git

git :: GitOptions -> NixAction PrefetchError GitOutput Source #

Runs nix-prefetch-git.

data GitOptions Source #

Constructors

GitOptions
Fields gitUrl :: Url the URL gitRev :: Maybe Text a git revision (hash, branch name, tag, ref, …) gitExpectedHash :: Maybe Sha256 the hash we are expecting gitDeepClone :: Bool whether to do a deep instead of a shallow (`--depth=1`) git clone gitLeaveDotGit :: Bool whether to keep `.git` directories gitFetchSubmodules :: Bool whether to fetch submodules

defaultGitOptions :: Url -> GitOptions Source #

Takes the url, mirrors the default fetchgit options in nixpkgs: no deep clone, no .git, fetches submodules by default. By default, the latest default rev is used.

data GitOutput Source #

Constructors

GitOutput
Fields gitOutputRev :: Text The actual revision that is used (useful if no `gitRev` was given) gitOutputSha256 :: Sha256 the hash gitOuputPath :: StorePath Realized the store path of the result

Instances

Eq GitOutput Source #
Instance details Defined in Foreign.Nix.Shellout.Prefetch Methods (==) :: GitOutput -> GitOutput -> Bool # (/=) :: GitOutput -> GitOutput -> Bool #
Show GitOutput Source #
Instance details Defined in Foreign.Nix.Shellout.Prefetch Methods showsPrec :: Int -> GitOutput -> ShowS # show :: GitOutput -> String # showList :: [GitOutput] -> ShowS #

Types

data PrefetchError Source #

Constructors

PrefetchOutputMalformed Text	the tool’s output could not be parsed as expected
ExpectedHashError	an expected hash was given and not valid
UnknownPrefetchError	catch-all error

Instances

Eq PrefetchError Source #
Instance details Defined in Foreign.Nix.Shellout.Prefetch Methods (==) :: PrefetchError -> PrefetchError -> Bool # (/=) :: PrefetchError -> PrefetchError -> Bool #
Show PrefetchError Source #
Instance details Defined in Foreign.Nix.Shellout.Prefetch Methods showsPrec :: Int -> PrefetchError -> ShowS # show :: PrefetchError -> String # showList :: [PrefetchError] -> ShowS #

newtype Url Source #

A descriptive type for URLs.

Constructors

Url
Fields unUrl :: Text

Instances

Eq Url Source #
Instance details Defined in Foreign.Nix.Shellout.Prefetch Methods (==) :: Url -> Url -> Bool # (/=) :: Url -> Url -> Bool #
Show Url Source #
Instance details Defined in Foreign.Nix.Shellout.Prefetch Methods showsPrec :: Int -> Url -> ShowS # show :: Url -> String # showList :: [Url] -> ShowS #
IsString Url Source #
Instance details Defined in Foreign.Nix.Shellout.Prefetch Methods fromString :: String -> Url #

newtype Sha256 Source #

A sha-256 hash.

Constructors

Sha256
Fields unSha256 :: Text

Instances

Eq Sha256 Source #
Instance details Defined in Foreign.Nix.Shellout.Prefetch Methods (==) :: Sha256 -> Sha256 -> Bool # (/=) :: Sha256 -> Sha256 -> Bool #
Show Sha256 Source #
Instance details Defined in Foreign.Nix.Shellout.Prefetch Methods showsPrec :: Int -> Sha256 -> ShowS # show :: Sha256 -> String # showList :: [Sha256] -> ShowS #
IsString Sha256 Source #
Instance details Defined in Foreign.Nix.Shellout.Prefetch Methods fromString :: String -> Sha256 #

Reexports

runNixAction :: NixAction e a -> IO (Either (Text, e) a) Source #

Run a NixAction without having to go through ExceptT first.

newtype NixAction e a Source #

Calls a command that returns an error and the whole stderr on failure.

Constructors

NixAction
Fields unNixAction :: ExceptT (Text, e) IO a

Instances

Bifunctor NixAction Source #
Instance details Defined in Foreign.Nix.Shellout.Types Methods bimap :: (a -> b) -> (c -> d) -> NixAction a c -> NixAction b d # first :: (a -> b) -> NixAction a c -> NixAction b c # second :: (b -> c) -> NixAction a b -> NixAction a c #
Monad (NixAction e) Source #
Instance details Defined in Foreign.Nix.Shellout.Types Methods (>>=) :: NixAction e a -> (a -> NixAction e b) -> NixAction e b # (>>) :: NixAction e a -> NixAction e b -> NixAction e b # return :: a -> NixAction e a # fail :: String -> NixAction e a #
Functor (NixAction e) Source #
Instance details Defined in Foreign.Nix.Shellout.Types Methods fmap :: (a -> b) -> NixAction e a -> NixAction e b # (<$) :: a -> NixAction e b -> NixAction e a #
Applicative (NixAction e) Source #
Instance details Defined in Foreign.Nix.Shellout.Types Methods pure :: a -> NixAction e a # (<>) :: NixAction e (a -> b) -> NixAction e a -> NixAction e b # liftA2 :: (a -> b -> c) -> NixAction e a -> NixAction e b -> NixAction e c # (>) :: NixAction e a -> NixAction e b -> NixAction e b # (<*) :: NixAction e a -> NixAction e b -> NixAction e a #
MonadIO (NixAction e) Source #
Instance details Defined in Foreign.Nix.Shellout.Types Methods liftIO :: IO a -> NixAction e a #