Object/Class

ammonite.main

Router

Related Docs: class Router | package main

Permalink

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
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

    Permalink

    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

    Permalink

    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]]

    Permalink
  4. type FailMaybe = Either[Seq[ParamError], Any]

    Permalink
  5. sealed trait Result[+T] extends AnyRef

    Permalink

    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

    Permalink
  7. class main extends Annotation with StaticAnnotation

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object Result

    Permalink
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. macro def generateRoutes[T](t: T): Seq[EntryPoint]

    Permalink
  11. 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]]

    Permalink
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. def read[T](dict: Map[String, String], default: ⇒ Option[Any], arg: ArgSig, thunk: (String) ⇒ T, extras: Option[Seq[String]]): FailMaybe

    Permalink
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  21. def validate(args: Seq[FailMaybe]): Result[Seq[Any]]

    Permalink
  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped