Mill
API
Generated with
Mill/mill/mill.api/Ctx/Fork/Api

Api

mill.api.Ctx.Fork.Api
trait Api

Attributes

Source
Ctx.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Impl

Members list

Value members

Abstract methods

@Scaladoc(value = "/**\n * Spawns an async workflow. Mill async futures require additional metadata\n * to sandbox, store logs, and integrate them into Mills terminal prompt logger\n *\n * @param dest The \"sandbox\" folder that will contain the `os.pwd` and the `pwd` for\n * any subprocesses spawned within the async future. Also provides the\n * path for the log file (dest + \".log\") for any stdout/stderr `println`s\n * that occur within that future\n * @param key The short prefix, typically a number (\"1\", \"2\", \"3\", etc.) that will be\n * used to prefix all log lines emitted within this async future in the\n * terminal to allow them to be distinguished from other logs\n * @param message A one-line summary of what this async future is doing, used in the\n * terminal prompt to display what this future is currently computing.\n * @param priority 0 means the same priority as other Mill tasks, negative values <0\n * mean increasingly high priority, positive values >0 mean increasingly\n * low priority\n * @param t The body of the async future\n */")
def async[T](dest: Path, key: String, message: String, priority: Int)(t: Logger => T)(implicit ctx: Ctx): Future[T]

Spawns an async workflow. Mill async futures require additional metadata to sandbox, store logs, and integrate them into Mills terminal prompt logger

Spawns an async workflow. Mill async futures require additional metadata to sandbox, store logs, and integrate them into Mills terminal prompt logger

Value parameters

dest

The "sandbox" folder that will contain the os.pwd and the pwd for any subprocesses spawned within the async future. Also provides the path for the log file (dest + ".log") for any stdout/stderr printlns that occur within that future

key

The short prefix, typically a number ("1", "2", "3", etc.) that will be used to prefix all log lines emitted within this async future in the terminal to allow them to be distinguished from other logs

message

A one-line summary of what this async future is doing, used in the terminal prompt to display what this future is currently computing.

priority

0 means the same priority as other Mill tasks, negative values <0 mean increasingly high priority, positive values >0 mean increasingly low priority

t

The body of the async future

Attributes

Source
Ctx.scala
@Scaladoc(value = "/**\n * Awaits for the result for the given async future and returns the resultant value\n */")
def await[T](t: Future[T]): T

Awaits for the result for the given async future and returns the resultant value

Awaits for the result for the given async future and returns the resultant value

Attributes

Source
Ctx.scala
@Scaladoc(value = "/**\n * Awaits for the result for multiple async futures and returns the resultant values\n */")
def awaitAll[T](t: Seq[Future[T]]): Seq[T]

Awaits for the result for multiple async futures and returns the resultant values

Awaits for the result for multiple async futures and returns the resultant values

Attributes

Source
Ctx.scala
def blocking[T](t: => T): T

Attributes

Source
Ctx.scala
Generated with