Safe Haskell	None
Language	Haskell2010

Distribution.Nixpkgs.Fetch

Synopsis

data Source = Source {
- sourceUrl :: String
- sourceRevision :: String
- sourceHash :: Hash
- sourceCabalDir :: String
}
data Hash
- = Certain String
- | Guess String
- | UnknownHash
data DerivationSource = DerivationSource {
- derivKind :: String
- derivUrl :: String
- derivRevision :: String
- derivHash :: String
- derivSubmodule :: Maybe Bool
}
fromDerivationSource :: DerivationSource -> Source
urlDerivationSource :: String -> String -> DerivationSource
fetch :: forall a. Bool -> (String -> MaybeT IO a) -> Source -> IO (Maybe (DerivationSource, a))
fetchWith :: (Bool, String, [String]) -> Source -> MaybeT IO (DerivationSource, FilePath)

Documentation

data Source Source #

A source is a location from which we can fetch, such as a HTTP URL, a GIT URL, ....

Constructors

Source
Fields sourceUrl :: String URL to fetch from. sourceRevision :: String Revision to use. For protocols where this doesn't make sense (such as HTTP), this should be the empty string. sourceHash :: Hash The expected hash of the source, if available. sourceCabalDir :: String Directory where Cabal file is found.

Instances

Eq Source Source #
Instance details Defined in Distribution.Nixpkgs.Fetch Methods (==) :: Source -> Source -> Bool # (/=) :: Source -> Source -> Bool #
Ord Source Source #
Instance details Defined in Distribution.Nixpkgs.Fetch Methods compare :: Source -> Source -> Ordering # (<) :: Source -> Source -> Bool # (<=) :: Source -> Source -> Bool # (>) :: Source -> Source -> Bool # (>=) :: Source -> Source -> Bool # max :: Source -> Source -> Source # min :: Source -> Source -> Source #
Show Source Source #
Instance details Defined in Distribution.Nixpkgs.Fetch Methods showsPrec :: Int -> Source -> ShowS # show :: Source -> String # showList :: [Source] -> ShowS #
Generic Source Source #
Instance details Defined in Distribution.Nixpkgs.Fetch Associated Types type Rep Source :: Type -> Type # Methods from :: Source -> Rep Source x # to :: Rep Source x -> Source #
NFData Source Source #
Instance details Defined in Distribution.Nixpkgs.Fetch Methods rnf :: Source -> () #
type Rep Source Source #
Instance details Defined in Distribution.Nixpkgs.Fetch type Rep Source = D1 (MetaData "Source" "Distribution.Nixpkgs.Fetch" "cabal2nix-2.14.3-Kr1oLuEpenVzlKtMSSPI6" False) (C1 (MetaCons "Source" PrefixI True) ((S1 (MetaSel (Just "sourceUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :: S1 (MetaSel (Just "sourceRevision") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :: (S1 (MetaSel (Just "sourceHash") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Hash) :*: S1 (MetaSel (Just "sourceCabalDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))

data Hash Source #

Constructors

Certain String
Guess String
UnknownHash

Instances

Eq Hash Source #
Instance details Defined in Distribution.Nixpkgs.Fetch Methods (==) :: Hash -> Hash -> Bool # (/=) :: Hash -> Hash -> Bool #
Ord Hash Source #
Instance details Defined in Distribution.Nixpkgs.Fetch Methods compare :: Hash -> Hash -> Ordering # (<) :: Hash -> Hash -> Bool # (<=) :: Hash -> Hash -> Bool # (>) :: Hash -> Hash -> Bool # (>=) :: Hash -> Hash -> Bool # max :: Hash -> Hash -> Hash # min :: Hash -> Hash -> Hash #
Show Hash Source #
Instance details Defined in Distribution.Nixpkgs.Fetch Methods showsPrec :: Int -> Hash -> ShowS # show :: Hash -> String # showList :: [Hash] -> ShowS #
Generic Hash Source #
Instance details Defined in Distribution.Nixpkgs.Fetch Associated Types type Rep Hash :: Type -> Type # Methods from :: Hash -> Rep Hash x # to :: Rep Hash x -> Hash #
NFData Hash Source #
Instance details Defined in Distribution.Nixpkgs.Fetch Methods rnf :: Hash -> () #
type Rep Hash Source #
Instance details Defined in Distribution.Nixpkgs.Fetch type Rep Hash = D1 (MetaData "Hash" "Distribution.Nixpkgs.Fetch" "cabal2nix-2.14.3-Kr1oLuEpenVzlKtMSSPI6" False) (C1 (MetaCons "Certain" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: (C1 (MetaCons "Guess" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: C1 (MetaCons "UnknownHash" PrefixI False) (U1 :: Type -> Type)))

data DerivationSource Source #

A source for a derivation. It always needs a hash and also has a protocol attached to it (url, git, svn, ...). A DerivationSource also always has it's revision fully resolved (not relative revisions like master, HEAD, etc).

Constructors

DerivationSource
Fields derivKind :: String The kind of the source. The name of the build-support fetch derivation should be fetchkind. derivUrl :: String URL to fetch from. derivRevision :: String Revision to use. Leave empty if the fetcher doesn't support revisions. derivHash :: String The hash of the source. derivSubmodule :: Maybe Bool The fetchSubmodule setting (if any)

Instances

Eq DerivationSource Source #
Instance details Defined in Distribution.Nixpkgs.Fetch Methods (==) :: DerivationSource -> DerivationSource -> Bool # (/=) :: DerivationSource -> DerivationSource -> Bool #
Ord DerivationSource Source #
Instance details Defined in Distribution.Nixpkgs.Fetch Methods compare :: DerivationSource -> DerivationSource -> Ordering # (<) :: DerivationSource -> DerivationSource -> Bool # (<=) :: DerivationSource -> DerivationSource -> Bool # (>) :: DerivationSource -> DerivationSource -> Bool # (>=) :: DerivationSource -> DerivationSource -> Bool # max :: DerivationSource -> DerivationSource -> DerivationSource # min :: DerivationSource -> DerivationSource -> DerivationSource #
Show DerivationSource Source #
Instance details Defined in Distribution.Nixpkgs.Fetch Methods showsPrec :: Int -> DerivationSource -> ShowS # show :: DerivationSource -> String # showList :: [DerivationSource] -> ShowS #
Generic DerivationSource Source #
Instance details Defined in Distribution.Nixpkgs.Fetch Associated Types type Rep DerivationSource :: Type -> Type # Methods from :: DerivationSource -> Rep DerivationSource x # to :: Rep DerivationSource x -> DerivationSource #
NFData DerivationSource Source #
Instance details Defined in Distribution.Nixpkgs.Fetch Methods rnf :: DerivationSource -> () #
FromJSON DerivationSource Source #
Instance details Defined in Distribution.Nixpkgs.Fetch Methods parseJSON :: Value -> Parser DerivationSource # parseJSONList :: Value -> Parser [DerivationSource] #
Pretty DerivationSource Source #
Instance details Defined in Distribution.Nixpkgs.Fetch Methods pPrintPrec :: PrettyLevel -> Rational -> DerivationSource -> Doc # pPrint :: DerivationSource -> Doc # pPrintList :: PrettyLevel -> [DerivationSource] -> Doc #
type Rep DerivationSource Source #
Instance details Defined in Distribution.Nixpkgs.Fetch type Rep DerivationSource = D1 (MetaData "DerivationSource" "Distribution.Nixpkgs.Fetch" "cabal2nix-2.14.3-Kr1oLuEpenVzlKtMSSPI6" False) (C1 (MetaCons "DerivationSource" PrefixI True) ((S1 (MetaSel (Just "derivKind") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :: S1 (MetaSel (Just "derivUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :: (S1 (MetaSel (Just "derivRevision") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :: (S1 (MetaSel (Just "derivHash") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :: S1 (MetaSel (Just "derivSubmodule") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))))))

fromDerivationSource :: DerivationSource -> Source Source #

urlDerivationSource :: String -> String -> DerivationSource Source #

fetch Source #

Arguments

:: Bool	If True, fetch submodules when the source is a git repository
-> (String -> MaybeT IO a)	This function is passed the output path name as an argument. It should return `Nothing` if the file doesn't match the expected format. This is required, because we cannot always check if a download succeeded otherwise.
-> Source	The source to fetch from.
-> IO (Maybe (DerivationSource, a))	The derivation source and the result of the processing function. Returns Nothing if the download failed.

Fetch a source, trying any of the various nix-prefetch-* scripts.

fetchWith :: (Bool, String, [String]) -> Source -> MaybeT IO (DerivationSource, FilePath) Source #

Like fetch, but allows to specify which script to use.