Job Monad #

This module contains additional definitions for Lake Job. In particular, it defines JobM, which uses BuildContext, which contains OpaqueJobs, hence the module split.

source

@[reducible, inline]

abbrev Lake.JobM (α : Type) :

Type

The monad of asynchronous Lake jobs.

While this can be lifted into FetchM, job action should generally be wrapped into an asynchronous job (e.g., via Job.async) instead of being run directly in FetchM.

Equations

Instances For

source

@[instance 10000]

instance Lake.instMonadStateOfJobStateJobM :

MonadStateOf JobState JobM

Equations

source

instance Lake.instMonadStateOfLogJobM :

MonadStateOf Log JobM

Equations

source

instance Lake.instMonadLogJobM :

MonadLog JobM

Equations

source

instance Lake.instMonadErrorJobM :

MonadError JobM

Equations

source

instance Lake.instAlternativeJobM :

Alternative JobM

Equations

source

instance Lake.instMonadLiftLogIOJobM :

MonadLift LogIO JobM

Equations

source

@[inline]

def Lake.updateAction (action : JobAction) :

JobM PUnit

Record that this job is trying to perform some action.

Equations

Instances For

source

@[inline]

def Lake.getTrace :

JobM BuildTrace

Returns the current job's build trace.

Equations

Instances For

source

@[inline]

def Lake.setTrace (trace : BuildTrace) :

JobM PUnit

Sets the current job's build trace.

Equations

Instances For

source

@[inline]

def Lake.setTraceCaption (caption : String) :

JobM PUnit

Set the caption of the job's build trace.

Equations

Instances For

source

@[inline]

def Lake.newTrace (caption : String := "<nil>") :

JobM PUnit

Replace the job's build trace with a new empty trace.

Equations

Instances For

source

@[inline]

def Lake.addTrace (trace : BuildTrace) :

JobM PUnit

Mix a trace into the current job's build trace.

Equations

Instances For

source

@[inline]

def Lake.takeTrace :

JobM BuildTrace

Returns the current job's build trace and removes it from the state.

Equations

Instances For

source

@[reducible, inline]

abbrev Lake.SpawnM (α : Type) :

Type

The monad used to spawn asynchronous Lake build jobs. Lifts into FetchM.

Equations

Instances For

source

@[inline]

def Lake.JobM.runSpawnM {α : Type} (x : SpawnM α) :

JobM α

Equations

Instances For

source

instance Lake.instMonadLiftSpawnMJobM :

MonadLift SpawnM JobM

Equations

source

@[inline]

def Lake.FetchM.runJobM {α : Type} (x : JobM α) :

FetchM α

Run a JobM action in FetchM.

Generally, this should not be done, and instead a job action should be run asynchronously in a Job (e.g., via Job.async).

Equations

Instances For

source

instance Lake.instMonadLiftJobMFetchM :

MonadLift JobM FetchM

Equations

source

@[inline]

def Lake.JobM.runFetchM {α : Type} (x : FetchM α) :

JobM α

Run a FetchM action in JobM.

Equations

Instances For

source

instance Lake.instMonadLiftFetchMJobM :

MonadLift FetchM JobM

Equations

source

@[inline]

def Lake.Job.bindTask {m : Type u_1 → Type u_2} {β : Type u_1} {α : Type u_3} [Monad m] [OptDataKind β] (f : JobTask α → m (JobTask β)) (self : Job α) :

m (Job β)

Equations

Instances For

source

@[inline]

def Lake.Job.async {α : Type} [OptDataKind α] (act : JobM α) (prio : Task.Priority := Task.Priority.default) (caption : String := "") :

SpawnM (Job α)

Spawn a job that asynchronously performs act.

Equations

Instances For

source

@[inline]

def Lake.Job.wait {α : Type} (self : Job α) :

BaseIO (JobResult α)

Wait a the job to complete and return the result.

Equations

Instances For

source

@[inline]

def Lake.Job.wait? {α : Type} (self : Job α) :

BaseIO (Option α)

Wait for a job to complete and return the produced value. If an error occurred, return none and discarded any logs produced.

Equations

Instances For

source

@[inline]

def Lake.Job.await {α : Type} (self : Job α) :

LogIO α

Wait for a job to complete and return the produced value. Logs the job's log and throws if there was an error.

Equations

Instances For

source

def Lake.Job.mapM {β : Type} {α : Type u_1} [kind : OptDataKind β] (self : Job α) (f : α → JobM β) (prio : Task.Priority := Task.Priority.default) (sync : Bool := false) :

SpawnM (Job β)

Apply f asynchronously to the job's output.

Equations

Instances For

source

@[reducible, inline, deprecated Lake.Job.mapM (since := "2024-12-06")]

abbrev Lake.Job.bindSync {β : Type} {α : Type u_1} [OptDataKind β] (self : Job α) (f : α → JobM β) (prio : Task.Priority := Task.Priority.default) (sync : Bool := false) :

SpawnM (Job β)

Equations

Instances For

source

def Lake.Job.bindM {β : Type} {α : Type u_1} [kind : OptDataKind β] (self : Job α) (f : α → JobM (Job β)) (prio : Task.Priority := Task.Priority.default) (sync : Bool := false) :

SpawnM (Job β)

Apply f asynchronously to the job's output and asynchronously await the resulting job.

Equations

Instances For

source

@[reducible, inline, deprecated Lake.Job.bindM (since := "2024-12-06")]

abbrev Lake.Job.bindAsync {β : Type} {α : Type u_1} [OptDataKind β] (self : Job α) (f : α → SpawnM (Job β)) (prio : Task.Priority := Task.Priority.default) (sync : Bool := false) :

SpawnM (Job β)

Equations

Instances For

source

@[inline]

def Lake.Job.zipResultWith {γ : Type u_1} {α : Type u_2} {β : Type u_3} [OptDataKind γ] (f : JobResult α → JobResult β → JobResult γ) (self : Job α) (other : Job β) (prio : Task.Priority := Task.Priority.default) (sync : Bool := true) :

Job γ

a.zipWith f b produces a new job c that applies f to the results of a and b. The job c errors if either a or b error.

Equations

Instances For

source

@[inline]

def Lake.Job.zipWith {γ : Type u_1} {α : Type u_2} {β : Type u_3} [OptDataKind γ] (f : α → β → γ) (self : Job α) (other : Job β) (prio : Task.Priority := Task.Priority.default) (sync : Bool := true) :

Job γ

a.zipWith f b produces a new job c that applies f to the results of a and b. The job c errors if either a or b error.

Equations

Instances For

source