Mill
API
Generated with
Mill/mill/mill.api

mill.api

package mill.api

Members list

Packages

package mill.api.internal

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 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 * 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
@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
@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 Segment

Attributes

Companion
object
Source
Segment.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Cross
class Label
object Segment

Attributes

Companion
trait
Source
Segment.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Segment.type
@Scaladoc(value = "/**\n * Models a path with the Mill build hierarchy, e.g. `amm.util[2.11].test.compile`.\n *\n * `.`-separated segments are [[Segment.Label]]s,\n * while `[]`-delimited segments are [[Segment.Cross]]s\n */")
case class Segments

Models a path with the Mill build hierarchy, e.g. amm.util[2.11].test.compile.

Models a path with the Mill build hierarchy, e.g. amm.util[2.11].test.compile.

.-separated segments are Segment.Labels, while []-delimited segments are Segment.Crosss

Attributes

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

Attributes

Companion
class
Source
Segments.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Segments.type
sealed trait SelectMode

Attributes

Companion
object
Source
SelectMode.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Multi
object Separated
object SelectMode

Attributes

Companion
trait
Source
SelectMode.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
SelectMode.type
@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

Source
SystemStreams.scala
Supertypes
class Object
trait Matchable
class Any
@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
@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
Generated with