Interface IEncodingConverter

Namespace

Temporalio.Converters

Assembly

Temporalio.dll

Representation of a payload converter for a specific encoding.

public interface IEncodingConverter

Properties

Encoding

Gets the encoding name this converter represents.

string Encoding { get; }

Property Value

string

Remarks

Implementers must put this value on the "encoding" metadata of created payloads.

Methods

ToValue(Payload, Type)

Convert the given payload to the given type or error.

object? ToValue(Payload payload, Type type)

Parameters

payload Payload

The payload to convert from.

type Type

The type to convert to.

Returns

object

The converted value.

Remarks

This call is guaranteed to only be called for payloads whose metadata match Encoding. This should error if it cannot convert to the given type.

TryToPayload(object?, out Payload?)

Try to convert the given value to the given payload or return false if this converter cannot handle it and the next should be tried.

bool TryToPayload(object? value, out Payload? payload)

Parameters

value object

The value to convert.

payload Payload

The payload to set.

Returns

bool

True if this converter can and has converted the value.

Remarks

Implementers must put the Encoding value on the "encoding" metadata of created payloads.