Distribution.Nixpkgs.Fetch

Documentation

data 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

Defined in Distribution.Nixpkgs.Fetch

Methods

(==) :: Source -> Source -> Bool

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

Ord Source

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

Defined in Distribution.Nixpkgs.Fetch

Methods

showsPrec :: Int -> Source -> ShowS

show :: Source -> String

showList :: [Source] -> ShowS

Generic Source

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

Defined in Distribution.Nixpkgs.Fetch

Methods

rnf :: Source -> ()

type Rep Source

Defined in Distribution.Nixpkgs.Fetch

type Rep Source = D1 ('MetaData "Source" "Distribution.Nixpkgs.Fetch" "cabal2nix-2.19.0-G0ZmTwEwyAGDiR9XTFX1hL" '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

Constructors

Certain String

Guess String

UnknownHash

Instances

Eq Hash

Defined in Distribution.Nixpkgs.Fetch

Methods

(==) :: Hash -> Hash -> Bool

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

Ord Hash

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

Defined in Distribution.Nixpkgs.Fetch

Methods

showsPrec :: Int -> Hash -> ShowS

show :: Hash -> String

showList :: [Hash] -> ShowS

Generic Hash

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

Defined in Distribution.Nixpkgs.Fetch

Methods

rnf :: Hash -> ()

type Rep Hash

Defined in Distribution.Nixpkgs.Fetch

type Rep Hash = D1 ('MetaData "Hash" "Distribution.Nixpkgs.Fetch" "cabal2nix-2.19.0-G0ZmTwEwyAGDiR9XTFX1hL" '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

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 :: Maybe DerivKind

  The kind of the source. If Nothing, it is a local derivation.

• 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

Show DerivationSource

Defined in Distribution.Nixpkgs.Fetch

Methods

showsPrec :: Int -> DerivationSource -> ShowS

show :: DerivationSource -> String

showList :: [DerivationSource] -> ShowS

Generic DerivationSource

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

Defined in Distribution.Nixpkgs.Fetch

Methods

rnf :: DerivationSource -> ()

FromJSON DerivationSource

Defined in Distribution.Nixpkgs.Fetch

Methods

parseJSON :: Value -> Parser DerivationSource

parseJSONList :: Value -> Parser [DerivationSource]

Pretty DerivationSource

Defined in Distribution.Nixpkgs.Fetch

Methods

pPrintPrec :: PrettyLevel -> Rational -> DerivationSource -> Doc

pPrint :: DerivationSource -> Doc

pPrintList :: PrettyLevel -> [DerivationSource] -> Doc

type Rep DerivationSource

Defined in Distribution.Nixpkgs.Fetch

type Rep DerivationSource = D1 ('MetaData "DerivationSource" "Distribution.Nixpkgs.Fetch" "cabal2nix-2.19.0-G0ZmTwEwyAGDiR9XTFX1hL" 'False) (C1 ('MetaCons "DerivationSource" 'PrefixI 'True) ((S1 ('MetaSel ('Just "derivKind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe DerivKind)) :*: 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

urlDerivationSource :: String -> String -> DerivationSource

data DerivKind

Constructors

DerivKindUrl UnpackArchive

DerivKindGit FetchSubmodules

DerivKindHg

DerivKindSvn

DerivKindBzr

Instances

Show DerivKind

Defined in Distribution.Nixpkgs.Fetch

Methods

showsPrec :: Int -> DerivKind -> ShowS

show :: DerivKind -> String

showList :: [DerivKind] -> ShowS

Generic DerivKind

Defined in Distribution.Nixpkgs.Fetch

Associated Types

type Rep DerivKind :: Type -> Type

Methods

from :: DerivKind -> Rep DerivKind x

to :: Rep DerivKind x -> DerivKind

NFData DerivKind

Defined in Distribution.Nixpkgs.Fetch

Methods

rnf :: DerivKind -> ()

type Rep DerivKind

Defined in Distribution.Nixpkgs.Fetch

type Rep DerivKind = D1 ('MetaData "DerivKind" "Distribution.Nixpkgs.Fetch" "cabal2nix-2.19.0-G0ZmTwEwyAGDiR9XTFX1hL" 'False) ((C1 ('MetaCons "DerivKindUrl" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnpackArchive)) :+: C1 ('MetaCons "DerivKindGit" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FetchSubmodules))) :+: (C1 ('MetaCons "DerivKindHg" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DerivKindSvn" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DerivKindBzr" 'PrefixI 'False) (U1 :: Type -> Type))))

derivKindFunction :: DerivKind -> String

The nixpkgs function to use for fetching this kind of derivation

data FetchSubmodules

Whether to fetch submodules (git).

Constructors

FetchSubmodules

DontFetchSubmodules

Instances

Show FetchSubmodules

Defined in Distribution.Nixpkgs.Fetch

Methods

showsPrec :: Int -> FetchSubmodules -> ShowS

show :: FetchSubmodules -> String

showList :: [FetchSubmodules] -> ShowS

Generic FetchSubmodules

Defined in Distribution.Nixpkgs.Fetch

Associated Types

type Rep FetchSubmodules :: Type -> Type

Methods

from :: FetchSubmodules -> Rep FetchSubmodules x

to :: Rep FetchSubmodules x -> FetchSubmodules

NFData FetchSubmodules

Defined in Distribution.Nixpkgs.Fetch

Methods

rnf :: FetchSubmodules -> ()

type Rep FetchSubmodules

Defined in Distribution.Nixpkgs.Fetch

type Rep FetchSubmodules = D1 ('MetaData "FetchSubmodules" "Distribution.Nixpkgs.Fetch" "cabal2nix-2.19.0-G0ZmTwEwyAGDiR9XTFX1hL" 'False) (C1 ('MetaCons "FetchSubmodules" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DontFetchSubmodules" 'PrefixI 'False) (U1 :: Type -> Type))

data UnpackArchive

Whether to unpack an archive after fetching, before putting it into the nix store.

Constructors

UnpackArchive

DontUnpackArchive

Instances

Show UnpackArchive

Defined in Distribution.Nixpkgs.Fetch

Methods

showsPrec :: Int -> UnpackArchive -> ShowS

show :: UnpackArchive -> String

showList :: [UnpackArchive] -> ShowS

Generic UnpackArchive

Defined in Distribution.Nixpkgs.Fetch

Associated Types

type Rep UnpackArchive :: Type -> Type

Methods

from :: UnpackArchive -> Rep UnpackArchive x

to :: Rep UnpackArchive x -> UnpackArchive

NFData UnpackArchive

Defined in Distribution.Nixpkgs.Fetch

Methods

rnf :: UnpackArchive -> ()

type Rep UnpackArchive

Defined in Distribution.Nixpkgs.Fetch

type Rep UnpackArchive = D1 ('MetaData "UnpackArchive" "Distribution.Nixpkgs.Fetch" "cabal2nix-2.19.0-G0ZmTwEwyAGDiR9XTFX1hL" 'False) (C1 ('MetaCons "UnpackArchive" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DontUnpackArchive" 'PrefixI 'False) (U1 :: Type -> Type))

fetch

Arguments

:: forall a. FetchSubmodules

whether to 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, DerivKind) -> Source -> MaybeT IO (DerivationSource, FilePath)

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