package api
- Alphabetic
- Public
- Protected
Type Members
- class BuildScriptException extends MillException
- trait CompileProblemReporter extends AnyRef
A listener trait for getting notified about compilation output like compiler warnings and errors
- class Ctx extends Dest with Log with api.Ctx.Args with Home with Env with Workspace
Represents the data and utilities that are contextually available inside the implementation of a
Task
. - trait DiagnosticCode extends AnyRef
Unique diagnostic code given from the compiler with an optional further explanation.
- class FixSizedCache[T] extends KeyedLockedCache[T]
Simple fixed size cache mainly intended for use in ZincWorkerImpl with the following properties - Elements are lazily initialized upon first access - Cached element ordering is preserved.
Simple fixed size cache mainly intended for use in ZincWorkerImpl with the following properties - Elements are lazily initialized upon first access - Cached element ordering is preserved. The earliest available cache entry which is probably a compiler instance will always be returned first, and it will always be put back in the cache in the same position. This is important because each compiler instance is JITed independently. So with a stable ordering so we can bias towards reusing an already warm compiler.
- final class JarManifest extends AnyRef
Represents a JAR manifest.
- trait JarOps extends AnyRef
- Annotations
- @experimental()
- trait JsonFormatters extends AnyRef
Defines various default JSON formatters used in mill.
- trait KeyedLockedCache[T] extends AnyRef
A combination lock & cache; users provide a key, value-factory, and a body function to be called with the value.
A combination lock & cache; users provide a key, value-factory, and a body function to be called with the value. KeyedLockedCache ensures that the body function is called with the computed/cached value sequentially.
- class Lazy[T] extends AnyRef
- trait Logger extends AnyRef
The standard logging interface of the Mill build tool.
The standard logging interface of the Mill build tool.
Contains these primary logging methods, in order of increasing importance:
-
debug
: internal debug messages normally not shown to the user; mostly useful when debugging issues-
ticker
: short-lived logging output where consecutive lines over-write each other; useful for information which is transient and disposable-
info
: miscellaneous logging output which isn't part of the main output a user is looking for, but useful to provide context on what Mill is doing-
error
: logging output which represents problems the user should care aboutAlso 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 finalshow
output for easy piping. - class MillException extends Exception
This exception is specifically handled in mill.runner.MillMain and mill.runner.MillServerMain.
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.
- case class PathRef extends Product with Serializable
A wrapper around
os.Path
that calculates it's hashcode based on the contents of the filesystem underneath it.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. - trait Problem extends AnyRef
Contains general information about the build problem
- trait ProblemPosition extends AnyRef
Indicates the exact location (source file, line, column) of the build problem
- sealed trait Result[+T] extends AnyRef
The result of a task execution.
The result of a task execution.
- T
The result type of the computed task.
- case class Retry(count: Int = 5, backoffMillis: Long = 10, backoffMultiplier: Double = 2.0, timeoutMillis: Long = -1, filter: (Int, Throwable) => Boolean = (_, _) => true) extends Product with Serializable
- sealed trait Severity extends AnyRef
- trait StreamSupport extends AnyRef
- class SystemStreams extends AnyRef
Represents a set of streams that look similar to those provided by the operating system.
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.
- trait TestReporter extends AnyRef
Test reporter class that can be injected into the test task and report information upon the start and the finish of testing events
- case class Val(value: Any) extends Product with Serializable
A somewhat-type-safe wrapper around
Any
.A somewhat-type-safe wrapper around
Any
. Stores an un-typed value, but can only be created explicitly by wrapping inVal(_)
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 toAny
, but(Val, Int)
cannot be passed toVal
- class experimental extends Annotation with StaticAnnotation
Annotation to mark experimental API, which is not guaranteed to stay.
- class internal extends Annotation with StaticAnnotation
Annotation to mark internal API, which is not guaranteed to stay.
Value Members
- object BuildInfo
- object ClassLoader
Utilities for creating classloaders for running compiled Java/Scala code in isolated classpaths.
- object Ctx
Provides access to various resources in the context of a currently execution Target.
- object DummyInputStream extends ByteArrayInputStream
A dummy input stream containing an empty byte array.
- object DummyOutputStream extends OutputStream
A dummy output stream that does nothing with what it consumes (think of it as
/dev/null
). - object DummyTestReporter extends TestReporter
Dummy Test Reporter that doesn't report anything for any testing event.
- case object Error extends Severity with Product with Serializable
- object IO extends StreamSupport
Misc IO utilities, eventually probably should be pushed upstream into ammonite-ops
- case object Info extends Severity with Product with Serializable
- object JarManifest
- object JarOps extends JarOps
- Annotations
- @experimental()
- object JsonFormatters extends JsonFormatters
- object KeyedLockedCache
- object Loose extends AggWrapper
- object PathRef extends Serializable
- object Result
- object Strict extends AggWrapper
- object SystemStreams
- case object Warn extends Severity with Product with Serializable
- object WorkspaceRoot