Class LibraryJson

Namespace

RDCore.SDK.Runtime.Libraries

Assembly

RDCore.SDK.dll

Reads and writes the file a library is described in (LibraryDescription).

public static class LibraryJson

Inheritance

object

LibraryJson

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The format is JSON with camel-case names and enumerations as strings: it is read by people in a review as much as by the platform. What is not stated is left out when the file is written, so a description does not grow a line for every default; comments and trailing commas are accepted when it is read, for the file that is edited by hand.

Fields

CurrentFormatVersion

The version of the format this writes and reads.

public const int CurrentFormatVersion = 1

Field Value

int

Methods

Read(string)

Reads a description.

public static LibraryDescription Read(string json)

Parameters

json string

The text of the file.

Returns

LibraryDescription

Exceptions

InvalidDataException

The text is not a description this reads: it is not JSON of the format, has no name, or is of a format version this does not know.

Write(LibraryDescription)

Writes a description as the text of its file.

public static string Write(LibraryDescription description)

Parameters

description LibraryDescription

The description.

Returns

string