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 :: MonadNixThunk m => CheckClean -> FilePath -> Maybe Bool -> m (ThunkPtr, Bool)
packThunk :: MonadNixThunk m => ThunkPackConfig -> FilePath -> m ThunkPtr
createThunk :: MonadNixThunk m => FilePath -> Either ThunkSpec ThunkPtr -> m ()
createThunk' :: MonadNixThunk m => ThunkCreateConfig -> m ()
createWorktree :: MonadNixThunk m => FilePath -> FilePath -> CreateWorktreeConfig -> m ()
data CreateWorktreeConfig = CreateWorktreeConfig {
- _createWorktreeConfig_branch :: Maybe String
- _createWorktreeConfig_detach :: Bool
}
data ThunkPackConfig = ThunkPackConfig {
- _thunkPackConfig_force :: Bool
- _thunkPackConfig_config :: ThunkConfig
}
newtype ThunkConfig = ThunkConfig {
- _thunkConfig_private :: Maybe Bool
}
updateThunkToLatest :: MonadNixThunk m => ThunkUpdateConfig -> FilePath -> m ()
updateThunk :: MonadNixThunk m => FilePath -> (FilePath -> m a) -> m a
data ThunkUpdateConfig = ThunkUpdateConfig {
- _thunkUpdateConfig_branch :: Maybe Text
- _thunkUpdateConfig_ref :: Maybe Text
- _thunkUpdateConfig_thunk :: 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 NixThunkError m, MonadIO m, MonadMask m, MonadError NixThunkError m, MonadFail m) => FilePath -> String -> m FilePath
attrCacheFileName :: FilePath
prettyNixThunkError :: NixThunkError -> Text
data ThunkCreateSource
- = ThunkCreateSource_Absolute GitUri
- | ThunkCreateSource_Relative FilePath
data ThunkCreateConfig = ThunkCreateConfig {
- _thunkCreateConfig_uri :: ThunkCreateSource
- _thunkCreateConfig_branch :: Maybe (Name Branch)
- _thunkCreateConfig_rev :: Maybe (Ref SHA1)
- _thunkCreateConfig_config :: ThunkConfig
- _thunkCreateConfig_destination :: Maybe FilePath
}
parseGitUri :: Text -> Maybe GitUri
newtype GitUri = GitUri {
- unGitUri :: URI
}
uriThunkPtr :: MonadNixThunk m => GitUri -> Maybe Bool -> Maybe Text -> Maybe Text -> m ThunkPtr
newtype Ref hash = Ref {
- unRef :: Digest hash
}
refFromHexString :: HashAlgorithm hash => String -> Ref hash

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

Instances details

Show ThunkSource Source #
Instance details Defined in Nix.Thunk.Internal Methods showsPrec :: Int -> ThunkSource -> ShowS # show :: ThunkSource -> String # showList :: [ThunkSource] -> ShowS #
Eq ThunkSource Source #
Instance details Defined in Nix.Thunk.Internal Methods (==) :: ThunkSource -> ThunkSource -> Bool # (/=) :: ThunkSource -> ThunkSource -> Bool #
Ord ThunkSource Source #
Instance details Defined in Nix.Thunk.Internal 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 #

data GitHubSource Source #

Constructors

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

Instances

Instances details

Show GitHubSource Source #
Instance details Defined in Nix.Thunk.Internal Methods showsPrec :: Int -> GitHubSource -> ShowS # show :: GitHubSource -> String # showList :: [GitHubSource] -> ShowS #
Eq GitHubSource Source #
Instance details Defined in Nix.Thunk.Internal Methods (==) :: GitHubSource -> GitHubSource -> Bool # (/=) :: GitHubSource -> GitHubSource -> Bool #
Ord GitHubSource Source #
Instance details Defined in Nix.Thunk.Internal 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 #

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

Instances details

Show ThunkRev Source #
Instance details Defined in Nix.Thunk.Internal Methods showsPrec :: Int -> ThunkRev -> ShowS # show :: ThunkRev -> String # showList :: [ThunkRev] -> ShowS #
Eq ThunkRev Source #
Instance details Defined in Nix.Thunk.Internal Methods (==) :: ThunkRev -> ThunkRev -> Bool # (/=) :: ThunkRev -> ThunkRev -> Bool #
Ord ThunkRev Source #
Instance details Defined in Nix.Thunk.Internal 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 #

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

Instances details

Show ThunkPtr Source #
Instance details Defined in Nix.Thunk.Internal Methods showsPrec :: Int -> ThunkPtr -> ShowS # show :: ThunkPtr -> String # showList :: [ThunkPtr] -> ShowS #
Eq ThunkPtr Source #
Instance details Defined in Nix.Thunk.Internal Methods (==) :: ThunkPtr -> ThunkPtr -> Bool # (/=) :: ThunkPtr -> ThunkPtr -> Bool #
Ord ThunkPtr Source #
Instance details Defined in Nix.Thunk.Internal 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 #

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 packed or unpacked thunk based on predefined thunk specifications.

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 :: MonadNixThunk m => CheckClean -> FilePath -> Maybe Bool -> m (ThunkPtr, Bool) Source #

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

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

createThunk' :: MonadNixThunk m => ThunkCreateConfig -> m () Source #

createWorktree :: MonadNixThunk m => FilePath -> FilePath -> CreateWorktreeConfig -> m () Source #

data CreateWorktreeConfig Source #

Constructors

CreateWorktreeConfig
Fields _createWorktreeConfig_branch :: Maybe String _createWorktreeConfig_detach :: Bool

Instances

Instances details

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

data ThunkPackConfig Source #

Constructors

ThunkPackConfig
Fields _thunkPackConfig_force :: Bool _thunkPackConfig_config :: ThunkConfig

Instances

Instances details

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

newtype ThunkConfig Source #

Constructors

ThunkConfig
Fields _thunkConfig_private :: Maybe Bool

Instances

Instances details

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

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

updateThunk :: MonadNixThunk m => FilePath -> (FilePath -> m a) -> m a Source #

Safely update thunk using a custom action

A temporary working space is used to do any update. When the custom action successfully completes, the resulting (packed) thunk is copied back to the original location.

data ThunkUpdateConfig Source #

Constructors

ThunkUpdateConfig
Fields _thunkUpdateConfig_branch :: Maybe Text _thunkUpdateConfig_ref :: Maybe Text _thunkUpdateConfig_thunk :: ThunkConfig

Instances

Instances details

Show ThunkUpdateConfig Source #
Instance details Defined in Nix.Thunk.Internal 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

Instances details

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

nixBuildAttrWithCache Source #

Arguments

:: (MonadLog Output m, HasCliConfig NixThunkError 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 #

data ThunkCreateSource Source #

The source to be used for creating thunks.

Constructors

ThunkCreateSource_Absolute GitUri	Create a thunk from an absolute reference to a Git repository: URIs like `file://`, `https://`, `ssh://` etc.
ThunkCreateSource_Relative FilePath	Create a thunk from a local folder. If the folder exists, then it is made absolute using the current working directory and treated as a `file://` URL.

Instances

Instances details

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

data ThunkCreateConfig Source #

Constructors

ThunkCreateConfig
Fields _thunkCreateConfig_uri :: ThunkCreateSource _thunkCreateConfig_branch :: Maybe (Name Branch) _thunkCreateConfig_rev :: Maybe (Ref SHA1) _thunkCreateConfig_config :: ThunkConfig _thunkCreateConfig_destination :: Maybe FilePath

Instances

Instances details

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

parseGitUri :: Text -> Maybe GitUri Source #

newtype GitUri Source #

Constructors

GitUri
Fields unGitUri :: URI

Instances

Instances details

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

uriThunkPtr :: MonadNixThunk m => GitUri -> Maybe Bool -> Maybe Text -> Maybe Text -> m ThunkPtr Source #

Convert a URI to a thunk

If the URL is a github URL, we try to just download an archive for performance. If that doesn't work (e.g. authentication issue), we fall back on just doing things the normal way for git repos in general, and save it as a regular git thunk.

newtype Ref hash Source #

Represent a git reference (SHA1)

Constructors

Ref
Fields unRef :: Digest hash

Instances

Instances details

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

refFromHexString :: HashAlgorithm hash => String -> Ref hash Source #