Stopsel.Message (stopsel v0.1.0) View Source

Represents a text message.

A message has the original content, against which was matched against, assigns and parameters.

Assigns can be arbitrarily added to the message, parameters on the other are assigned from the Stopsel.Invoker and contain the parameters that were declared in the matching route.

Link to this section Summary

Types

assigns()

content()

halted_message()

params()

t()

Functions

assign(message, new_assigns)

Adds many assigns or overwrites them.

assign(message, key, value)

Adds an assign to the message or overwrites it.

halt(message)

Prevents a message from advancing further down the pipeline.

put_param(message, key, value)

Adds an parameter to the message or overwrites it.

put_params(message, new_params)

Adds many parametewrs or overwrites them.

Link to this section Types

assigns()

Specs

assigns() :: map()

content()

Specs

content() :: String.t()

halted_message()

Specs

halted_message() :: %Stopsel.Message{
  assigns: assigns(),
  content: content(),
  halted?: true,
  params: params()
}

params()

Specs

params() :: map()

t()

Specs

t() :: %Stopsel.Message{
  assigns: assigns(),
  content: content(),
  halted?: boolean(),
  params: params()
}

Link to this section Functions

assign(message, new_assigns)

Specs

assign(t(), map() | Keyword.t()) :: t()

Adds many assigns or overwrites them.

assign(message, key, value)

Specs

assign(t(), atom(), term()) :: t()

Adds an assign to the message or overwrites it.

halt(message)

Specs

halt(t()) :: halted_message()

Prevents a message from advancing further down the pipeline.

put_param(message, key, value)

Specs

put_param(t(), atom(), term()) :: t()

Adds an parameter to the message or overwrites it.

put_params(message, new_params)

Specs

put_params(t(), map() | Keyword.t()) :: t()

Adds many parametewrs or overwrites them.