Class fsBaseConverter

The serialization converter allows for customization of the serialization process.

Inheritance
Object
fsBaseConverter
fsConverter
fsDirectConverter
Namespace: Unity.VisualScripting.FullSerializer
Syntax
public abstract class fsBaseConverter
Remarks

You do not want to derive from this class - there is no way to actually use it within the serializer.. Instead, derive from either fsConverter or fsDirectConverter

Fields

Serializer

The serializer that was owns this converter.

Declaration
public fsSerializer Serializer
Field Value
Type Description
fsSerializer

Methods

CheckKey(Dictionary<String, fsData>, String, out fsData)

Declaration
protected fsResult CheckKey(Dictionary<string, fsData> data, string key, out fsData subitem)
Parameters
Type Name Description
Dictionary<String, fsData> data
String key
fsData subitem
Returns
Type Description
fsResult

CheckKey(fsData, String, out fsData)

Declaration
protected fsResult CheckKey(fsData data, string key, out fsData subitem)
Parameters
Type Name Description
fsData data
String key
fsData subitem
Returns
Type Description
fsResult

CheckType(fsData, fsDataType)

Declaration
protected fsResult CheckType(fsData data, fsDataType type)
Parameters
Type Name Description
fsData data
fsDataType type
Returns
Type Description
fsResult

CreateInstance(fsData, Type)

Construct an object instance that will be passed to TryDeserialize. This should not deserialize the object.

Declaration
public virtual object CreateInstance(fsData data, Type storageType)
Parameters
Type Name Description
fsData data

The data the object was serialized with.
Type storageType

The field/property type that is storing the instance.
Returns
Type Description
Object

An object instance

DeserializeMember<T>(Dictionary<String, fsData>, Type, String, out T)

Declaration
protected fsResult DeserializeMember<T>(Dictionary<string, fsData> data, Type overrideConverterType, string name, out T value)
Parameters
Type Name Description
Dictionary<String, fsData> data
Type overrideConverterType
String name
T value
Returns
Type Description
fsResult
Type Parameters
Name Description
T

FailExpectedType(fsData, fsDataType[])

Declaration
protected fsResult FailExpectedType(fsData data, params fsDataType[] types)
Parameters
Type Name Description
fsData data
fsDataType[] types
Returns
Type Description
fsResult

RequestCycleSupport(Type)

If true, then the serializer will support cyclic references with the given converted type.

Declaration
public virtual bool RequestCycleSupport(Type storageType)
Parameters
Type Name Description
Type storageType

The field/property type that is currently storing the object that is being serialized.
Returns
Type Description
Boolean

RequestInheritanceSupport(Type)

If true, then the serializer will include inheritance data for the given converter.

Declaration
public virtual bool RequestInheritanceSupport(Type storageType)
Parameters
Type Name Description
Type storageType

The field/property type that is currently storing the object that is being serialized.
Returns
Type Description
Boolean

SerializeMember<T>(Dictionary<String, fsData>, Type, String, T)

Declaration
protected fsResult SerializeMember<T>(Dictionary<string, fsData> data, Type overrideConverterType, string name, T value)
Parameters
Type Name Description
Dictionary<String, fsData> data
Type overrideConverterType
String name
T value
Returns
Type Description
fsResult
Type Parameters
Name Description
T

TryDeserialize(fsData, ref Object, Type)

Deserialize data into the object instance.

Declaration
public abstract fsResult TryDeserialize(fsData data, ref object instance, Type storageType)
Parameters
Type Name Description
fsData data

Serialization data to deserialize from.
Object instance

The object instance to deserialize into.
Type storageType

The field/property type that is storing the instance.
Returns
Type Description
fsResult

True if serialization was successful, false otherwise.

TrySerialize(Object, out fsData, Type)

Serialize the actual object into the given data storage.

Declaration
public abstract fsResult TrySerialize(object instance, out fsData serialized, Type storageType)
Parameters
Type Name Description
Object instance

The object instance to serialize. This will never be null.
fsData serialized

The serialized state.
Type storageType

The field/property type that is storing this instance.
Returns
Type Description
fsResult

If serialization was successful.

Extension Methods