Trait/Object

ackcord.newcommands

CommandBuilder

Related Docs: object CommandBuilder | package newcommands

Permalink

trait CommandBuilder[F[_], +M[_], A] extends CommandFunction[F, [β$0$]CommandMessage[F, β$0$], M]

A CommandFunction from a command message to an output. Used for creating commands.

F

The cache effect type

M

The command message type used by the command.

A

The argument type of this command builder.

Self Type
CommandBuilder[F, M, A]
Linear Supertypes
CommandFunction[F, [β$0$]CommandMessage[F, β$0$], M], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CommandBuilder
  2. CommandFunction
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def flow[A]: Flow[CommandMessage[F, A], Either[Option[CommandError[F]], M[A]], NotUsed]

    Permalink

    A flow that represents this mapping.

    A flow that represents this mapping.

    Definition Classes
    CommandFunction
  2. abstract def parser: MessageParser[A]

    Permalink

    The parser used for parsing the arguments this command takes.

  3. abstract def requests: RequestHelper

    Permalink

    A request helper that belongs to this builder.

Concrete 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. def andThen[M2[_]](f: CommandFunction[F, M, M2]): CommandBuilder[F, M2, A]

    Permalink

    Chains first this function, and then another one.

    Chains first this function, and then another one.

    Definition Classes
    CommandBuilderCommandFunction
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def async[G[_]](block: (M[A]) ⇒ G[Unit])(implicit streamable: Streamable[G]): Command[F, A, NotUsed]

    Permalink

    Creates a command that results in some streamable type G

    Creates a command that results in some streamable type G

    G

    The streamable result type.

    block

    The execution of the command.

  7. def asyncOptRequest[G[_]](block: (M[A]) ⇒ OptionT[G, Request[Any, Any]])(implicit streamable: Streamable[G]): Command[F, A, NotUsed]

    Permalink

    Creates a command that might do a single request, wrapped in an effect type G

    Creates a command that might do a single request, wrapped in an effect type G

    G

    The streamable result type.

    block

    The execution of the command.

  8. def clone(): AnyRef

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  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 parsing[B](implicit newParser: MessageParser[B]): CommandBuilder[F, M, B]

    Permalink

    Creates a new command builder parsing a specific type.

    Creates a new command builder parsing a specific type.

    B

    The type to parse

  19. def streamed[Mat](sinkBlock: Sink[M[A], Mat]): Command[F, A, Mat]

    Permalink

    Creates a command from a sink.

    Creates a command from a sink.

    Mat

    The materialized result of running this command.

    sinkBlock

    The sink that will process this command.

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  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( ... )
  25. def withRequest(block: (M[A]) ⇒ Request[Any, Any]): Command[F, A, NotUsed]

    Permalink

    Creates a command that will do a single request

    Creates a command that will do a single request

    block

    The execution of the command.

  26. def withRequestOpt(block: (M[A]) ⇒ Option[Request[Any, Any]]): Command[F, A, NotUsed]

    Permalink

    Creates a command that might do a single request

    Creates a command that might do a single request

    block

    The execution of the command.

  27. def withSideEffects(block: (M[A]) ⇒ Unit): Command[F, A, NotUsed]

    Permalink

    Creates a command that might execute unknown side effects.

    Creates a command that might execute unknown side effects.

    block

    The execution of the command.

Inherited from CommandFunction[F, [β$0$]CommandMessage[F, β$0$], M]

Inherited from AnyRef

Inherited from Any

Ungrouped