Foreign.Nix.Shellout.Prefetch

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

nix-prefetch-url

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

Runs nix-prefetch-url.

data UrlOptions

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

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

nix-prefetch-git

git :: GitOptions -> NixAction PrefetchError GitOutput

Runs nix-prefetch-git.

data GitOptions

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

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

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

Defined in Foreign.Nix.Shellout.Prefetch

Methods

(==) :: GitOutput -> GitOutput -> Bool

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

Show GitOutput

Defined in Foreign.Nix.Shellout.Prefetch

Methods

showsPrec :: Int -> GitOutput -> ShowS

show :: GitOutput -> String

showList :: [GitOutput] -> ShowS

Types

data PrefetchError

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

Defined in Foreign.Nix.Shellout.Prefetch

Methods

(==) :: PrefetchError -> PrefetchError -> Bool

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

Show PrefetchError

Defined in Foreign.Nix.Shellout.Prefetch

Methods

showsPrec :: Int -> PrefetchError -> ShowS

show :: PrefetchError -> String

showList :: [PrefetchError] -> ShowS

newtype Url

A descriptive type for URLs.

Constructors

Url

Fields

• unUrl :: Text

Instances

Eq Url

Defined in Foreign.Nix.Shellout.Prefetch

Methods

(==) :: Url -> Url -> Bool

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

Show Url

Defined in Foreign.Nix.Shellout.Prefetch

Methods

showsPrec :: Int -> Url -> ShowS

show :: Url -> String

showList :: [Url] -> ShowS

IsString Url

Defined in Foreign.Nix.Shellout.Prefetch

Methods

fromString :: String -> Url

newtype Sha256

A sha-256 hash.

Constructors

Sha256

Fields

• unSha256 :: Text

Instances

Eq Sha256

Defined in Foreign.Nix.Shellout.Prefetch

Methods

(==) :: Sha256 -> Sha256 -> Bool

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

Show Sha256

Defined in Foreign.Nix.Shellout.Prefetch

Methods

showsPrec :: Int -> Sha256 -> ShowS

show :: Sha256 -> String

showList :: [Sha256] -> ShowS

IsString Sha256

Defined in Foreign.Nix.Shellout.Prefetch

Methods

fromString :: String -> Sha256

Reexports

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

Run a NixAction without having to go through ExceptT first.

newtype NixAction e a

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

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)

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)

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)

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)

Defined in Foreign.Nix.Shellout.Types

Methods

liftIO :: IO a -> NixAction e a