Loading...
Searching...
No Matches
SerializationContext Interface Reference

Base class for serialization contexts. More...

Inheritance diagram for SerializationContext:
BaseSerializationContext LoadContext SaveContext BaseSerializationLoadContext LoadContainerContext BufferSaveContext BufferSaveContext SaveContainerContext BinaryLoadContext ContainerSerializationLoadContext JsonLoadContext BinarySaveContext ContainerSerializationSaveContext JsonSaveContext SCR_BinLoadContext SCR_PersistenceBinaryLoadContext SCR_JsonLoadContext SCR_PersistenceJsonLoadContext SCR_BinSaveContext SCR_PersistenceBinarySaveContext PrettyJsonSaveContext SCR_JsonSaveContext SCR_PersistenceJsonSaveContext

Public Member Functions

proto external bool CanSeekMembers ()
 
proto external bool IsValid ()
 
proto external string GetDataExtension ()
 
proto external void ConfigureTypeDiscriminator (string fieldName="$type")
 Type discriminator is used to add polymorph object instance support to the serializer.
 
proto external bool EnableTypeDiscriminator (bool enabled)
 Enable or disable, can be used to pause it for a specific variable and resume after it was written.
 
proto external bool IsTypeDiscriminatorEnabled ()
 Is the type discrimiation currently enabled.
 
proto external void Reset ()
 Reset buffers to re-use for new data.
 
proto bool StartMap (string name, out int count)
 Start new map. Empty name will result in an anonymous map. Count must be known ahead of time.
 
proto external bool EndMap ()
 
proto bool StartArray (string name, out int count)
 Start new array. Empty name will result in an anonymous array. Count must be known ahead of time.
 
proto external bool EndArray ()
 
proto external bool StartObject (string name=string.Empty)
 Start new subobject. Empty name will result in an anonymous object.
 
proto external bool EndObject ()
 

Detailed Description

Base class for serialization contexts.

Member Function Documentation

◆ CanSeekMembers()

proto external bool SerializationContext.CanSeekMembers ( )

◆ ConfigureTypeDiscriminator()

proto external void SerializationContext.ConfigureTypeDiscriminator ( string fieldName = "$type")

Type discriminator is used to add polymorph object instance support to the serializer.

Type is written inside the object when saving. When the load happens, it creates the instance based on this type.

◆ EnableTypeDiscriminator()

proto external bool SerializationContext.EnableTypeDiscriminator ( bool enabled)

Enable or disable, can be used to pause it for a specific variable and resume after it was written.

Returns
Previous value

◆ EndArray()

proto external bool SerializationContext.EndArray ( )

◆ EndMap()

proto external bool SerializationContext.EndMap ( )

◆ EndObject()

proto external bool SerializationContext.EndObject ( )

◆ GetDataExtension()

proto external string SerializationContext.GetDataExtension ( )

◆ IsTypeDiscriminatorEnabled()

proto external bool SerializationContext.IsTypeDiscriminatorEnabled ( )

Is the type discrimiation currently enabled.

◆ IsValid()

proto external bool SerializationContext.IsValid ( )

◆ Reset()

proto external void SerializationContext.Reset ( )

Reset buffers to re-use for new data.

◆ StartArray()

proto bool SerializationContext.StartArray ( string name,
out int count )

Start new array. Empty name will result in an anonymous array. Count must be known ahead of time.

◆ StartMap()

proto bool SerializationContext.StartMap ( string name,
out int count )

Start new map. Empty name will result in an anonymous map. Count must be known ahead of time.

◆ StartObject()

proto external bool SerializationContext.StartObject ( string name = string.Empty)

Start new subobject. Empty name will result in an anonymous object.


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