Interface IStructureSerializer

Namespace

NanoByte.StructureEditor

Assembly

NanoByte.StructureEditor.dll

Converts nodes in the structure to and from a textual representation (e.g., XML or JSON).

public interface IStructureSerializer

Properties

FormatName

The name of the format (e.g., XML or JSON). Used to determine syntax highlighting.

string FormatName { get; }

Property Value

string

Methods

Deserialize<T>(string)

Deserializes an object from a string.

T Deserialize<T>(string text) where T : class

Parameters

text string

The serialized representation of the object.

Returns

T

Type Parameters

T

The type of object to deserialize.

Exceptions

Exception

The text is not a valid serialized representation of T.

Serialize<T>(T)

Serializes an object to a string.

string Serialize<T>(T value) where T : class

Parameters

value T

The object to serialize.

Returns

string

Type Parameters

T

The type to serialize the object as.

TryGetErrorLocation(Exception, out int, out int, out string)

Extracts the location of an error from an exception thrown by Deserialize<T>(string).

bool TryGetErrorLocation(Exception exception, out int line, out int column, out string message)

Parameters

exception Exception

The exception thrown by Deserialize<T>(string).

line int

The 1-based line number of the error.

column int

The 1-based column number of the error.

message string

A message describing the error.

Returns

bool

true if the location could be determined; false otherwise.