CommandConnector

Instance Constructors

new CommandConnector(messages: Source[(Message, CacheSnapshot[F]), NotUsed], requests: RequestHelper)(implicit arg0: Streamable[F], arg1: Monad[F])

messages
A source of messages and their cache. All the messages that will be considered for commands.
requests
A request helper to send errors and pass to command messages

Type Members

type PrefixParser = (CacheSnapshot[F], Message) ⇒ F[MessageParser[Unit]]

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
AnyRef
def newCommand[A, Mat](prefix: PrefixParser, command: Command[F, A, Mat]): RunnableGraph[(Mat, Future[Done])]

Creates a RunnableGraph for a command.
Creates a RunnableGraph for a command.
A
The type of arguments this command uses.
Mat
The materialized result of running the command graph.
prefix
The prefix to parse before the command.
command
The command to use when creating the graph.
returns
A runnable graph representing the execution of this command. Errors are sent as messages to the channel the command was used from.

See also
newCommandWithErrors
def newCommandWithErrors[A, Mat](prefix: PrefixParser, command: Command[F, A, Mat]): Source[CommandError[F], (Mat, Future[Done])]

Composes a command's flow and the source of messages to consider for commands.
Composes a command's flow and the source of messages to consider for commands.
A
The type of arguments this command uses.
Mat
The materialized result of running the command graph.
prefix
A prefix parser to use for this command. In most cases create it by calling prefix.
command
A command the compose with.
returns
A source of command errors that can be used however you want.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def prefix(symbol: String, aliases: Seq[String], mustMention: Boolean): PrefixParser

Creates a prefix parser for a command.
Creates a prefix parser for a command.
symbol
The symbol to parse before the command.
aliases
A list of aliases for this command.
mustMention
If the command must need a mention before the prefix and alias.
def runNewCommand[A, Mat](prefix: PrefixParser, command: Command[F, A, Mat]): (Mat, Future[Done])

Starts a command execution.
Starts a command execution.
A
The type of arguments this command uses.
Mat
The materialized result of running the command graph.
prefix
The prefix to use for the command.
command
The command to run.
returns
The materialized result of running the command, in addition to a future signaling when the command is done running.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package newcommands

class CommandConnector[F[_]] extends AnyRef

Instance Constructors

new CommandConnector(messages: Source[(Message, CacheSnapshot[F]), NotUsed], requests: RequestHelper)(implicit arg0: Streamable[F], arg1: Monad[F])

Type Members

type PrefixParser = (CacheSnapshot[F], Message) ⇒ F[MessageParser[Unit]]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

def newCommand[A, Mat](prefix: PrefixParser, command: Command[F, A, Mat]): RunnableGraph[(Mat, Future[Done])]

def newCommandWithErrors[A, Mat](prefix: PrefixParser, command: Command[F, A, Mat]): Source[CommandError[F], (Mat, Future[Done])]

final def notify(): Unit

final def notifyAll(): Unit

def prefix(symbol: String, aliases: Seq[String], mustMention: Boolean): PrefixParser

def runNewCommand[A, Mat](prefix: PrefixParser, command: Command[F, A, Mat]): (Mat, Future[Done])

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped