docs.unity.cn
    Show / Hide Table of Contents

    Struct BinarySerializationParameters

    Custom parameters to use for binary serialization or deserialization.

    Inherited Members
    ValueType.Equals(Object)
    ValueType.GetHashCode()
    ValueType.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: Unity.Serialization.Binary
    Syntax
    public struct BinarySerializationParameters

    Properties

    DisableRootAdapters

    By default, adapters are evaluated for root objects. Use this to change the default behaviour.

    Declaration
    public bool DisableRootAdapters { readonly get; set; }
    Property Value
    Type Description
    Boolean

    DisableSerializedReferences

    By default, references between objects are serialized. Use this to always write a copy of the object to the output.

    Declaration
    public bool DisableSerializedReferences { readonly get; set; }
    Property Value
    Type Description
    Boolean

    RequiresThreadSafety

    This parameter indicates if the serializer should be thread safe. The default value is false.

    Declaration
    public bool RequiresThreadSafety { readonly get; set; }
    Property Value
    Type Description
    Boolean
    Remarks

    Setting this to true will cause managed allocations for the internal visitor.

    SerializedType

    By default, a polymorphic root type will have it's assembly qualified type name written to the stream. Use this parameter to provide a known root type at both serialize and deserialize time to avoid writing this information.

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

    State

    Sets the state object for serialization. This can be used to share resources across multiple calls to serialize and deserialize.

    Declaration
    public BinarySerializationState State { readonly get; set; }
    Property Value
    Type Description
    BinarySerializationState

    UserDefinedAdapters

    Provide a custom set of adapters for the serialization and deserialization.

    Declaration
    public List<IBinaryAdapter> UserDefinedAdapters { readonly get; set; }
    Property Value
    Type Description
    List<IBinaryAdapter>
    Remarks

    These adapters will be evaluated first before any global or built in adapters.

    Back to top Copyright © 2023 Unity Technologies
    Generated by DocFX
    on Monday, February 13, 2023
    Terms of use