register_serializer {plumber} | R Documentation |
Register a Serializer
Description
A serializer is responsible for translating a generated R value into output
that a remote user can understand. For instance, the serializer_json
serializes R objects into JSON before returning them to the user. The list of
available serializers in plumber is global.
Usage
register_serializer(name, serializer, verbose = TRUE)
registered_serializers()
Arguments
name |
The name of the serializer (character string) |
serializer |
The serializer function to be added.
This function should accept arguments that can be supplied when |
verbose |
Logical value which determines if a message should be printed when overwriting serializers |
Details
There are three main building-block serializers:
-
serializer_headers
: the base building-block serializer that is required to haveas_attachment()
work -
serializer_content_type()
: for setting the content type. (Callsserializer_headers()
) -
serializer_device()
: add endpoint hooks to turn a graphics device on and off in addition to setting the content type. (Usesserializer_content_type()
)
Functions
-
register_serializer()
: Register a serializer with a name -
registered_serializers()
: Return a list of all registered serializers
Examples
# `serializer_json()` calls `serializer_content_type()` and supplies a serialization function
print(serializer_json)
# serializer_content_type() calls `serializer_headers()` and supplies a serialization function
print(serializer_content_type)