Packages

  • package root
    Definition Classes
    root
  • package ammonite
    Definition Classes
    root
  • package main

    Code related to invoking Ammonite from the outside world: default configuration, running scripts, printing error messages, etc.

    Code related to invoking Ammonite from the outside world: default configuration, running scripts, printing error messages, etc.

    Definition Classes
    ammonite
  • Defaults
  • Router
  • Scripts

object Router

More or less a minimal version of Autowire's Server that lets you generate a set of "routes" from the methods defined in an object, and call them using passing in name/args/kwargs via Java reflection, without having to generate/compile code or use Scala reflection. This saves us spinning up the Scala compiler and greatly reduces the startup time of cached scripts.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Router
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class ArgSig (name: String, typeString: String, doc: Option[String], default: Option[() ⇒ Any]) extends Product with Serializable

    Models what is known by the router about a single argument: that it has a name, a human-readable typeString describing what the type is (just for logging and reading, not a replacement for a TypeTag) and possible a function that can compute its default value

  2. case class EntryPoint (name: String, argSignatures: Seq[ArgSig], varargs: Boolean, invoke0: (Map[String, String], Seq[String]) ⇒ Result[Any]) extends Product with Serializable

    What is known about a single endpoint for our routes.

    What is known about a single endpoint for our routes. It has a name, argSignatures for each argument, and a macro-generated invoke0 that performs all the necessary argument parsing and de-serialization.

    Realistically, you will probably spend most of your time calling invoke instead, which provides a nicer API to call it that mimmicks the API of calling a Scala method.

  3. type FailAll = Either[Seq[ParamError], Seq[Any]]
  4. type FailMaybe = Either[Seq[ParamError], Any]
  5. sealed trait Result [+T] extends AnyRef

    Represents what comes out of an attempt to invoke an EntryPoint.

    Represents what comes out of an attempt to invoke an EntryPoint. Could succeed with a value, but could fail in many different ways.

  6. class doc extends Annotation with StaticAnnotation
  7. class main extends Annotation with StaticAnnotation

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. macro def generateRoutes[T](t: T): Seq[EntryPoint]
  10. def generateRoutesImpl[T](c: Context)(t: scala.reflect.macros.blackbox.Context.Expr[T])(implicit arg0: scala.reflect.macros.blackbox.Context.WeakTypeTag[T]): scala.reflect.macros.blackbox.Context.Expr[Seq[EntryPoint]]
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  17. def read[T](dict: Map[String, String], default: ⇒ Option[Any], arg: ArgSig, thunk: (String) ⇒ T, extras: Option[Seq[String]]): FailMaybe
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. def validate(args: Seq[FailMaybe]): Result[Seq[Any]]
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. object Result

Inherited from AnyRef

Inherited from Any

Ungrouped