Copyright	(c) 2021-2025 berberman
License	MIT
Maintainer	berberman <[email protected]>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

NvFetcher.NixFetcher

Contents

Types
Rules
Functions

Description

NixFetcher is used to describe how to fetch package sources.

There are five types of fetchers overall:

FetchGit -- nix-prefetch-git
FetchGitHub -- nix-prefetch-git/nix-prefetch-url
FetchUrl -- nix-prefetch-url
FetchTarball -- nix-prefetch-url
FetchDocker -- nix-prefetch-docker

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

Synopsis

data RunFetch = RunFetch ForceFetch (NixFetcher 'Fresh)
data ForceFetch
- = ForceFetch
- | NoForceFetch
data NixFetcher (k :: FetchStatus)
- = FetchGit {
  - _furl :: Text
  - _rev :: Version
  - _deepClone :: Bool
  - _fetchSubmodules :: Bool
  - _leaveDotGit :: Bool
  - _sparseCheckout :: [Text]
  - _name :: Maybe Text
  - _sha256 :: FetchResult Checksum k
  }
- | FetchGitHub {
  - _fowner :: Text
  - _frepo :: Text
  - _rev :: Version
  - _deepClone :: Bool
  - _fetchSubmodules :: Bool
  - _leaveDotGit :: Bool
  - _sparseCheckout :: [Text]
  - _name :: Maybe Text
  - _sha256 :: FetchResult Checksum k
  }
- | FetchUrl {
  - _furl :: Text
  - _name :: Maybe Text
  - _sha256 :: FetchResult Checksum k
  }
- | FetchTarball {
  - _furl :: Text
  - _sha256 :: FetchResult Checksum k
  }
- | FetchDocker {
  - _imageName :: Text
  - _imageTag :: Text
  - _imageDigest :: FetchResult ContainerDigest k
  - _sha256 :: FetchResult Checksum k
  - _fos :: Maybe Text
  - _farch :: Maybe Text
  - _finalImageName :: Maybe Text
  - _finalImageTag :: Maybe Text
  - _tlsVerify :: Maybe Bool
  }
data FetchStatus
- = Fresh
- | Fetched
type family FetchResult a (k :: FetchStatus) where ...
prefetchRule :: Rules ()
prefetch :: NixFetcher 'Fresh -> ForceFetch -> Action (Maybe (NixFetcher 'Fetched))
gitHubFetcher :: (Text, Text) -> PackageFetcher
pypiFetcher :: Text -> PackageFetcher
gitHubReleaseFetcher :: (Text, Text) -> Text -> PackageFetcher
gitHubReleaseFetcher' :: (Text, Text) -> (Version -> Text) -> PackageFetcher
gitFetcher :: Text -> PackageFetcher
urlFetcher :: Text -> NixFetcher 'Fresh
urlFetcher' :: Text -> Maybe Text -> NixFetcher 'Fresh
openVsxFetcher :: (Text, Text) -> PackageFetcher
vscodeMarketplaceFetcher :: (Text, Text) -> PackageFetcher
tarballFetcher :: Text -> NixFetcher 'Fresh

Types

data RunFetch Source #

The input of prefetch rule

Constructors

RunFetch ForceFetch (NixFetcher 'Fresh)

Instances

Instances details

Generic RunFetch Source #

Instance details

Defined in NvFetcher.Types

Associated Types

type Rep RunFetch

Instance details

Defined in NvFetcher.Types

type Rep RunFetch = D1 ('MetaData "RunFetch" "NvFetcher.Types" "nvfetcher-0.7.0.0-AhFFh7reJc9KmNyxRtjlmD" 'False) (C1 ('MetaCons "RunFetch" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ForceFetch) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NixFetcher 'Fresh))))

Methods

from :: RunFetch -> Rep RunFetch x #

to :: Rep RunFetch x -> RunFetch #

Show RunFetch Source #

Instance details

Defined in NvFetcher.Types

Methods

showsPrec :: Int -> RunFetch -> ShowS #

show :: RunFetch -> String #

showList :: [RunFetch] -> ShowS #

Binary RunFetch Source #

Instance details

Defined in NvFetcher.Types

Methods

put :: RunFetch -> Put #

get :: Get RunFetch #

putList :: [RunFetch] -> Put #

NFData RunFetch Source #

Instance details

Defined in NvFetcher.Types

Methods

rnf :: RunFetch -> () #

Eq RunFetch Source #

Instance details

Defined in NvFetcher.Types

Methods

(==) :: RunFetch -> RunFetch -> Bool #

(/=) :: RunFetch -> RunFetch -> Bool #

Ord RunFetch Source #

Instance details

Defined in NvFetcher.Types

Methods

compare :: RunFetch -> RunFetch -> Ordering #

(<) :: RunFetch -> RunFetch -> Bool #

(<=) :: RunFetch -> RunFetch -> Bool #

(>) :: RunFetch -> RunFetch -> Bool #

(>=) :: RunFetch -> RunFetch -> Bool #

max :: RunFetch -> RunFetch -> RunFetch #

min :: RunFetch -> RunFetch -> RunFetch #

Hashable RunFetch Source #

Instance details

Defined in NvFetcher.Types

Methods

hashWithSalt :: Int -> RunFetch -> Int #

hash :: RunFetch -> Int #

type Rep RunFetch Source #

Instance details

Defined in NvFetcher.Types

type Rep RunFetch = D1 ('MetaData "RunFetch" "NvFetcher.Types" "nvfetcher-0.7.0.0-AhFFh7reJc9KmNyxRtjlmD" 'False) (C1 ('MetaCons "RunFetch" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ForceFetch) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NixFetcher 'Fresh))))

type RuleResult RunFetch Source #

Instance details

Defined in NvFetcher.Types

type RuleResult RunFetch = Maybe (NixFetcher 'Fetched)

data ForceFetch Source #

Whether to cache the fetched sha256

ForceFetch indicates alwaysRerun the fetcher rule

Constructors

ForceFetch
NoForceFetch

Instances

Instances details

Generic ForceFetch Source #

Instance details

Defined in NvFetcher.Types

Associated Types

type Rep ForceFetch
Instance details Defined in NvFetcher.Types type Rep ForceFetch = D1 ('MetaData "ForceFetch" "NvFetcher.Types" "nvfetcher-0.7.0.0-AhFFh7reJc9KmNyxRtjlmD" 'False) (C1 ('MetaCons "ForceFetch" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoForceFetch" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: ForceFetch -> Rep ForceFetch x #

to :: Rep ForceFetch x -> ForceFetch #

Show ForceFetch Source #

Instance details

Defined in NvFetcher.Types

Methods

showsPrec :: Int -> ForceFetch -> ShowS #

show :: ForceFetch -> String #

showList :: [ForceFetch] -> ShowS #

Binary ForceFetch Source #

Instance details

Defined in NvFetcher.Types

Methods

put :: ForceFetch -> Put #

get :: Get ForceFetch #

putList :: [ForceFetch] -> Put #

Default ForceFetch Source #

Instance details

Defined in NvFetcher.Types

Methods

def :: ForceFetch #

NFData ForceFetch Source #

Instance details

Defined in NvFetcher.Types

Methods

rnf :: ForceFetch -> () #

Eq ForceFetch Source #

Instance details

Defined in NvFetcher.Types

Methods

(==) :: ForceFetch -> ForceFetch -> Bool #

(/=) :: ForceFetch -> ForceFetch -> Bool #

Ord ForceFetch Source #

Instance details

Defined in NvFetcher.Types

Methods

compare :: ForceFetch -> ForceFetch -> Ordering #

(<) :: ForceFetch -> ForceFetch -> Bool #

(<=) :: ForceFetch -> ForceFetch -> Bool #

(>) :: ForceFetch -> ForceFetch -> Bool #

(>=) :: ForceFetch -> ForceFetch -> Bool #

max :: ForceFetch -> ForceFetch -> ForceFetch #

min :: ForceFetch -> ForceFetch -> ForceFetch #

Hashable ForceFetch Source #

Instance details

Defined in NvFetcher.Types

Methods

hashWithSalt :: Int -> ForceFetch -> Int #

hash :: ForceFetch -> Int #

Pretty ForceFetch Source #

Instance details

Defined in NvFetcher.Types

Methods

pretty :: ForceFetch -> Doc ann #

prettyList :: [ForceFetch] -> Doc ann #

type Rep ForceFetch Source #

Instance details

Defined in NvFetcher.Types

type Rep ForceFetch = D1 ('MetaData "ForceFetch" "NvFetcher.Types" "nvfetcher-0.7.0.0-AhFFh7reJc9KmNyxRtjlmD" 'False) (C1 ('MetaCons "ForceFetch" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoForceFetch" 'PrefixI 'False) (U1 :: Type -> Type))

data NixFetcher (k :: FetchStatus) Source #

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

Constructors

FetchGit
Fields _furl :: Text _rev :: Version _deepClone :: Bool _fetchSubmodules :: Bool _leaveDotGit :: Bool _sparseCheckout :: [Text] _name :: Maybe Text _sha256 :: FetchResult Checksum k
FetchGitHub
Fields _fowner :: Text _frepo :: Text _rev :: Version _deepClone :: Bool _fetchSubmodules :: Bool _leaveDotGit :: Bool _sparseCheckout :: [Text] _name :: Maybe Text _sha256 :: FetchResult Checksum k
FetchUrl
Fields _furl :: Text _name :: Maybe Text _sha256 :: FetchResult Checksum k
FetchTarball
Fields _furl :: Text _sha256 :: FetchResult Checksum k
FetchDocker
Fields _imageName :: Text _imageTag :: Text _imageDigest :: FetchResult ContainerDigest k _sha256 :: FetchResult Checksum k _fos :: Maybe Text _farch :: Maybe Text _finalImageName :: Maybe Text _finalImageTag :: Maybe Text _tlsVerify :: Maybe Bool