mirror of
https://github.com/livebook-dev/livebook.git
synced 2025-09-06 04:54:29 +08:00
19 lines
621 B
Elixir
19 lines
621 B
Elixir
defmodule LiveBook.Evaluator.Formatter do
|
|
@moduledoc false
|
|
|
|
# Behaviour defining how evaluation results are transformed.
|
|
#
|
|
# The evaluation response is sent to the client as a message
|
|
# and it may potentially be huge. If the client eventually
|
|
# converts the result into some smaller representation,
|
|
# we would unnecessarily send a lot of data.
|
|
# By defining a custom formatter the client can instruct
|
|
# the `Evaluator` to send already transformed data.
|
|
|
|
alias LiveBook.Evaluator
|
|
|
|
@doc """
|
|
Transforms the evaluation response.
|
|
"""
|
|
@callback format(Evaluator.evaluation_response()) :: term()
|
|
end
|