Type Members

1.  sealed trait Completion extends AnyRef

   Represents a completion.

   Represents a completion. The abstract members display and append are best explained with an example.

   Assuming space-delimited tokens, processing this: am is are w<TAB> could produce these Completions: Completion { display = "was"; append = "as" } Completion { display = "were"; append = "ere" } to suggest the tokens "was" and "were".

   In this way, two pieces of information are preserved: 1) what needs to be appended to the current input if a completion is selected 2) the full token being completed, which is useful for presenting a user with choices to select

2.  sealed trait Completions extends AnyRef

   Represents a set of completions.

   Represents a set of completions. It exists instead of implicitly defined operations on top of Set[Completion] for laziness.

3.  final class DisplayOnly extends Completion
4.  trait ExampleSource extends AnyRef

   These sources of examples are used in parsers for user input completion.

   These sources of examples are used in parsers for user input completion. An example of such a source is the sbt.complete.FileExamples class, which provides a list of suggested files to the user as they press the TAB key in the console.

5.  class FileExamples extends ExampleSource

   Provides path completion examples based on files in the base directory.

6.  final case class Finite (value: Int) extends UpperBound with Product with Serializable

   Represents a finite upper bound.

   Represents a finite upper bound. The maximum allowed value is 'value', inclusive. It must positive.

7.  sealed case class FixedSetExamples (examples: Iterable[String]) extends ExampleSource with Product with Serializable

   A convenience example source that wraps any collection of strings into a source of examples.

   A convenience example source that wraps any collection of strings into a source of examples.

   examples

   the examples that will be displayed to the user when they press the TAB key.

8.  final class History extends AnyRef
9.  sealed trait Parser [+T] extends AnyRef

   A String parser that provides semi-automatic tab completion.

   A String parser that provides semi-automatic tab completion. A successful parse results in a value of type T. The methods in this trait are what must be implemented to define a new Parser implementation, but are not typically useful for common usage. Instead, most useful methods for combining smaller parsers into larger parsers are implicitly added by the RichParser type.

10.  trait ParserMain extends AnyRef
11.  trait Parsers extends AnyRef

    Provides standard implementations of commonly useful Parsers.

12.  sealed trait RichParser [A] extends AnyRef
13.  final class Suggestion extends Completion
14.  final class Token extends Completion
15.  sealed trait TokenCompletions extends AnyRef
16.  sealed trait UpperBound extends AnyRef
17.  sealed trait ValidParser [T] extends Parser[T]