Search Results for

    Show / Hide Table of Contents

    Class SerializerDetails

    Constructor is internal API.

    Use the Create(string, Serializer, ImmutableHashSet<Type>) factory method instead

    Inheritance
    object
    SerializerDetails
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Akka.Serialization
    Assembly: Akka.dll
    Syntax
    public sealed class SerializerDetails

    Properties

    | Edit this page View Source

    Alias

    The name of the serializer - must be unique.

    Declaration
    public string Alias { get; }
    Property Value
    Type Description
    string
    Examples

    i.e. "json" for the global JSON.NET serializer "IDomainSerializer" for a custom serializer that serializes "IDomain" messages, etc.

    | Edit this page View Source

    Serializer

    The serializer that belongs to this Alias.

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

    UseFor

    The types of messages that this

    Declaration
    public ImmutableHashSet<Type> UseFor { get; }
    Property Value
    Type Description
    ImmutableHashSet<Type>

    Methods

    | Edit this page View Source

    Create(string, Serializer, ImmutableHashSet<Type>)

    Factory method for creating programmatic setups for Serializers.

    Declaration
    public static SerializerDetails Create(string alias, Serializer serializer, ImmutableHashSet<Type> useFor)
    Parameters
    Type Name Description
    string alias

    Register the serializer under this alias (this allows it to be used by bindings in the config)

    Serializer serializer

    The serializer implementation.

    ImmutableHashSet<Type> useFor

    A set of types (classes, base classes, or interfaces) that will be bound to this serializer. This is the programmatic equivalent of the akka.actor.serialization.serialization-bindings HOCON section.

    Returns
    Type Description
    SerializerDetails

    Extension Methods

    ObjectExtensions.IsDefaultForType<T>(T)
    ObjectExtensions.AsOption<T>(T)
    Extensions.AsInstanceOf<T>(object)
    In this article
    • githubEdit this page
    • View Source
    Back to top
    Contribute
    • Project Chat
    • Discussion Forum
    • Source Code
    Support
    • Akka.NET Support Plans
    • Akka.NET Observability Tools
    • Akka.NET Training & Consulting
    Maintained By
    • Petabridge - The Akka.NET Company
    • Learn Akka.NET