Class AkkaSerializerFormatterAttribute

Registers a hand-written IAkkaMessagePackFormatter<T> for a foreign type that cannot be annotated with AkkaSerializableAttribute (for example, a core Akka type that cannot reference Akka.Serialization.V2).

Inheritance
object
Attribute
AkkaSerializerFormatterAttribute
Inherited Members
Namespace: Akka.Serialization.V2
Assembly: Akka.Serialization.V2.dll
Syntax
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = false)]
public sealed class AkkaSerializerFormatterAttribute : Attribute
Remarks

Apply to the [AkkaSerializer] partial class. The registration is serializer-scoped: the same foreign type may be handled by different formatters (or not at all) in different serializers. A formatter registration overrides every field-kind resolution the generator would otherwise infer for SerializedType (including Nullable<T> of a value type), except an AkkaEnvelopePayloadAttribute-marked field, which always wins.

Constructors

| Edit this page View Source

AkkaSerializerFormatterAttribute(Type, Type)

Initializes a new instance of the AkkaSerializerFormatterAttribute class.

Declaration
public AkkaSerializerFormatterAttribute(Type serializedType, Type formatterType)
Parameters
Type Name Description
Type serializedType

The foreign type handled by formatterType.
Type formatterType

A non-abstract, non-generic class implementing IAkkaMessagePackFormatter<T> for serializedType, with either a public parameterless constructor or a public constructor taking an ExtendedActorSystem. When both constructors are present, the generated serializer prefers the ExtendedActorSystem constructor: the serializer always has the system in hand, and system context is why a formatter declares that constructor.

Properties

| Edit this page View Source

FormatterType

The formatter type implementing IAkkaMessagePackFormatter<T> for SerializedType.

Declaration
public Type FormatterType { get; }
Property Value
Type Description
Type
| Edit this page View Source

SerializedType

The foreign type handled by FormatterType.

Declaration
public Type SerializedType { get; }
Property Value
Type Description
Type

Extension Methods