Documentation

Lake.Build.Fetch

Recursive Building #

This module defines Lake's top-level build monad, FetchM, used for performing recursive builds. A recursive build is a build function which can fetch the results of other (recursive) builds. This is done using the fetch function defined in this module.

@[reducible, inline, deprecated "Deprecated without replacement." (since := "2025-02-22")]

abbrev Lake.CoreBuildM (α : Type) :

The internal core monad of Lake builds. Not intended for user use.

Equations

Lake.CoreBuildM = Lake.BuildT Lake.LogIO

def Lake.CurrPackage :

A type alias for Option Package that assists monad type class synthesis.

Equations

Lake.CurrPackage = Option Lake.Package

@[inline]

def Lake.withCurrPackage? {m : Type → Type u_1} {α : Type} [MonadWithReader CurrPackage m] (pkg? : Option Package) (x : m α) :

m α

Run the action x with pkg? as the current package or no package if none.

Equations

Lake.withCurrPackage? pkg? x = withReader (fun (x : Option Lake.Package) => pkg?) x

@[inline]

def Lake.withCurrPackage {m : Type → Type u_1} {α : Type} [MonadWithReader CurrPackage m] (pkg : Package) (x : m α) :

m α

Run the action x with pkg as the current package.

Equations

Lake.withCurrPackage pkg x = Lake.withCurrPackage? (some pkg) x

@[inline]

def Lake.getCurrPackage? {m : Type → Type u_1} [MonadReaderOf CurrPackage m] :

m (Option Package)

Get the package of the context (if any).

Equations

Lake.getCurrPackage? = read

@[reducible, inline]

abbrev Lake.RecBuildT (m : Type → Type) (α : Type) :

A recursive build of a Lake build store that may encounter a cycle.

An internal monad. Not intended for user use.

Equations

Lake.RecBuildT m = ReaderT Lake.CurrPackage (Lake.CallStackT Lake.BuildKey (StateRefT' IO.RealWorld Lake.BuildStore (Lake.BuildT m)))

Instances For

Lake.instMonadCycleOfBuildKeyRecBuildTOfMonadOfMonadError

@[specialize #[]]

def Lake.buildCycleError {m : Type u_1 → Type u_2} {α : Type u_1} [MonadError m] (cycle : Cycle BuildKey) :

m α

Log build cycle and error.

Equations

Lake.buildCycleError cycle = Lake.error (toString "build cycle detected:\n" ++ toString (Lake.formatCycle cycle) ++ toString "")

instance Lake.instMonadCycleOfBuildKeyRecBuildTOfMonadOfMonadError {m : Type → Type} [Monad m] [MonadError m] :

MonadCycleOf BuildKey (RecBuildT m)

Equations

Lake.instMonadCycleOfBuildKeyRecBuildTOfMonadOfMonadError = { toMonadCallStackOf := Lake.instMonadCallStackOfOfMonadLiftOfMonadFunctor, throwCycle := fun {α : Type} => Lake.buildCycleError }

@[reducible, inline]

abbrev Lake.RecBuildM (α : Type) :

A recursive build of a Lake build store that may encounter a cycle.

An internal monad. Not intended for user use.

Equations

Lake.RecBuildM = Lake.RecBuildT Lake.LogIO

@[inline]

def Lake.RecBuildT.run {m : Type → Type} {α : Type} [Monad m] [MonadLiftT (ST IO.RealWorld) m] (stack : CallStack BuildKey) (store : BuildStore) (build : RecBuildT m α) :

BuildT m (α × BuildStore)

Run a recursive build.

Equations

Lake.RecBuildT.run stack store build = (build none stack).run store

@[inline]

def Lake.RecBuildT.run' {m : Type → Type} {α : Type} [Monad m] [MonadLiftT (ST IO.RealWorld) m] (build : RecBuildT m α) :

Run a recursive build in a fresh build store.

Equations

build.run' = (fun (x : α × Lake.BuildStore) => x.fst) <$> Lake.RecBuildT.run ∅ ∅ build

@[reducible, inline]

abbrev Lake.IndexBuildFn (m : Type → Type v) :

A build function for any element of the Lake build index.

Equations

Lake.IndexBuildFn m = ((info : Lake.BuildInfo) → m (Lake.Job (Lake.BuildData info.key)))

@[reducible, inline]

abbrev Lake.IndexT (m : Type → Type v) (α : Type) :

A transformer to equip a monad with a build function for the Lake index.

Equations

Lake.IndexT m = Lake.EquipT (Lake.IndexBuildFn Lake.RecBuildM) m

@[reducible, inline]

abbrev Lake.FetchT (m : Type → Type) (α : Type) :

The top-level monad transformer for Lake build functions.

Equations

Lake.FetchT m = Lake.IndexT (Lake.RecBuildT m)

@[reducible, inline]

abbrev Lake.FetchM (α : Type) :

The top-level monad for Lake build functions.

Equations

Lake.FetchM = Lake.FetchT Lake.LogIO

Instances For

@[inline]

def Lake.BuildInfo.fetch {α : Type} (self : BuildInfo) [FamilyOut BuildData self.key α] :

FetchM (Job α)

Fetch the result associated with the info using the Lake build index.

Equations

self.fetch build = cast ⋯ (build self)

def Lake.ModuleFacet.fetch {α : Type} (self : ModuleFacet α) (mod : Module) :

FetchM (Job α)

Fetch the result of this facet of a module.

Equations

self.fetch mod = (Lake.Module.facetCore self.name mod).fetch