Stack.Types.Resolver

Documentation

type Resolver = ResolverWith (Either Request FilePath)

data IsLoaded

Constructors

Loaded

NotLoaded

type LoadedResolver = ResolverWith SnapshotHash

data ResolverWith customContents

How we resolve which dependencies to install given a set of packages.

Constructors

ResolverStackage !SnapName

Use an official snapshot from the Stackage project, either an LTS Haskell or Stackage Nightly.

ResolverCompiler !(CompilerVersion CVWanted)

Require a specific compiler version, but otherwise provide no build plan. Intended for use cases where end user wishes to specify all upstream dependencies manually, such as using a dependency solver.

ResolverCustom !Text !customContents

A custom resolver based on the given location (as a raw URL or filepath). If customContents is a Either Request FilePath, it represents the parsed location value (with filepaths resolved relative to the directory containing the file referring to the custom snapshot). Once it has been loaded from disk, it will be replaced with a SnapshotHash value, which is used to store cached files.

Instances

Functor ResolverWith

Defined in Stack.Types.Resolver

Methods

fmap :: (a -> b) -> ResolverWith a -> ResolverWith b

(<$) :: a -> ResolverWith b -> ResolverWith a

Foldable ResolverWith

Defined in Stack.Types.Resolver

Methods

fold :: Monoid m => ResolverWith m -> m

foldMap :: Monoid m => (a -> m) -> ResolverWith a -> m

foldr :: (a -> b -> b) -> b -> ResolverWith a -> b

foldr' :: (a -> b -> b) -> b -> ResolverWith a -> b

foldl :: (b -> a -> b) -> b -> ResolverWith a -> b

foldl' :: (b -> a -> b) -> b -> ResolverWith a -> b

foldr1 :: (a -> a -> a) -> ResolverWith a -> a

foldl1 :: (a -> a -> a) -> ResolverWith a -> a

toList :: ResolverWith a -> [a]

null :: ResolverWith a -> Bool

length :: ResolverWith a -> Int

elem :: Eq a => a -> ResolverWith a -> Bool

maximum :: Ord a => ResolverWith a -> a

minimum :: Ord a => ResolverWith a -> a

sum :: Num a => ResolverWith a -> a

product :: Num a => ResolverWith a -> a

Traversable ResolverWith

Defined in Stack.Types.Resolver

Methods

traverse :: Applicative f => (a -> f b) -> ResolverWith a -> f (ResolverWith b)

sequenceA :: Applicative f => ResolverWith (f a) -> f (ResolverWith a)

mapM :: Monad m => (a -> m b) -> ResolverWith a -> m (ResolverWith b)

sequence :: Monad m => ResolverWith (m a) -> m (ResolverWith a)

NFData LoadedResolver

Defined in Stack.Types.Resolver

Methods

rnf :: LoadedResolver -> ()

Store LoadedResolver

Defined in Stack.Types.Resolver

Methods

size :: Size LoadedResolver

poke :: LoadedResolver -> Poke ()

peek :: Peek LoadedResolver

Eq customContents => Eq (ResolverWith customContents)

Defined in Stack.Types.Resolver

Methods

(==) :: ResolverWith customContents -> ResolverWith customContents -> Bool

(/=) :: ResolverWith customContents -> ResolverWith customContents -> Bool

Data customContents => Data (ResolverWith customContents)

Defined in Stack.Types.Resolver

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ResolverWith customContents -> c (ResolverWith customContents)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (ResolverWith customContents)

toConstr :: ResolverWith customContents -> Constr

dataTypeOf :: ResolverWith customContents -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (ResolverWith customContents))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (ResolverWith customContents))

gmapT :: (forall b. Data b => b -> b) -> ResolverWith customContents -> ResolverWith customContents

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ResolverWith customContents -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ResolverWith customContents -> r

gmapQ :: (forall d. Data d => d -> u) -> ResolverWith customContents -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ResolverWith customContents -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ResolverWith customContents -> m (ResolverWith customContents)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ResolverWith customContents -> m (ResolverWith customContents)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ResolverWith customContents -> m (ResolverWith customContents)

Show customContents => Show (ResolverWith customContents)

Defined in Stack.Types.Resolver

Methods

showsPrec :: Int -> ResolverWith customContents -> ShowS

show :: ResolverWith customContents -> String

showList :: [ResolverWith customContents] -> ShowS

Generic (ResolverWith customContents)

Defined in Stack.Types.Resolver

Associated Types

type Rep (ResolverWith customContents) :: Type -> Type

Methods

from :: ResolverWith customContents -> Rep (ResolverWith customContents) x

to :: Rep (ResolverWith customContents) x -> ResolverWith customContents

ToJSON (ResolverWith a)

Defined in Stack.Types.Resolver

Methods

toJSON :: ResolverWith a -> Value

toEncoding :: ResolverWith a -> Encoding

toJSONList :: [ResolverWith a] -> Value

toEncodingList :: [ResolverWith a] -> Encoding

a ~ () => FromJSON (ResolverWith a)

Defined in Stack.Types.Resolver

Methods

parseJSON :: Value -> Parser (ResolverWith a)

parseJSONList :: Value -> Parser [ResolverWith a]

type Rep (ResolverWith customContents)

Defined in Stack.Types.Resolver

type Rep (ResolverWith customContents) = D1 (MetaData "ResolverWith" "Stack.Types.Resolver" "stack-1.9.3-A8b1pQY9CjdHmL7IWv3q9b" False) (C1 (MetaCons "ResolverStackage" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SnapName)) :+: (C1 (MetaCons "ResolverCompiler" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (CompilerVersion CVWanted))) :+: C1 (MetaCons "ResolverCustom" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 customContents))))

parseResolverText :: Text -> ResolverWith ()

Parse a Resolver from a Text

data AbstractResolver

Either an actual resolver value, or an abstract description of one (e.g., latest nightly).

Constructors

ARLatestNightly

ARLatestLTS

ARLatestLTSMajor !Int

ARResolver !(ResolverWith ())

ARGlobal

Instances

Show AbstractResolver

Defined in Stack.Types.Resolver

Methods

showsPrec :: Int -> AbstractResolver -> ShowS

show :: AbstractResolver -> String

showList :: [AbstractResolver] -> ShowS

readAbstractResolver :: ReadM AbstractResolver

resolverRawName :: ResolverWith a -> Text

Convert a Resolver into its Text representation for human presentation. When possible, you should prefer sdResolverName, as it will handle the human-friendly name inside a custom snapshot.

data SnapName

The name of an LTS Haskell or Stackage Nightly snapshot.

Constructors

LTS !Int !Int

Nightly !Day

Instances

Eq SnapName

Defined in Stack.Types.Resolver

Methods

(==) :: SnapName -> SnapName -> Bool

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

Data SnapName

Defined in Stack.Types.Resolver

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SnapName -> c SnapName

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SnapName

toConstr :: SnapName -> Constr

dataTypeOf :: SnapName -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SnapName)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SnapName)

gmapT :: (forall b. Data b => b -> b) -> SnapName -> SnapName

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SnapName -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SnapName -> r

gmapQ :: (forall d. Data d => d -> u) -> SnapName -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SnapName -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SnapName -> m SnapName

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SnapName -> m SnapName

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SnapName -> m SnapName

Show SnapName

Defined in Stack.Types.Resolver

Methods

showsPrec :: Int -> SnapName -> ShowS

show :: SnapName -> String

showList :: [SnapName] -> ShowS

Generic SnapName

Defined in Stack.Types.Resolver

Associated Types

type Rep SnapName :: Type -> Type

Methods

from :: SnapName -> Rep SnapName x

to :: Rep SnapName x -> SnapName

NFData SnapName

Defined in Stack.Types.Resolver

Methods

rnf :: SnapName -> ()

Display SnapName

Defined in Stack.Types.Resolver

Methods

display :: SnapName -> Utf8Builder

Store SnapName

Defined in Stack.Types.Resolver

Methods

size :: Size SnapName

poke :: SnapName -> Poke ()

peek :: Peek SnapName

type Rep SnapName

Defined in Stack.Types.Resolver

type Rep SnapName = D1 (MetaData "SnapName" "Stack.Types.Resolver" "stack-1.9.3-A8b1pQY9CjdHmL7IWv3q9b" False) (C1 (MetaCons "LTS" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) :+: C1 (MetaCons "Nightly" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Day)))

data Snapshots

Most recent Nightly and newest LTS version per major release.

Constructors

Snapshots

Fields

• snapshotsNightly :: !Day
• snapshotsLts :: !(IntMap Int)

Instances

Show Snapshots

Defined in Stack.Types.Resolver

Methods

showsPrec :: Int -> Snapshots -> ShowS

show :: Snapshots -> String

showList :: [Snapshots] -> ShowS

FromJSON Snapshots

Defined in Stack.Types.Resolver

Methods

parseJSON :: Value -> Parser Snapshots

parseJSONList :: Value -> Parser [Snapshots]

renderSnapName :: SnapName -> Text

Convert a SnapName into its short representation, e.g. lts-2.8, nightly-2015-03-05.

parseSnapName :: MonadThrow m => Text -> m SnapName

Parse the short representation of a SnapName.

data SnapshotHash

Instances

Eq SnapshotHash

Defined in Stack.Types.Resolver

Methods

(==) :: SnapshotHash -> SnapshotHash -> Bool

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

Data SnapshotHash

Defined in Stack.Types.Resolver

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SnapshotHash -> c SnapshotHash

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SnapshotHash

toConstr :: SnapshotHash -> Constr

dataTypeOf :: SnapshotHash -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SnapshotHash)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SnapshotHash)

gmapT :: (forall b. Data b => b -> b) -> SnapshotHash -> SnapshotHash

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SnapshotHash -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SnapshotHash -> r

gmapQ :: (forall d. Data d => d -> u) -> SnapshotHash -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SnapshotHash -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SnapshotHash -> m SnapshotHash

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SnapshotHash -> m SnapshotHash

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SnapshotHash -> m SnapshotHash

Show SnapshotHash

Defined in Stack.Types.Resolver

Methods

showsPrec :: Int -> SnapshotHash -> ShowS

show :: SnapshotHash -> String

showList :: [SnapshotHash] -> ShowS

Generic SnapshotHash

Defined in Stack.Types.Resolver

Associated Types

type Rep SnapshotHash :: Type -> Type

Methods

from :: SnapshotHash -> Rep SnapshotHash x

to :: Rep SnapshotHash x -> SnapshotHash

NFData SnapshotHash

Defined in Stack.Types.Resolver

Methods

rnf :: SnapshotHash -> ()

NFData LoadedResolver

Defined in Stack.Types.Resolver

Methods

rnf :: LoadedResolver -> ()

Store SnapshotHash

Defined in Stack.Types.Resolver

Methods

size :: Size SnapshotHash

poke :: SnapshotHash -> Poke ()

peek :: Peek SnapshotHash

Store LoadedResolver

Defined in Stack.Types.Resolver

Methods

size :: Size LoadedResolver

poke :: LoadedResolver -> Poke ()

peek :: Peek LoadedResolver

type Rep SnapshotHash

Defined in Stack.Types.Resolver

type Rep SnapshotHash = D1 (MetaData "SnapshotHash" "Stack.Types.Resolver" "stack-1.9.3-A8b1pQY9CjdHmL7IWv3q9b" True) (C1 (MetaCons "SnapshotHash" PrefixI True) (S1 (MetaSel (Just "unSnapshotHash") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 StaticSHA256)))

trimmedSnapshotHash :: SnapshotHash -> Text

Return the first 12 characters of the hash as a B64URL-encoded string.

snapshotHashToBS :: SnapshotHash -> ByteString

Return the raw bytes in the hash

snapshotHashFromBS :: ByteString -> SnapshotHash

Create a new SnapshotHash by SHA256 hashing the given contents

snapshotHashFromDigest :: Digest SHA256 -> SnapshotHash

Create a new SnapshotHash from the given digest

parseCustomLocation

Arguments

:: MonadThrow m

=> Maybe (Path Abs Dir)

directory config value was read from

-> ResolverWith ()

-> m Resolver