Mill
API
Generated with
Mill/mill/mill.api

mill.api

package mill.api

Members list

Type members

Classlikes

object BuildInfo

Attributes

Source
BuildInfo.scala
Supertypes
class Object
trait Matchable
class Any
Self type
BuildInfo.type
class BuildScriptException(msg: String, script: Option[String]) extends MillException

Attributes

Source
MillException.scala
Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
@Scaladoc(value = "/**\n * Utilities for creating classloaders for running compiled Java/Scala code in\n * isolated classpaths.\n */")
object ClassLoader

Utilities for creating classloaders for running compiled Java/Scala code in isolated classpaths.

Utilities for creating classloaders for running compiled Java/Scala code in isolated classpaths.

Attributes

Source
ClassLoader.scala
Supertypes
class Object
trait Matchable
class Any
Self type
@Scaladoc(value = "/**\n * A listener trait for getting notified about\n * compilation output like compiler warnings and errors\n */")
trait CompileProblemReporter

A listener trait for getting notified about compilation output like compiler warnings and errors

A listener trait for getting notified about compilation output like compiler warnings and errors

Attributes

Source
CompileProblemReporter.scala
Supertypes
class Object
trait Matchable
class Any
@Scaladoc(value = "/**\n * Represents the data and utilities that are contextually available inside the\n * implementation of a `Task`.\n */")
trait Ctx extends Dest, Log, Args, Env, Workspace, Fork, Jobs

Represents the data and utilities that are contextually available inside the implementation of a Task.

Represents the data and utilities that are contextually available inside the implementation of a Task.

Attributes

Companion
object
Source
Ctx.scala
Supertypes
trait Jobs
trait Fork
trait Workspace
trait Env
trait Args
trait Log
trait Dest
class Object
trait Matchable
class Any
Show all
@Scaladoc(value = "/**\n * Provides access to various resources in the context of a current execution Target.\n */")
object Ctx

Provides access to various resources in the context of a current execution Target.

Provides access to various resources in the context of a current execution Target.

Attributes

Companion
trait
Source
Ctx.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Ctx.type
@Scaladoc(value = "/**\n * Unique diagnostic code given from the compiler with an optional further explanation.\n */")
trait DiagnosticCode

Unique diagnostic code given from the compiler with an optional further explanation.

Unique diagnostic code given from the compiler with an optional further explanation.

Attributes

Source
CompileProblemReporter.scala
Supertypes
class Object
trait Matchable
class Any
@Scaladoc(value = "/**\n * A dummy input stream containing an empty byte array.\n */")
object DummyInputStream extends ByteArrayInputStream

A dummy input stream containing an empty byte array.

A dummy input stream containing an empty byte array.

Attributes

Source
DummyStreams.scala
Supertypes
class ByteArrayInputStream
class InputStream
trait Closeable
trait AutoCloseable
class Object
trait Matchable
class Any
Show all
Self type
@Scaladoc(value = "/**\n * A dummy output stream that does nothing with what it consumes (think of it as `/dev/null`).\n */")
object DummyOutputStream extends OutputStream

A dummy output stream that does nothing with what it consumes (think of it as /dev/null).

A dummy output stream that does nothing with what it consumes (think of it as /dev/null).

Attributes

Source
DummyStreams.scala
Supertypes
class OutputStream
trait Flushable
trait Closeable
trait AutoCloseable
class Object
trait Matchable
class Any
Show all
Self type
@Scaladoc(value = "/**\n * Dummy Test Reporter that doesn\'t report\n * anything for any testing event.\n */")
object DummyTestReporter extends TestReporter

Dummy Test Reporter that doesn't report anything for any testing event.

Dummy Test Reporter that doesn't report anything for any testing event.

Attributes

Source
BuildReporter.scala
Supertypes
trait TestReporter
class Object
trait Matchable
class Any
Self type
case object Error extends Severity

Attributes

Source
CompileProblemReporter.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Severity
class Object
trait Matchable
class Any
Show all
Self type
Error.type
@Scaladoc(value = "/**\n * The result of a task execution.\n *\n * @tparam T The result type of the computed task.\n */")
sealed trait ExecResult[+T]

The result of a task execution.

The result of a task execution.

Type parameters

T

The result type of the computed task.

Attributes

Companion
object
Source
ExecResult.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Aborted
trait Failing[T]
class Exception
class Failure[T]
object Skipped
class Success[T]
Show all
object ExecResult

Attributes

Companion
trait
Source
ExecResult.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ExecResult.type
case object Info extends Severity

Attributes

Source
CompileProblemReporter.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Severity
class Object
trait Matchable
class Any
Show all
Self type
Info.type
object JsonFormatters extends JsonFormatters

Attributes

Companion
trait
Source
JsonFormatters.scala
Supertypes
class Object
trait Matchable
class Any
Self type
@Scaladoc(value = "/**\n * Defines various default JSON formatters used in mill.\n */")
trait JsonFormatters

Defines various default JSON formatters used in mill.

Defines various default JSON formatters used in mill.

Attributes

Companion
object
Source
JsonFormatters.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
@Scaladoc(value = "/**\n * The standard logging interface of the Mill build tool.\n * Also contains the two forwarded stdout and stderr streams, for code executed\n * by Mill to use directly. Typically, these correspond to the stdout and stderr,\n * but when `show` is used both are forwarded to stderr and stdout is only\n * used to display the final `show` output for easy piping.\n */")
trait Logger

The standard logging interface of the Mill build tool. Also contains the two forwarded stdout and stderr streams, for code executed by Mill to use directly. Typically, these correspond to the stdout and stderr, but when show is used both are forwarded to stderr and stdout is only used to display the final show output for easy piping.

The standard logging interface of the Mill build tool. Also contains the two forwarded stdout and stderr streams, for code executed by Mill to use directly. Typically, these correspond to the stdout and stderr, but when show is used both are forwarded to stderr and stdout is only used to display the final show output for easy piping.

Attributes

Source
Logger.scala
Supertypes
class Object
trait Matchable
class Any
@Scaladoc(value = "/**\n * This exception is specifically handled in [[mill.runner.MillMain]] and [[mill.runner.MillServerMain]]. You can use it, if you need to exit Mill with a nice error message.\n * @param msg The error message, to be displayed to the user.\n */")
class MillException(msg: String) extends Exception

This exception is specifically handled in mill.runner.MillMain and mill.runner.MillServerMain. You can use it, if you need to exit Mill with a nice error message.

This exception is specifically handled in mill.runner.MillMain and mill.runner.MillServerMain. You can use it, if you need to exit Mill with a nice error message.

Value parameters

msg

The error message, to be displayed to the user.

Attributes

Source
MillException.scala
Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
object Mirrors

Attributes

Source
Mirrors.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Mirrors.type
@Scaladoc(value = "/**\n * A wrapper around `os.Path` that calculates it\'s hashcode based\n * on the contents of the filesystem underneath it. Used to ensure filesystem\n * changes can bust caches which are keyed off hashcodes.\n */")
case class PathRef

A wrapper around os.Path that calculates it's hashcode based on the contents of the filesystem underneath it. Used to ensure filesystem changes can bust caches which are keyed off hashcodes.

A wrapper around os.Path that calculates it's hashcode based on the contents of the filesystem underneath it. Used to ensure filesystem changes can bust caches which are keyed off hashcodes.

Attributes

Companion
object
Source
PathRef.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PathRef

Attributes

Companion
class
Source
PathRef.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
PathRef.type
@Scaladoc(value = "/**\n * Contains general information about the build problem\n */")
trait Problem

Contains general information about the build problem

Contains general information about the build problem

Attributes

Source
CompileProblemReporter.scala
Supertypes
class Object
trait Matchable
class Any
@Scaladoc(value = "/**\n * Indicates the exact location (source file, line, column) of the build problem\n */")
trait ProblemPosition

Indicates the exact location (source file, line, column) of the build problem

Indicates the exact location (source file, line, column) of the build problem

Attributes

Source
CompileProblemReporter.scala
Supertypes
class Object
trait Matchable
class Any
@Scaladoc(value = "/**\n * Represents a computation that either succeeds with a value [[T]] or\n * fails. Basically equivalent to `Either[String, T]`, with converters\n * back and forther via [[Result.toEither]] or [[Result.fromEither]]\n */")
sealed trait Result[+T]

Represents a computation that either succeeds with a value T or fails. Basically equivalent to Either[String, T], with converters back and forther via Result.toEither or Result.fromEither

Represents a computation that either succeeds with a value T or fails. Basically equivalent to Either[String, T], with converters back and forther via Result.toEither or Result.fromEither

Attributes

Companion
object
Source
Result.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Failure
class Success[T]
object Result

Attributes

Companion
trait
Source
Result.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Result.type
sealed trait Severity

Attributes

Source
CompileProblemReporter.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Error
object Info
object Warn
@Scaladoc(value = "/**\n * Represents a set of streams that look similar to those provided by the\n * operating system. These may internally be proxied/redirected/processed, but\n * from the consumer\'s perspective they look just like the stdout/stderr/stdin\n * that any Unix process receives from the OS.\n */")
class SystemStreams(val out: PrintStream, val err: PrintStream, val in: InputStream)

Represents a set of streams that look similar to those provided by the operating system. These may internally be proxied/redirected/processed, but from the consumer's perspective they look just like the stdout/stderr/stdin that any Unix process receives from the OS.

Represents a set of streams that look similar to those provided by the operating system. These may internally be proxied/redirected/processed, but from the consumer's perspective they look just like the stdout/stderr/stdin that any Unix process receives from the OS.

Attributes

Companion
object
Source
SystemStreams.scala
Supertypes
class Object
trait Matchable
class Any
object SystemStreams

Attributes

Companion
class
Source
SystemStreams.scala
Supertypes
class Object
trait Matchable
class Any
Self type
@Scaladoc(value = "/**\n * Test reporter class that can be\n * injected into the test task and\n * report information upon the start\n * and the finish of testing events\n */")
trait TestReporter

Test reporter class that can be injected into the test task and report information upon the start and the finish of testing events

Test reporter class that can be injected into the test task and report information upon the start and the finish of testing events

Attributes

Source
BuildReporter.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
@Scaladoc(value = "/**\n * A somewhat-type-safe wrapper around `Any`. Stores an un-typed value, but\n * can only be created explicitly by wrapping in `Val(_)` and de-constructed\n * explicitly via `.value`. That makes it much less likely to introduce bugs\n * passing the wrong thing, e.g. `(Any, Int)` can be passed to `Any`, but\n * `(Val, Int)` cannot be passed to `Val`\n */")
case class Val(value: Any)

A somewhat-type-safe wrapper around Any. Stores an un-typed value, but can only be created explicitly by wrapping in Val(_) and de-constructed explicitly via .value. That makes it much less likely to introduce bugs passing the wrong thing, e.g. (Any, Int) can be passed to Any, but (Val, Int) cannot be passed to Val

A somewhat-type-safe wrapper around Any. Stores an un-typed value, but can only be created explicitly by wrapping in Val(_) and de-constructed explicitly via .value. That makes it much less likely to introduce bugs passing the wrong thing, e.g. (Any, Int) can be passed to Any, but (Val, Int) cannot be passed to Val

Attributes

Source
Val.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case object Warn extends Severity

Attributes

Source
CompileProblemReporter.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Severity
class Object
trait Matchable
class Any
Show all
Self type
Warn.type
object WorkspaceRoot

Attributes

Source
WorkspaceRoot.scala
Supertypes
class Object
trait Matchable
class Any
Self type
@Scaladoc(value = "/**\n * Annotation to mark experimental API, which is not guaranteed to stay.\n */")
class experimental extends StaticAnnotation

Annotation to mark experimental API, which is not guaranteed to stay.

Annotation to mark experimental API, which is not guaranteed to stay.

Attributes

Source
experimental.scala
Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
@Scaladoc(value = "/**\n * Annotation to mark internal API, which is not guaranteed to stay.\n */")
class internal extends StaticAnnotation

Annotation to mark internal API, which is not guaranteed to stay.

Annotation to mark internal API, which is not guaranteed to stay.

Attributes

Source
internal.scala
Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Generated with