NvFetcher.NixFetcher

NixFetcher is used to describe how to fetch package sources.

There are two types of fetchers overall:

1. FetchGit -- nix-prefetch-git
2. FetchUrl -- nix-prefetch-url

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 :: Prefetch)

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

Constructors

FetchGit

Fields

• furl :: Text
• rev :: Version
• branch :: Maybe Text
• deepClone :: Bool
• fetchSubmodules :: Bool
• leaveDotGit :: Bool
• sha256 :: PrefetchResult k

FetchUrl

Fields

• furl :: Text
• sha256 :: PrefetchResult k

Instances

Eq (PrefetchResult k) => Eq (NixFetcher k)

Defined in NvFetcher.Types

Methods

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

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

Ord (PrefetchResult 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 (PrefetchResult 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 (PrefetchResult k) => Hashable (NixFetcher k)

Defined in NvFetcher.Types

Methods

hashWithSalt :: Int -> NixFetcher k -> Int

hash :: NixFetcher k -> Int

Binary (PrefetchResult k) => Binary (NixFetcher k)

Defined in NvFetcher.Types

Methods

put :: NixFetcher k -> Put

get :: Get (NixFetcher k)

putList :: [NixFetcher k] -> Put

NFData (PrefetchResult k) => NFData (NixFetcher k)

Defined in NvFetcher.Types

Methods

rnf :: NixFetcher k -> ()

ToNixExpr (NixFetcher 'Fresh)

Defined in NvFetcher.NixFetcher

Methods

toNixExpr :: NixFetcher 'Fresh -> NixExpr

ToNixExpr (NixFetcher 'Prefetched)

Defined in NvFetcher.NixFetcher

Methods

toNixExpr :: NixFetcher 'Prefetched -> NixExpr

type Rep (NixFetcher k)

Defined in NvFetcher.Types

type Rep (NixFetcher k) = D1 ('MetaData "NixFetcher" "NvFetcher.Types" "nvfetcher-0.1.0.0-inplace" '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 "branch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :*: ((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 "sha256") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PrefetchResult k))))) :+: C1 ('MetaCons "FetchUrl" 'PrefixI 'True) (S1 ('MetaSel ('Just "furl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "sha256") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PrefetchResult k))))

type RuleResult (NixFetcher 'Fresh)

Defined in NvFetcher.Types

type RuleResult (NixFetcher 'Fresh) = NixFetcher 'Prefetched

data Prefetch

Prefetch status

Constructors

Fresh

Prefetched

class ToNixExpr a where

Types can be converted into nix expr

Methods

toNixExpr :: a -> NixExpr

Instances

ToNixExpr Bool

Defined in NvFetcher.NixFetcher

Methods

toNixExpr :: Bool -> NixExpr

ToNixExpr Version

Defined in NvFetcher.NixFetcher

Methods

toNixExpr :: Version -> NixExpr

ToNixExpr (NixFetcher 'Fresh)

Defined in NvFetcher.NixFetcher

Methods

toNixExpr :: NixFetcher 'Fresh -> NixExpr

ToNixExpr (NixFetcher 'Prefetched)

Defined in NvFetcher.NixFetcher

Methods

toNixExpr :: NixFetcher 'Prefetched -> NixExpr

type family PrefetchResult (k :: Prefetch) where ...

Prefetched fetchers hold hashes

Equations

PrefetchResult Fresh = ()

PrefetchResult Prefetched = SHA256

Rules

prefetchRule :: Rules ()

Rules of nix fetcher

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

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