NvFetcher.NixFetcher

NixFetcher is used to describe how to fetch package sources.

There are three types of fetchers overall:

1. FetchGit -- nix-prefetch fetchgit
2. FetchGitHub -- nix-prefetch fetchFromGitHub
3. FetchUrl -- nix-prefetch fetchurl

As you can see the type signature of prefetch: a fetcher will be filled with the fetch result (hash) after the prefetch.

Types

data NixFetcher (k :: FetchStatus)

If the package is prefetched, then we can obtain the SHA256

Constructors

FetchGit

Fields

• _furl :: Text
• _rev :: Version
• _deepClone :: Bool
• _fetchSubmodules :: Bool
• _leaveDotGit :: Bool
• _name :: Maybe Text
• _sha256 :: FetchResult k

FetchGitHub

Fields

• _fowner :: Text
• _frepo :: Text
• _rev :: Version
• _deepClone :: Bool
• _fetchSubmodules :: Bool
• _leaveDotGit :: Bool
• _name :: Maybe Text
• _sha256 :: FetchResult k

FetchUrl

Fields

• _furl :: Text
• _name :: Maybe Text
• _sha256 :: FetchResult k

FetchTarball

Fields

• _furl :: Text
• _sha256 :: FetchResult k

Instances

Eq (FetchResult k) => Eq (NixFetcher k)

Defined in NvFetcher.Types

Methods

(==) :: NixFetcher k -> NixFetcher k -> Bool

(/=) :: NixFetcher k -> NixFetcher k -> Bool

Ord (FetchResult k) => Ord (NixFetcher k)

Defined in NvFetcher.Types

Methods

compare :: NixFetcher k -> NixFetcher k -> Ordering

(<) :: NixFetcher k -> NixFetcher k -> Bool

(<=) :: NixFetcher k -> NixFetcher k -> Bool

(>) :: NixFetcher k -> NixFetcher k -> Bool

(>=) :: NixFetcher k -> NixFetcher k -> Bool

max :: NixFetcher k -> NixFetcher k -> NixFetcher k

min :: NixFetcher k -> NixFetcher k -> NixFetcher k

Show (FetchResult k) => Show (NixFetcher k)

Defined in NvFetcher.Types

Methods

showsPrec :: Int -> NixFetcher k -> ShowS

show :: NixFetcher k -> String

showList :: [NixFetcher k] -> ShowS

Generic (NixFetcher k)

Defined in NvFetcher.Types

Associated Types

type Rep (NixFetcher k) :: Type -> Type

Methods

from :: NixFetcher k -> Rep (NixFetcher k) x

to :: Rep (NixFetcher k) x -> NixFetcher k

Hashable (FetchResult k) => Hashable (NixFetcher k)

Defined in NvFetcher.Types

Methods

hashWithSalt :: Int -> NixFetcher k -> Int

hash :: NixFetcher k -> Int

ToJSON (NixFetcher 'Fetched)

Defined in NvFetcher.Types

Methods

toJSON :: NixFetcher 'Fetched -> Value

toEncoding :: NixFetcher 'Fetched -> Encoding

toJSONList :: [NixFetcher 'Fetched] -> Value

toEncodingList :: [NixFetcher 'Fetched] -> Encoding

Binary (FetchResult k) => Binary (NixFetcher k)

Defined in NvFetcher.Types

Methods

put :: NixFetcher k -> Put

get :: Get (NixFetcher k)

putList :: [NixFetcher k] -> Put

NFData (FetchResult k) => NFData (NixFetcher k)

Defined in NvFetcher.Types

Methods

rnf :: NixFetcher k -> ()

Pretty (NixFetcher k)

Defined in NvFetcher.Types

Methods

pretty :: NixFetcher k -> Doc ann

prettyList :: [NixFetcher k] -> Doc ann

ToNixExpr (NixFetcher 'Fresh)

Defined in NvFetcher.NixExpr

Methods

toNixExpr :: NixFetcher 'Fresh -> NixExpr

ToNixExpr (NixFetcher 'Fetched)

Defined in NvFetcher.NixExpr

Methods

toNixExpr :: NixFetcher 'Fetched -> NixExpr

type Rep (NixFetcher k)

Defined in NvFetcher.Types

type Rep (NixFetcher k) = D1 ('MetaData "NixFetcher" "NvFetcher.Types" "nvfetcher-0.5.0.0-3yJjetg0q7IBedlVdRRp6j" 'False) ((C1 ('MetaCons "FetchGit" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_furl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "_rev") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version) :*: S1 ('MetaSel ('Just "_deepClone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "_fetchSubmodules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "_leaveDotGit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_sha256") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (FetchResult k))))) :+: C1 ('MetaCons "FetchGitHub" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_fowner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_frepo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "_rev") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version) :*: S1 ('MetaSel ('Just "_deepClone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "_fetchSubmodules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "_leaveDotGit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_sha256") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (FetchResult k)))))) :+: (C1 ('MetaCons "FetchUrl" 'PrefixI 'True) (S1 ('MetaSel ('Just "_furl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_sha256") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (FetchResult k)))) :+: C1 ('MetaCons "FetchTarball" 'PrefixI 'True) (S1 ('MetaSel ('Just "_furl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_sha256") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (FetchResult k)))))

type RuleResult (NixFetcher 'Fresh)

Defined in NvFetcher.Types

type RuleResult (NixFetcher 'Fresh) = NixFetcher 'Fetched

data FetchStatus

Fetch status

Constructors

Fresh

Fetched

type family FetchResult (k :: FetchStatus) where ...

Prefetched fetchers hold hashes

Equations

FetchResult Fresh = ()

FetchResult Fetched = Checksum

Rules

prefetchRule :: Rules ()

Rules of nix fetcher

prefetch :: NixFetcher Fresh -> Action (NixFetcher Fetched)

Run nix fetcher

Functions

gitHubFetcher

Arguments

:: (Text, Text)

owner and repo

-> PackageFetcher

Create a fetcher from github repo

pypiFetcher :: Text -> PackageFetcher

Create a fetcher from pypi

gitHubReleaseFetcher

Arguments

:: (Text, Text)

owner and repo

-> Text

file name

-> PackageFetcher

Create a fetcher from github release

gitFetcher :: Text -> PackageFetcher

Create a fetcher from git url

urlFetcher :: Text -> NixFetcher Fresh

Create a fetcher from url

openVsxFetcher

Arguments

:: (Text, Text)

publisher and extension name

-> PackageFetcher

Create a fetcher from openvsx

vscodeMarketplaceFetcher

Arguments

:: (Text, Text)

publisher and extension name

-> PackageFetcher

Create a fetcher from vscode marketplace

tarballFetcher :: Text -> NixFetcher Fresh

Create a fetcher from url, using fetchTarball