| Safe Haskell | Safe-Inferred |
|---|---|
| Language | GHC2021 |
Futhark.Pkg.Info
Contents
Description
Obtaining information about packages over THE INTERNET!
Synopsis
- data PkgInfo m = PkgInfo {
- pkgVersions :: Map SemVer (PkgRevInfo m)
- pkgLookupCommit :: Maybe Text -> m (PkgRevInfo m)
- lookupPkgRev :: SemVer -> PkgInfo m -> Maybe (PkgRevInfo m)
- pkgInfo :: (MonadIO m, MonadLogger m, MonadFail m) => CacheDir -> PkgPath -> m (PkgInfo m)
- data PkgRevInfo m = PkgRevInfo {
- pkgGetFiles :: GetFiles m
- pkgRevCommit :: Text
- pkgRevGetManifest :: GetManifest m
- pkgRevTime :: UTCTime
- data GetManifest m
- data GetFiles m
- newtype CacheDir = CacheDir FilePath
- data PkgRegistry m
- class (MonadIO m, MonadLogger m, MonadFail m) => MonadPkgRegistry m where
- getPkgRegistry :: m (PkgRegistry m)
- putPkgRegistry :: PkgRegistry m -> m ()
- modifyPkgRegistry :: (PkgRegistry m -> PkgRegistry m) -> m ()
- lookupPackage :: MonadPkgRegistry m => CacheDir -> PkgPath -> m (PkgInfo m)
- lookupPackageRev :: MonadPkgRegistry m => CacheDir -> PkgPath -> SemVer -> m (PkgRevInfo m)
- lookupNewestRev :: MonadPkgRegistry m => CacheDir -> PkgPath -> m SemVer
Package info
Information about a package. The name of the package is stored separately.
Constructors
| PkgInfo | |
Fields
| |
lookupPkgRev :: SemVer -> PkgInfo m -> Maybe (PkgRevInfo m) Source #
Lookup information about a given version of a package.
pkgInfo :: (MonadIO m, MonadLogger m, MonadFail m) => CacheDir -> PkgPath -> m (PkgInfo m) Source #
Retrieve information about a package based on its package path.
This uses Semantic Import Versioning when interacting with
repositories. For example, a package github.comuserrepo will
match version 0.* or 1.* tags only, a package
github.comuserrepo/v2 will match 2.* tags, and so forth..
data PkgRevInfo m Source #
Information about a version of a single package. The version number is stored separately.
Constructors
| PkgRevInfo | |
Fields
| |
Instances
| Show (PkgRevInfo m) Source # | |
Defined in Futhark.Pkg.Info Methods showsPrec :: Int -> PkgRevInfo m -> ShowS # show :: PkgRevInfo m -> String # showList :: [PkgRevInfo m] -> ShowS # | |
| Eq (PkgRevInfo m) Source # | |
Defined in Futhark.Pkg.Info | |
data GetManifest m Source #
The manifest is stored as a monadic action, because we want to fetch them on-demand. It would be a waste to fetch it information for every version of every package if we only actually need a small subset of them.
Instances
| Show (GetManifest m) Source # | |
Defined in Futhark.Pkg.Info Methods showsPrec :: Int -> GetManifest m -> ShowS # show :: GetManifest m -> String # showList :: [GetManifest m] -> ShowS # | |
| Eq (GetManifest m) Source # | |
Defined in Futhark.Pkg.Info Methods (==) :: GetManifest m -> GetManifest m -> Bool # (/=) :: GetManifest m -> GetManifest m -> Bool # | |
Get the absolute path to a package directory on disk, as well as relative paths to files that should be installed from this package. Composing the package directory and one of these paths refers to a local file (pointing into the cache) and is valid at least until the next cache operation.
A temporary directory in which we store Git checkouts while
running. This is to avoid constantly re-cloning. Will be deleted
when futhark pkg terminates. In principle we could keep this
around for longer, but then we would have to 'git pull' now and
then also. Note that the cache is stateful - we are going to use
git checkout to move around the history. It is generally not
safe to have multiple operations running concurrently.
Package registry
data PkgRegistry m Source #
A package registry is a mapping from package paths to information about the package. It is unlikely that any given registry is global; rather small registries are constructed on-demand based on the package paths referenced by the user, and may also be combined monoidically. In essence, the PkgRegistry is just a cache.
Instances
| Monoid (PkgRegistry m) Source # | |
Defined in Futhark.Pkg.Info Methods mempty :: PkgRegistry m # mappend :: PkgRegistry m -> PkgRegistry m -> PkgRegistry m # mconcat :: [PkgRegistry m] -> PkgRegistry m # | |
| Semigroup (PkgRegistry m) Source # | |
Defined in Futhark.Pkg.Info Methods (<>) :: PkgRegistry m -> PkgRegistry m -> PkgRegistry m # sconcat :: NonEmpty (PkgRegistry m) -> PkgRegistry m # stimes :: Integral b => b -> PkgRegistry m -> PkgRegistry m # | |
class (MonadIO m, MonadLogger m, MonadFail m) => MonadPkgRegistry m where Source #
Monads that support a stateful package registry. These are also
required to be instances of MonadIO because most package registry
operations involve network operations.
Minimal complete definition
Methods
getPkgRegistry :: m (PkgRegistry m) Source #
putPkgRegistry :: PkgRegistry m -> m () Source #
modifyPkgRegistry :: (PkgRegistry m -> PkgRegistry m) -> m () Source #
lookupPackage :: MonadPkgRegistry m => CacheDir -> PkgPath -> m (PkgInfo m) Source #
Given a package path, look up information about that package.
lookupPackageRev :: MonadPkgRegistry m => CacheDir -> PkgPath -> SemVer -> m (PkgRevInfo m) Source #
Look up information about a specific version of a package.
lookupNewestRev :: MonadPkgRegistry m => CacheDir -> PkgPath -> m SemVer Source #
Find the newest version of a package.