Maintainer	Shea Levy <shea@shealevy.com>
Safe Haskell	None
Language	Haskell2010

System.Nix.Store

Description

Synopsis

data PathName
pathNameContents :: PathName -> Text
pathName :: Text -> Maybe PathName
type PathHashAlgo = Truncated 20 SHA256
data Path = Path !(Digest PathHashAlgo) !PathName
data StoreEffects rootedPath validPath m = StoreEffects {
- fromRootedPath :: !(rootedPath -> Path)
- fromValidPath :: !(validPath -> rootedPath)
- validPaths :: !(HashSet rootedPath -> m (HashSet validPath))
- referrers :: !(validPath -> m (HashSet Path))
- rootedPath :: !(Path -> m rootedPath)
- substitutablePathInfos :: !(HashSet Path -> m (HashMap Path SubstitutablePathInfo))
- validDerivers :: !(Path -> m (HashSet Path))
- derivationOutputs :: !(validPath -> m (HashSet Path))
- derivationOutputNames :: !(validPath -> m (HashSet Text))
- pathFromHashPart :: !(Digest PathHashAlgo -> m Path)
- addFile :: !(ByteString -> m validPath)
}
data SubstitutablePathInfo = SubstitutablePathInfo {
- deriver :: !(Maybe Path)
- references :: !PathSet
- downloadSize :: !Integer
- narSize :: !Integer
}

Documentation

data PathName Source #

The name portion of a Nix path.

Must be composed of a-z, A-Z, 0-9, +, -, ., _, ?, and =, can't start with a ., and must have at least one character.

Instances

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

pathNameContents :: PathName -> Text Source #

The contents of the path name

pathName :: Text -> Maybe PathName Source #

Construct a PathName, assuming the provided contents are valid.

type PathHashAlgo = Truncated 20 SHA256 Source #

The hash algorithm used for store path hashes.

data Path Source #

A path in a store.

Constructors

Path !(Digest PathHashAlgo) !PathName

Instances

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

data StoreEffects rootedPath validPath m Source #

Interactions with the Nix store.

rootedPath: A path plus a witness to the fact that the path is reachable from a root whose liftime is at least as long as the rootedPath reference itself, when the implementation supports this.

validPath: A rootedPath plus a witness to the fact that the path is valid. On implementations that support temporary roots, this implies that the path will remain valid so long as the reference is held.

m: The monad the effects operate in.

Constructors

StoreEffects

Fields

fromRootedPath :: !(rootedPath -> Path)
Project out the underlying Path from a rootedPath
fromValidPath :: !(validPath -> rootedPath)
Project out the underlying rootedPath from a validPath
validPaths :: !(HashSet rootedPath -> m (HashSet validPath))
Which of the given paths are valid?
referrers :: !(validPath -> m (HashSet Path))
Get the paths that refer to a given path.
rootedPath :: !(Path -> m rootedPath)
Get a root to the Path.
substitutablePathInfos :: !(HashSet Path -> m (HashMap Path SubstitutablePathInfo))
Get information about substituters of a set of Paths
validDerivers :: !(Path -> m (HashSet Path))
Get the currently valid derivers of a Path.
derivationOutputs :: !(validPath -> m (HashSet Path))
Get the outputs of the derivation at a Path.
derivationOutputNames :: !(validPath -> m (HashSet Text))
Get the output names of the derivation at a Path.
pathFromHashPart :: !(Digest PathHashAlgo -> m Path)
Get a full Path corresponding to a given Digest.
addFile :: !(ByteString -> m validPath)
Add a non-nar file to the store

data SubstitutablePathInfo Source #

Information about substitutes for a Path.

Constructors

SubstitutablePathInfo
Fields deriver :: !(Maybe Path) The .drv which led to this `Path`. references :: !PathSet The references of the `Path` downloadSize :: !Integer The (likely compressed) size of the download of this `Path`. narSize :: !Integer The size of the uncompressed NAR serialization of this `Path`.

Instances

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