Hercules.CNix.Store

Opening a Store

newtype Store

Constructors

Store (Ptr (Ref NixStore))

openStore :: IO Store

releaseStore :: Store -> IO ()

withStore :: MonadUnliftIO m => (Store -> m a) -> m a

withStore' :: (Store -> IO r) -> IO r

withStoreFromURI :: MonadUnliftIO m => Text -> (Store -> m r) -> m r

Store properties

storeUri :: MonadIO m => Store -> m ByteString

storeDir :: MonadIO m => Store -> m ByteString

Usually "nixstore"

getStoreProtocolVersion :: Store -> IO Int

getClientProtocolVersion :: IO Int

Store paths

newtype StorePath

Store-agnostic store path representation: hash and name. Does not have a storedir or subpath inside the store path.

Constructors

StorePath (ForeignPtr NixStorePath)

Instances

Show StorePath

Defined in Hercules.CNix.Store

Methods

showsPrec :: Int -> StorePath -> ShowS

show :: StorePath -> String

showList :: [StorePath] -> ShowS

Eq StorePath

Defined in Hercules.CNix.Store

Methods

(==) :: StorePath -> StorePath -> Bool

(/=) :: StorePath -> StorePath -> Bool

Ord StorePath

Defined in Hercules.CNix.Store

Methods

compare :: StorePath -> StorePath -> Ordering

(<) :: StorePath -> StorePath -> Bool

(<=) :: StorePath -> StorePath -> Bool

(>) :: StorePath -> StorePath -> Bool

(>=) :: StorePath -> StorePath -> Bool

max :: StorePath -> StorePath -> StorePath

min :: StorePath -> StorePath -> StorePath

HasEncapsulation NixStorePath StorePath

Defined in Hercules.CNix.Store

Methods

moveToForeignPtrWrapper :: Ptr NixStorePath -> IO StorePath

parseStorePathBaseName :: ByteString -> IO StorePath

Create StorePath from hash and name.

Throws C++ BadStorePath exception when invalid.

parseStorePath :: Store -> ByteString -> IO StorePath

Parse a complete store path including storeDir into a StorePath.

Throws C++ BadStorePath exception when invalid.

followLinksToStorePath :: Store -> ByteString -> IO StorePath

Follow symlinks to the store and chop off the parts after the top-level store name

storePathToPath :: Store -> StorePath -> IO ByteString

getStorePathBaseName :: StorePath -> IO ByteString

getStorePathHash :: StorePath -> IO ByteString

Store objects

isValidPath :: Store -> StorePath -> IO Bool

Whether a path exists and is registered.

queryPathInfo

Arguments

:: Store

-> StorePath

Exact store path, not a subpath

-> IO (ForeignPtr (Ref ValidPathInfo))

ValidPathInfo or exception

queryPathInfoFromClientCache :: Store -> StorePath -> IO (Maybe (Maybe (ForeignPtr (Ref ValidPathInfo))))

Query only the local client cache ("narinfo cache") - does not query the actual store or daemon.

Returns Nothing if nothing is known about the path. Returns 'Just Nothing' if the path is known to not exist. Returns 'Just (Just vpi)' if the path is known to exist, with the given ValidPathInfo.

data ValidPathInfo

Instances

Finalizer (Ref ValidPathInfo)

Defined in Hercules.CNix.Store

Methods

finalizer :: FinalizerPtr (Ref ValidPathInfo)

validPathInfoNarSize :: ForeignPtr (Ref ValidPathInfo) -> Int64

The narSize field of a ValidPathInfo struct. Source: path-info.hh / store-api.hh

validPathInfoNarHash32 :: ForeignPtr (Ref ValidPathInfo) -> IO ByteString

Copy the narHash field of a ValidPathInfo struct. Source: path-info.hh / store-api.hh

validPathInfoDeriver :: Store -> ForeignPtr (Ref ValidPathInfo) -> IO (Maybe StorePath)

Deriver field of a ValidPathInfo struct. Source: store-api.hh

validPathInfoDeriver' :: ForeignPtr (Ref ValidPathInfo) -> IO (Maybe StorePath)

validPathInfoReferences :: Store -> ForeignPtr (Ref ValidPathInfo) -> IO [StorePath]

References field of a ValidPathInfo struct. Source: store-api.hh

validPathInfoReferences' :: ForeignPtr (Ref ValidPathInfo) -> IO [StorePath]

computeFSClosure :: Store -> ClosureParams -> StdSet NixStorePath -> IO (StdSet NixStorePath)

data ClosureParams

Constructors

ClosureParams

Fields

• flipDirection :: Bool
• includeOutputs :: Bool
• includeDerivers :: Bool

defaultClosureParams :: ClosureParams

Realisation

ensurePath :: Store -> StorePath -> IO ()

buildPaths :: Store -> StdVector NixStorePathWithOutputs -> IO ()

buildPath :: Store -> StorePathWithOutputs -> IO ()

Garbage collection

addTemporaryRoot :: Store -> StorePath -> IO ()

In-memory cache control

clearPathInfoCache :: Store -> IO ()

clearSubstituterCaches :: IO ()

Derivation references

newtype StorePathWithOutputs

Constructors

StorePathWithOutputs (ForeignPtr NixStorePathWithOutputs)

Instances

HasEncapsulation NixStorePathWithOutputs StorePathWithOutputs

Defined in Hercules.CNix.Store

Methods

moveToForeignPtrWrapper :: Ptr NixStorePathWithOutputs -> IO StorePathWithOutputs

newStorePathWithOutputs :: StorePath -> [ByteString] -> IO StorePathWithOutputs

getStorePath :: StorePathWithOutputs -> IO StorePath

getOutputs :: StorePathWithOutputs -> IO [ByteString]

Derivations

newtype Derivation

Constructors

Derivation (ForeignPtr Derivation)

Instances

HasEncapsulation Derivation Derivation

Defined in Hercules.CNix.Store

Methods

moveToForeignPtrWrapper :: Ptr Derivation0 -> IO Derivation

getDerivation :: Store -> StorePath -> IO Derivation

getDerivationFromString

Arguments

:: Store

-> ByteString

Derivation name (store path name with ".drv" extension removed)

-> ByteString

Contents

-> IO Derivation

getDerivationNameFromPath :: StorePath -> IO ByteString

getDerivationPlatform :: Derivation -> IO ByteString

getDerivationBuilder :: Derivation -> IO ByteString

getDerivationArguments :: Derivation -> IO [ByteString]

getDerivationEnv :: Derivation -> IO (Map ByteString ByteString)

getDerivationSources :: Store -> Derivation -> IO [StorePath]

getDerivationSources' :: Derivation -> IO [StorePath]

getDerivationInputs :: Store -> Derivation -> IO [(StorePath, [ByteString])]

getDerivationInputs' :: Derivation -> IO [(StorePath, [ByteString])]

Get the inputs of a derivation, ignoring dependencies on outputs of outputs (RFC 92 inputs).

getDerivationOutputNames :: ForeignPtr Derivation -> IO [ByteString]

data DerivationOutput

Constructors

DerivationOutput

Fields

• derivationOutputName :: !ByteString
• derivationOutputPath :: !(Maybe StorePath)
• derivationOutputDetail :: !DerivationOutputDetail

Instances

Show DerivationOutput

Defined in Hercules.CNix.Store

Methods

showsPrec :: Int -> DerivationOutput -> ShowS

show :: DerivationOutput -> String

showList :: [DerivationOutput] -> ShowS

Eq DerivationOutput

Defined in Hercules.CNix.Store

Methods

(==) :: DerivationOutput -> DerivationOutput -> Bool

(/=) :: DerivationOutput -> DerivationOutput -> Bool

data DerivationOutputDetail

Constructors

DerivationOutputInputAddressed StorePath

DerivationOutputCAFixed FixedOutputHash StorePath

DerivationOutputCAFloating FileIngestionMethod HashType

DerivationOutputDeferred

Instances

Show DerivationOutputDetail

Defined in Hercules.CNix.Store

Methods

showsPrec :: Int -> DerivationOutputDetail -> ShowS

show :: DerivationOutputDetail -> String

showList :: [DerivationOutputDetail] -> ShowS

Eq DerivationOutputDetail

Defined in Hercules.CNix.Store

Methods

(==) :: DerivationOutputDetail -> DerivationOutputDetail -> Bool

(/=) :: DerivationOutputDetail -> DerivationOutputDetail -> Bool

data FixedOutputHash

Constructors

FixedOutputHash !FileIngestionMethod !Hash

Instances

Show FixedOutputHash

Defined in Hercules.CNix.Store

Methods

showsPrec :: Int -> FixedOutputHash -> ShowS

show :: FixedOutputHash -> String

showList :: [FixedOutputHash] -> ShowS

Eq FixedOutputHash

Defined in Hercules.CNix.Store

Methods

(==) :: FixedOutputHash -> FixedOutputHash -> Bool

(/=) :: FixedOutputHash -> FixedOutputHash -> Bool

data FileIngestionMethod

See content-address.hh

Constructors

Flat

Recursive

Instances

Show FileIngestionMethod

Defined in Hercules.CNix.Store

Methods

showsPrec :: Int -> FileIngestionMethod -> ShowS

show :: FileIngestionMethod -> String

showList :: [FileIngestionMethod] -> ShowS

Eq FileIngestionMethod

Defined in Hercules.CNix.Store

Methods

(==) :: FileIngestionMethod -> FileIngestionMethod -> Bool

(/=) :: FileIngestionMethod -> FileIngestionMethod -> Bool

getDerivationOutputs :: Store -> ByteString -> Derivation -> IO [DerivationOutput]

Copying

copyClosure :: Store -> Store -> [StorePath] -> IO ()

Signing

data SecretKey

Instances

Finalizer SecretKey

Defined in Hercules.CNix.Store

Methods

finalizer :: FinalizerPtr SecretKey

parseSecretKey :: ByteString -> IO (ForeignPtr SecretKey)

signPath

Arguments

:: Store

-> Ptr SecretKey

Secret signing key

-> StorePath

Store path

-> IO Bool

False if the signature was already present, True if the signature was added

Hashes

data Hash

See hash.hh

Constructors

Hash !HashType !ShortByteString

Instances

Show Hash

Defined in Hercules.CNix.Store

Methods

showsPrec :: Int -> Hash -> ShowS

show :: Hash -> String

showList :: [Hash] -> ShowS

Eq Hash

Defined in Hercules.CNix.Store

Methods

(==) :: Hash -> Hash -> Bool

(/=) :: Hash -> Hash -> Bool

data HashType

See hash.hh

Constructors

MD5

SHA1

SHA256

SHA512

Instances

Show HashType

Defined in Hercules.CNix.Store

Methods

showsPrec :: Int -> HashType -> ShowS

show :: HashType -> String

showList :: [HashType] -> ShowS

Eq HashType

Defined in Hercules.CNix.Store

Methods

(==) :: HashType -> HashType -> Bool

(/=) :: HashType -> HashType -> Bool

Utilities

data Strings

A Nix Strings aka std::liststd::string

Instances

Delete Strings

Defined in Hercules.CNix.Store

Methods

delete :: Ptr Strings -> IO ()

Finalizer Strings

Defined in Hercules.CNix.Store

Methods

finalizer :: FinalizerPtr Strings

withStrings :: (Ptr Strings -> IO a) -> IO a

withStringsOf :: [ByteString] -> (Ptr Strings -> IO a) -> IO a

pushString :: Ptr Strings -> ByteString -> IO ()

getStringsLength :: Ptr Strings -> IO CSize

toByteStrings :: Ptr Strings -> IO [ByteString]

toByteStringMap :: Ptr StringPairs -> IO (Map ByteString ByteString)

Deprecated

forNonNull :: Ptr a -> (Ptr a -> IO b) -> IO (Maybe b)

Deprecated: Use forNonNull instead

traverseNonNull :: (Ptr a -> IO b) -> Ptr a -> IO (Maybe b)

Deprecated: Use traverseNonNull instead

deleteDerivationInputsIterator :: Ptr DerivationInputsIterator -> IO ()

Deprecated: Use delete instead

deleteDerivationOutputsIterator :: Ptr DerivationOutputsIterator -> IO ()

Deprecated: Use delete instead

deleteStringPairs :: Ptr StringPairs -> IO ()

Deprecated: Use delete instead

deleteStrings :: Ptr Strings -> IO ()

Deprecated: Use delete instead

finalizeDerivation :: FinalizerPtr Derivation

Deprecated: Use finalizer instead

finalizeRefValidPathInfo :: FinalizerPtr (Ref ValidPathInfo)

Deprecated: Use finalizer instead

finalizeSecretKey :: FinalizerPtr SecretKey

Deprecated: Use finalizer instead

finalizeStorePath :: FinalizerPtr NixStorePath

Deprecated: Use finalizer instead

finalizeStorePathWithOutputs :: FinalizerPtr NixStorePathWithOutputs

Deprecated: Use finalizer instead

finalizeStrings :: FinalizerPtr Strings

Deprecated: Use finalizer instead

moveStorePath :: Ptr NixStorePath -> IO StorePath

Deprecated: Use moveToForeignPtrWrapper instead

Move ownership of a Ptr NixStorePath into StorePath

moveStorePathMaybe :: Ptr NixStorePath -> IO (Maybe StorePath)

Deprecated: Use nullableMoveToForeignPtrWrapper instead

Move ownership of a Ptr NixStorePath into StorePath

unsafeMallocBS :: MonadIO m => IO CString -> m ByteString

Deprecated: Use unsafePackMallocCString

withPtr' :: Coercible a' (ForeignPtr a) => a' -> (Ptr a -> IO b) -> IO b

Deprecated: Use HasEncapsulation instead

data DerivationInputsIterator

Instances

Delete DerivationInputsIterator

Defined in Hercules.CNix.Store

Methods

delete :: Ptr DerivationInputsIterator -> IO ()

data DerivationOutputsIterator

Instances

Delete DerivationOutputsIterator

Defined in Hercules.CNix.Store

Methods

delete :: Ptr DerivationOutputsIterator -> IO ()

data NixStore

Instances

Delete (Ref NixStore)

Defined in Hercules.CNix.Store

Methods

delete :: Ptr (Ref NixStore) -> IO ()

data NixStorePath

Instances

Finalizer NixStorePath

Defined in Hercules.CNix.Store

Methods

finalizer :: FinalizerPtr NixStorePath

HasEncapsulation NixStorePath StorePath

Defined in Hercules.CNix.Store

Methods

moveToForeignPtrWrapper :: Ptr NixStorePath -> IO StorePath

data Ref a

A Nix ref, to be used in phantom types.

Instances

Delete (Ref NixStore)

Defined in Hercules.CNix.Store

Methods

delete :: Ptr (Ref NixStore) -> IO ()

Finalizer (Ref ValidPathInfo)

Defined in Hercules.CNix.Store

Methods

finalizer :: FinalizerPtr (Ref ValidPathInfo)

data StringPairs

Instances

Delete StringPairs

Defined in Hercules.CNix.Store

Methods

delete :: Ptr StringPairs -> IO ()

Re-exports

context :: Context

Orphan instances

Delete DerivationInputsIterator

Methods

delete :: Ptr DerivationInputsIterator -> IO ()

Delete DerivationOutputsIterator

Methods

delete :: Ptr DerivationOutputsIterator -> IO ()

Delete StringPairs

Methods

delete :: Ptr StringPairs -> IO ()

Delete StringPairsIterator

Methods

delete :: Ptr StringPairsIterator -> IO ()

Delete Strings

Methods

delete :: Ptr Strings -> IO ()

Finalizer Derivation

Methods

finalizer :: FinalizerPtr Derivation

Finalizer NixStorePath

Methods

finalizer :: FinalizerPtr NixStorePath

Finalizer NixStorePathWithOutputs

Methods

finalizer :: FinalizerPtr NixStorePathWithOutputs

Finalizer SecretKey

Methods

finalizer :: FinalizerPtr SecretKey

Finalizer Strings

Methods

finalizer :: FinalizerPtr Strings

Delete (Ref NixStore)

Methods

delete :: Ptr (Ref NixStore) -> IO ()

Finalizer (Ref ValidPathInfo)

Methods

finalizer :: FinalizerPtr (Ref ValidPathInfo)