Command
API
Generated with
Command/sbt/Command

Command

sbt.Command
See theCommand companion trait
object Command

Attributes

Companion
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Command.type

Members list

Value members

Concrete methods

def apply[T](name: String, help: Help)(parser: State => Parser[T])(effect: (State, T) => State): Command

Construct a command with the given name, parser and effect.

Construct a command with the given name, parser and effect.

Attributes

def apply[T](name: String, briefHelp: (String, String), detail: String)(parser: State => Parser[T])(effect: (State, T) => State): Command
def applyEffect[T](p: Parser[T])(f: T => State): Parser[() => State]
def applyEffect[T](parser: State => Parser[T])(effect: (State, T) => State): State => Parser[() => State]
def arb[T](parser: State => Parser[T], help: Help)(effect: (State, T) => State): Command
def args(name: String, display: String, help: Help)(f: (State, Seq[String]) => State): Command

Construct a multi-argument command with the given name, tab completion display and effect.

Construct a multi-argument command with the given name, tab completion display and effect.

Attributes

def args(name: String, briefHelp: (String, String), detail: String, display: String)(f: (State, Seq[String]) => State): Command
def combine(cmds: Seq[Command]): State => Parser[() => State]
def command(name: String, help: Help)(f: State => State): Command

Construct a no-argument command with the given name and effect.

Construct a no-argument command with the given name and effect.

Attributes

def command(name: String, briefHelp: String, detail: String)(f: State => State): Command
def custom(parser: State => Parser[() => State], help: Help): Command
def customHelp(parser: State => Parser[() => State], help: State => Help): Command
def distance(a: String, b: String): Int
def invalidValue(label: String, allowed: Iterable[String])(value: String): String
def make(name: String, help: Help)(parser: State => Parser[() => State]): Command
def make(name: String, briefHelp: (String, String), detail: String)(parser: State => Parser[() => State]): Command
def process(command: String, state: State, onParseError: String => Unit): State
def similar(value: String, allowed: Iterable[String]): String
def simpleParser(cmds: Seq[SimpleCommand]): State => Parser[() => State]
def simpleParser(commandMap: Map[String, State => Parser[() => State]]): State => Parser[() => State]
def single(name: String, help: Help)(f: (State, String) => State): Command

Construct a single-argument command with the given name and effect.

Construct a single-argument command with the given name and effect.

Attributes

def single(name: String, briefHelp: (String, String), detail: String)(f: (State, String) => State): Command
def spacedAny(name: String): Parser[String]
def spacedC(name: String, c: Parser[Char]): Parser[String]
def suggestions(a: String, bs: Seq[String], maxDistance: Int, maxSuggestions: Int): Seq[String]
def validID(name: String): Boolean

Deprecated methods

def process(command: String, state: State): State

Attributes

Deprecated
[Since version 1.9.4]
Generated with