t

ackcord.commands

ActionBuilder

trait ActionBuilder[-I[_], +O[_], E, A] extends ActionFunction[I, O, E]

An ActionFunction from an input to an output. Used for creating actions.

I

The input type of this builder.

O

The action message type used by the command.

A

The argument type of this command builder.

Self Type
ActionBuilder[I, O, E, A]
Source
actionBuilder.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ActionBuilder
  2. ActionFunction
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type Action[B, Mat]

Abstract Value Members

  1. abstract def flow[A]: Flow[I[A], Either[Option[E], O[A]], NotUsed]

    A flow that represents this mapping.

    A flow that represents this mapping.

    Definition Classes
    ActionFunction
  2. abstract def requests: requests.Requests

    A request helper that belongs to this builder.

  3. abstract def toSink[Mat](sinkBlock: Sink[O[A], Mat]): Action[A, Mat]

    Creates an action from a sink.

    Creates an action from a sink.

    Mat

    The materialized result of running this action.

    sinkBlock

    The sink that will process this action.

Concrete Value Members

  1. def andThen[O2[_]](that: ActionFunction[O, O2, E]): ActionFunction[I, O2, E]

    Chains first this function, and then another one.

    Chains first this function, and then another one.

    Definition Classes
    ActionFunction
  2. def async(block: (O[A]) => Future[Unit]): Action[A, NotUsed]

    Creates an action that results in an async result

    Creates an action that results in an async result

    block

    The execution of the action.

  3. def asyncOpt(block: (O[A]) => OptFuture[Unit]): Action[A, NotUsed]

    Creates an action that results in an partial async result

    Creates an action that results in an partial async result

    block

    The execution of the action.

  4. def asyncOptRequest[G[_]](block: (O[A]) => OptFuture[Request[Any]]): Action[A, NotUsed]

    Creates an async action that might do a single request

    Creates an async action that might do a single request

    G

    The streamable result type.

    block

    The execution of the action.

  5. def streamed[G[_]](block: (O[A]) => G[Unit])(implicit streamable: util.Streamable[G]): Action[A, NotUsed]

    Creates an action that results in some streamable type G

    Creates an action that results in some streamable type G

    G

    The streamable result type.

    block

    The execution of the action.

  6. def streamedOptRequest[G[_]](block: (O[A]) => OptionT[G, Request[Any]])(implicit streamable: util.Streamable[G]): Action[A, NotUsed]

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

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

    G

    The streamable result type.

    block

    The execution of the action.

  7. def withRequest(block: (O[A]) => Request[Any]): Action[A, NotUsed]

    Creates an action that will do a single request

    Creates an action that will do a single request

    block

    The execution of the action.

  8. def withRequestOpt(block: (O[A]) => Option[Request[Any]]): Action[A, NotUsed]

    Creates an action that might do a single request

    Creates an action that might do a single request

    block

    The execution of the action.

  9. def withSideEffects(block: (O[A]) => Unit): Action[A, NotUsed]

    Creates an action that might execute unknown side effects.

    Creates an action that might execute unknown side effects.

    block

    The execution of the action.