View Source Flamel.Contextable protocol (flamel v1.10.0)

The Flamel.Contextable protocol for working with something that stores a generic data structure and has the ability to.

Summary

Types

t()

All the types that implement this protocol.

Functions

assign(context, map)

Merges values in a map into the assigns in the context.

assign(context, key, value)

Assigns a value to a key in the context.

halt!(context, reason)

Signals to further functions in the pipeline that processing should stop

halted?(context)

Has the context been halted?

resume!(context)

Signals to further functions in the pipeline that processing should resume

Types

t()

@type t() :: term()

All the types that implement this protocol.

Functions

assign(context, map)

@spec assign(term(), map() | keyword()) :: term()

Merges values in a map into the assigns in the context.

assign(context, key, value)

@spec assign(term(), binary() | atom(), term()) :: term()

Assigns a value to a key in the context.

halt!(context, reason)

@spec halt!(term(), binary()) :: term()

Signals to further functions in the pipeline that processing should stop

halted?(context)

@spec halted?(term()) :: boolean()

Has the context been halted?

resume!(context)

@spec resume!(term()) :: term()

Signals to further functions in the pipeline that processing should resume