EGDL2 2.1
Loading...
Searching...
No Matches
FullSerializer.fsBaseConverter Class Referenceabstract

The serialization converter allows for customization of the serialization process. More...

Inheritance diagram for FullSerializer.fsBaseConverter:

Public Member Functions

virtual object CreateInstance (fsData data, Type storageType)
 Construct an object instance that will be passed to TryDeserialize. This should not deserialize the object.
 
virtual bool RequestCycleSupport (Type storageType)
 If true, then the serializer will support cyclic references with the given converted type.
 
virtual bool RequestInheritanceSupport (Type storageType)
 If true, then the serializer will include inheritance data for the given converter.
 
fsResult TrySerialize (object instance, out fsData serialized, Type storageType)
 Serialize the actual object into the given data storage.
 
fsResult TryDeserialize (fsData data, ref object instance, Type storageType)
 Deserialize data into the object instance.
 

Public Attributes

fsSerializer Serializer
 The serializer that was owns this converter.
 

Detailed Description

The serialization converter allows for customization of the serialization process.

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

Member Function Documentation

◆ CreateInstance()

virtual object FullSerializer.fsBaseConverter.CreateInstance ( fsData data,
Type storageType )
inlinevirtual

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

Parameters
dataThe data the object was serialized with.
storageTypeThe field/property type that is storing the instance.
Returns
An object instance

Reimplemented in FullSerializer.Internal.fsEnumConverter, FullSerializer.Internal.fsGuidConverter, FullSerializer.Internal.fsIEnumerableConverter, FullSerializer.Internal.fsNullableConverter, and FullSerializer.Internal.fsWeakReferenceConverter.

Here is the call graph for this function:

◆ RequestCycleSupport()

virtual bool FullSerializer.fsBaseConverter.RequestCycleSupport ( Type storageType)
inlinevirtual

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

Parameters
storageTypeThe field/property type that is currently storing the object that is being serialized.

Reimplemented in FullSerializer.Internal.fsEnumConverter, FullSerializer.Internal.fsGuidConverter, and FullSerializer.Internal.fsWeakReferenceConverter.

Here is the caller graph for this function:

◆ RequestInheritanceSupport()

virtual bool FullSerializer.fsBaseConverter.RequestInheritanceSupport ( Type storageType)
inlinevirtual

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

Parameters
storageTypeThe field/property type that is currently storing the object that is being serialized.

Reimplemented in FullSerializer.Internal.fsEnumConverter, FullSerializer.Internal.fsGuidConverter, and FullSerializer.Internal.fsWeakReferenceConverter.

◆ TryDeserialize()

fsResult FullSerializer.fsBaseConverter.TryDeserialize ( fsData data,
ref object instance,
Type storageType )
abstract

Deserialize data into the object instance.

Parameters
dataSerialization data to deserialize from.
instanceThe object instance to deserialize into.
storageTypeThe field/property type that is storing the instance.
Returns
True if serialization was successful, false otherwise.

◆ TrySerialize()

fsResult FullSerializer.fsBaseConverter.TrySerialize ( object instance,
out fsData serialized,
Type storageType )
abstract

Serialize the actual object into the given data storage.

Parameters
instanceThe object instance to serialize. This will never be null.
serializedThe serialized state.
storageTypeThe field/property type that is storing this instance.
Returns
If serialization was successful.

The documentation for this class was generated from the following file: