Safe Haskell	None
Language	Haskell2010

Nix.Thunk

Synopsis

data ThunkSource
- = ThunkSource_GitHub GitHubSource
- | ThunkSource_Git GitSource
data GitHubSource = GitHubSource {
- _gitHubSource_owner :: Name Owner
- _gitHubSource_repo :: Name Repo
- _gitHubSource_branch :: Maybe (Name Branch)
- _gitHubSource_private :: Bool
}
data ThunkRev = ThunkRev {
- _thunkRev_commit :: Ref SHA1
- _thunkRev_nixSha256 :: NixSha256
}
getLatestRev :: MonadNixThunk m => ThunkSource -> m ThunkRev
gitCloneForThunkUnpack :: MonadNixThunk m => GitSource -> Ref hash -> FilePath -> m ()
thunkSourceToGitSource :: ThunkSource -> GitSource
data ThunkPtr = ThunkPtr {
- _thunkPtr_rev :: ThunkRev
- _thunkPtr_source :: ThunkSource
}
data ThunkData
- = ThunkData_Packed ThunkSpec ThunkPtr
- | ThunkData_Checkout
readThunk :: MonadNixThunk m => FilePath -> m (Either ReadThunkError ThunkData)
data CheckClean
- = CheckClean_FullCheck
- | CheckClean_NotIgnored
- | CheckClean_NoCheck
getThunkPtr :: forall m. MonadNixThunk m => CheckClean -> FilePath -> Maybe Bool -> m ThunkPtr
packThunk :: MonadNixThunk m => ThunkPackConfig -> FilePath -> m ThunkPtr
createThunk :: MonadNixThunk m => FilePath -> Either ThunkSpec ThunkPtr -> m ()
data ThunkPackConfig = ThunkPackConfig {
- _thunkPackConfig_force :: Bool
- _thunkPackConfig_config :: ThunkConfig
}
newtype ThunkConfig = ThunkConfig {
- _thunkConfig_private :: Maybe Bool
}
updateThunkToLatest :: MonadNixThunk m => ThunkUpdateConfig -> FilePath -> m ()
data ThunkUpdateConfig = ThunkUpdateConfig {
- _thunkUpdateConfig_branch :: Maybe String
- _thunkUpdateConfig_config :: ThunkConfig
}
unpackThunk :: MonadNixThunk m => FilePath -> m ()
data ThunkSpec = ThunkSpec {
- _thunkSpec_name :: !Text
- _thunkSpec_files :: !(Map FilePath ThunkFileSpec)
}
data ThunkFileSpec
- = ThunkFileSpec_Ptr (ByteString -> Either String ThunkPtr)
- | ThunkFileSpec_FileMatches Text
- | ThunkFileSpec_CheckoutIndicator
- | ThunkFileSpec_AttrCache
data NixThunkError
nixBuildAttrWithCache :: (MonadLog Output m, HasCliConfig m, MonadIO m, MonadMask m, MonadError NixThunkError m, MonadFail m) => FilePath -> String -> m FilePath
attrCacheFileName :: FilePath
prettyNixThunkError :: NixThunkError -> Text

Documentation

data ThunkSource Source #

A location from which a thunk's data can be retrieved

Constructors

ThunkSource_GitHub GitHubSource	A source specialized for GitHub
ThunkSource_Git GitSource	A plain repo source

Instances

Eq ThunkSource Source #
Instance details Defined in Nix.Thunk Methods (==) :: ThunkSource -> ThunkSource -> Bool # (/=) :: ThunkSource -> ThunkSource -> Bool #
Ord ThunkSource Source #
Instance details Defined in Nix.Thunk Methods compare :: ThunkSource -> ThunkSource -> Ordering # (<) :: ThunkSource -> ThunkSource -> Bool # (<=) :: ThunkSource -> ThunkSource -> Bool # (>) :: ThunkSource -> ThunkSource -> Bool # (>=) :: ThunkSource -> ThunkSource -> Bool # max :: ThunkSource -> ThunkSource -> ThunkSource # min :: ThunkSource -> ThunkSource -> ThunkSource #
Show ThunkSource Source #
Instance details Defined in Nix.Thunk Methods showsPrec :: Int -> ThunkSource -> ShowS # show :: ThunkSource -> String # showList :: [ThunkSource] -> ShowS #

data GitHubSource Source #

Constructors

GitHubSource
Fields _gitHubSource_owner :: Name Owner _gitHubSource_repo :: Name Repo _gitHubSource_branch :: Maybe (Name Branch) _gitHubSource_private :: Bool

Instances

Eq GitHubSource Source #
Instance details Defined in Nix.Thunk Methods (==) :: GitHubSource -> GitHubSource -> Bool # (/=) :: GitHubSource -> GitHubSource -> Bool #
Ord GitHubSource Source #
Instance details Defined in Nix.Thunk Methods compare :: GitHubSource -> GitHubSource -> Ordering # (<) :: GitHubSource -> GitHubSource -> Bool # (<=) :: GitHubSource -> GitHubSource -> Bool # (>) :: GitHubSource -> GitHubSource -> Bool # (>=) :: GitHubSource -> GitHubSource -> Bool # max :: GitHubSource -> GitHubSource -> GitHubSource # min :: GitHubSource -> GitHubSource -> GitHubSource #
Show GitHubSource Source #
Instance details Defined in Nix.Thunk Methods showsPrec :: Int -> GitHubSource -> ShowS # show :: GitHubSource -> String # showList :: [GitHubSource] -> ShowS #

data ThunkRev Source #

A specific revision of data; it may be available from multiple sources

Constructors

ThunkRev
Fields _thunkRev_commit :: Ref SHA1 _thunkRev_nixSha256 :: NixSha256

Instances

Eq ThunkRev Source #
Instance details Defined in Nix.Thunk Methods (==) :: ThunkRev -> ThunkRev -> Bool # (/=) :: ThunkRev -> ThunkRev -> Bool #
Ord ThunkRev Source #
Instance details Defined in Nix.Thunk Methods compare :: ThunkRev -> ThunkRev -> Ordering # (<) :: ThunkRev -> ThunkRev -> Bool # (<=) :: ThunkRev -> ThunkRev -> Bool # (>) :: ThunkRev -> ThunkRev -> Bool # (>=) :: ThunkRev -> ThunkRev -> Bool # max :: ThunkRev -> ThunkRev -> ThunkRev # min :: ThunkRev -> ThunkRev -> ThunkRev #
Show ThunkRev Source #
Instance details Defined in Nix.Thunk Methods showsPrec :: Int -> ThunkRev -> ShowS # show :: ThunkRev -> String # showList :: [ThunkRev] -> ShowS #

getLatestRev :: MonadNixThunk m => ThunkSource -> m ThunkRev Source #

Get the latest revision available from the given source

gitCloneForThunkUnpack Source #

Arguments

:: MonadNixThunk m
=> GitSource	Git source to use
-> Ref hash	Commit hash to reset to
-> FilePath	Directory to clone into
-> m ()

thunkSourceToGitSource :: ThunkSource -> GitSource Source #

data ThunkPtr Source #

A reference to the exact data that a thunk should translate into

Constructors

ThunkPtr
Fields _thunkPtr_rev :: ThunkRev _thunkPtr_source :: ThunkSource

Instances

Eq ThunkPtr Source #
Instance details Defined in Nix.Thunk Methods (==) :: ThunkPtr -> ThunkPtr -> Bool # (/=) :: ThunkPtr -> ThunkPtr -> Bool #
Ord ThunkPtr Source #
Instance details Defined in Nix.Thunk Methods compare :: ThunkPtr -> ThunkPtr -> Ordering # (<) :: ThunkPtr -> ThunkPtr -> Bool # (<=) :: ThunkPtr -> ThunkPtr -> Bool # (>) :: ThunkPtr -> ThunkPtr -> Bool # (>=) :: ThunkPtr -> ThunkPtr -> Bool # max :: ThunkPtr -> ThunkPtr -> ThunkPtr # min :: ThunkPtr -> ThunkPtr -> ThunkPtr #
Show ThunkPtr Source #
Instance details Defined in Nix.Thunk Methods showsPrec :: Int -> ThunkPtr -> ShowS # show :: ThunkPtr -> String # showList :: [ThunkPtr] -> ShowS #

data ThunkData Source #

Constructors

ThunkData_Packed ThunkSpec ThunkPtr	Packed thunk
ThunkData_Checkout	Checked out thunk that was unpacked from this pointer

readThunk :: MonadNixThunk m => FilePath -> m (Either ReadThunkError ThunkData) Source #

Read a thunk and validate that it is exactly a packed thunk. If additional data is present, fail.

data CheckClean Source #

Constructors

CheckClean_FullCheck	Check that the repo is clean, including .gitignored files
CheckClean_NotIgnored	Check that the repo is clean, not including .gitignored files
CheckClean_NoCheck	Don't check that the repo is clean

getThunkPtr :: forall m. MonadNixThunk m => CheckClean -> FilePath -> Maybe Bool -> m ThunkPtr Source #

packThunk :: MonadNixThunk m => ThunkPackConfig -> FilePath -> m ThunkPtr Source #

createThunk :: MonadNixThunk m => FilePath -> Either ThunkSpec ThunkPtr -> m () Source #

data ThunkPackConfig Source #

Constructors

ThunkPackConfig
Fields _thunkPackConfig_force :: Bool _thunkPackConfig_config :: ThunkConfig

Instances

Show ThunkPackConfig Source #
Instance details Defined in Nix.Thunk Methods showsPrec :: Int -> ThunkPackConfig -> ShowS # show :: ThunkPackConfig -> String # showList :: [ThunkPackConfig] -> ShowS #

newtype ThunkConfig Source #

Constructors

ThunkConfig
Fields _thunkConfig_private :: Maybe Bool

Instances

Show ThunkConfig Source #
Instance details Defined in Nix.Thunk Methods showsPrec :: Int -> ThunkConfig -> ShowS # show :: ThunkConfig -> String # showList :: [ThunkConfig] -> ShowS #

updateThunkToLatest :: MonadNixThunk m => ThunkUpdateConfig -> FilePath -> m () Source #

data ThunkUpdateConfig Source #

Constructors

ThunkUpdateConfig
Fields _thunkUpdateConfig_branch :: Maybe String _thunkUpdateConfig_config :: ThunkConfig

Instances

Show ThunkUpdateConfig Source #
Instance details Defined in Nix.Thunk Methods showsPrec :: Int -> ThunkUpdateConfig -> ShowS # show :: ThunkUpdateConfig -> String # showList :: [ThunkUpdateConfig] -> ShowS #

unpackThunk :: MonadNixThunk m => FilePath -> m () Source #

data ThunkSpec Source #

Specification for how a set of files in a thunk version work.

Constructors

ThunkSpec
Fields _thunkSpec_name :: !Text _thunkSpec_files :: !(Map FilePath ThunkFileSpec)

data ThunkFileSpec Source #

Specification for how a file in a thunk version works.

Constructors

ThunkFileSpec_Ptr (ByteString -> Either String ThunkPtr)	This file specifies `ThunkPtr` data
ThunkFileSpec_FileMatches Text	This file must match the given content exactly
ThunkFileSpec_CheckoutIndicator	Existence of this directory indicates that the thunk is unpacked
ThunkFileSpec_AttrCache	This directory is an attribute cache

data NixThunkError Source #

Instances

AsProcessFailure NixThunkError Source #
Instance details Defined in Nix.Thunk Methods asProcessFailure :: Prism' NixThunkError ProcessFailure #
AsUnstructuredError NixThunkError Source #
Instance details Defined in Nix.Thunk Methods asUnstructuredError :: Prism' NixThunkError Text #

nixBuildAttrWithCache Source #

Arguments

:: (MonadLog Output m, HasCliConfig m, MonadIO m, MonadMask m, MonadError NixThunkError m, MonadFail m)
=> FilePath	Path to directory containing Thunk
-> String	Attribute to build
-> m FilePath	Symlink to cached or built nix output

Build a nix attribute, and cache the result if possible

attrCacheFileName :: FilePath Source #

prettyNixThunkError :: NixThunkError -> Text Source #