T:Hjson.IHjsonDsfProvider

January 18, 2017 ยท View on GitHub

Hjson

T:Hjson.IHjsonDsfProvider

A interface to support Domain Specific Formats for Hjson.

P:Hjson.IHjsonDsfProvider.Name

Gets the name of this DSF.

P:Hjson.IHjsonDsfProvider.Description

Gets the description of this DSF.

M:Hjson.IHjsonDsfProvider.Parse(System.String)

Tries to parse the text as a DSF value.

M:Hjson.IHjsonDsfProvider.Stringify(Hjson.JsonValue)

Stringifies DSF values.

T:Hjson.HjsonDsf

Provides standard DSF providers.

M:Hjson.HjsonDsf.Math

Returns a math DSF provider.

M:Hjson.HjsonDsf.Hex(System.Boolean)

Returns a hex DSF provider.

M:Hjson.HjsonDsf.Date

Returns a date DSF provider.

T:Hjson.HjsonOptions

Options for Save.

M:Hjson.HjsonOptions.#ctor

Initializes a new instance of this class.

P:Hjson.HjsonOptions.KeepWsc

Keep white space and comments.

P:Hjson.HjsonOptions.EmitRootBraces

Show braces at the root level (default true).

P:Hjson.HjsonOptions.DsfProviders

Gets or sets DSF providers.

T:Hjson.HjsonValue

Contains functions to load and save in the Hjson format.

M:Hjson.HjsonValue.Load(System.String)

Loads Hjson/JSON from a file.

M:Hjson.HjsonValue.Load(System.String,Hjson.HjsonOptions)

Loads Hjson/JSON from a file, optionally preserving whitespace and comments.

M:Hjson.HjsonValue.Load(System.IO.Stream)

Loads Hjson/JSON from a stream.

M:Hjson.HjsonValue.Load(System.IO.Stream,Hjson.HjsonOptions)

Loads Hjson/JSON from a stream, optionally preserving whitespace and comments.

M:Hjson.HjsonValue.Load(System.IO.TextReader,Hjson.IJsonReader)

Loads Hjson/JSON from a TextReader.

M:Hjson.HjsonValue.Load(System.IO.TextReader,Hjson.HjsonOptions,Hjson.IJsonReader)

Loads Hjson/JSON from a TextReader, optionally preserving whitespace and comments.

M:Hjson.HjsonValue.LoadWsc(System.IO.TextReader)

Loads Hjson/JSON from a TextReader, preserving whitespace and comments.

M:Hjson.HjsonValue.Parse(System.String)

Parses the specified Hjson/JSON string.

M:Hjson.HjsonValue.Parse(System.String,Hjson.HjsonOptions)

Parses the specified Hjson/JSON string, optionally preserving whitespace and comments.

M:Hjson.HjsonValue.Save(Hjson.JsonValue,System.String,Hjson.HjsonOptions)

Saves Hjson to a file.

M:Hjson.HjsonValue.Save(Hjson.JsonValue,System.IO.Stream,Hjson.HjsonOptions)

Saves Hjson to a stream.

M:Hjson.HjsonValue.Save(Hjson.JsonValue,System.IO.TextWriter,Hjson.HjsonOptions)

Saves Hjson to a TextWriter.

M:Hjson.HjsonValue.Load(System.String,System.Boolean)

Loads Hjson/JSON from a file, optionally preserving whitespace and comments.

M:Hjson.HjsonValue.Load(System.IO.Stream,System.Boolean)

Loads Hjson/JSON from a stream, optionally preserving whitespace and comments.

M:Hjson.HjsonValue.Load(System.IO.TextReader,System.Boolean,Hjson.IJsonReader)

Loads Hjson/JSON from a TextReader, optionally preserving whitespace and comments.

M:Hjson.HjsonValue.Parse(System.String,System.Boolean)

Parses the specified Hjson/JSON string, optionally preserving whitespace and comments.

T:Hjson.WscJsonObject

Implements an object value, including whitespace and comments.

M:Hjson.WscJsonObject.#ctor

Initializes a new instance of this class.

P:Hjson.WscJsonObject.RootBraces

Defines if braces are shown (root object only).

P:Hjson.WscJsonObject.Order

Defines the order of the keys.

P:Hjson.WscJsonObject.Comments

Defines a comment for each key. The "" entry is emitted before any element.

T:Hjson.WscJsonArray

Implements an array value, including whitespace and comments.

M:Hjson.WscJsonArray.#ctor

Initializes a new instance of this class.

P:Hjson.WscJsonArray.Comments

Defines a comment for each item. The [0] entry is emitted before any element.

T:Hjson.IJsonReader

Defines the reader interface.

M:Hjson.IJsonReader.Key(System.String)

Triggered when an item for an object is read.

M:Hjson.IJsonReader.Index(System.Int32)

Triggered when an item for an array is read.

M:Hjson.IJsonReader.Value(Hjson.JsonValue)

Triggered when a value is read.

T:Hjson.JsonArray

Implements an array value.

M:Hjson.JsonArray.#ctor(Hjson.JsonValue[])

Initializes a new instance of this class.

M:Hjson.JsonArray.#ctor(System.Collections.Generic.IEnumerable{Hjson.JsonValue})

Initializes a new instance of this class.

P:Hjson.JsonArray.Count

Gets the count of the contained items.

P:Hjson.JsonArray.Item(System.Int32)

Gets or sets the value for the specified index.

P:Hjson.JsonArray.JsonType

The type of this value.

M:Hjson.JsonArray.Add(Hjson.JsonValue)

Adds a new item.

M:Hjson.JsonArray.AddRange(System.Collections.Generic.IEnumerable{Hjson.JsonValue})

Adds a range of items.

M:Hjson.JsonArray.Clear

Clears the array.

M:Hjson.JsonArray.Contains(Hjson.JsonValue)

Determines whether the array contains a specific value.

M:Hjson.JsonArray.CopyTo(Hjson.JsonValue[],System.Int32)

Copies the elements to an System.Array, starting at a particular System.Array index.

M:Hjson.JsonArray.IndexOf(Hjson.JsonValue)

Determines the index of a specific item.

M:Hjson.JsonArray.Insert(System.Int32,Hjson.JsonValue)

Inserts an item.

M:Hjson.JsonArray.Remove(Hjson.JsonValue)

Removes the specified item.

M:Hjson.JsonArray.RemoveAt(System.Int32)

Removes the item with the specified index.

T:Hjson.JsonObject

Implements an object value.

M:Hjson.JsonObject.#ctor(System.Collections.Generic.KeyValuePair{System.String,Hjson.JsonValue}[])

Initializes a new instance of this class.

You can also initialize an object using the C# add syntax: new JsonObject { { "key", "value" }, ... }

M:Hjson.JsonObject.#ctor(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,Hjson.JsonValue}})

Initializes a new instance of this class.

You can also initialize an object using the C# add syntax: new JsonObject { { "key", "value" }, ... }

P:Hjson.JsonObject.Count

Gets the count of the contained items.

P:Hjson.JsonObject.Item(System.String)

Gets or sets the value for the specified key.

P:Hjson.JsonObject.JsonType

The type of this value.

P:Hjson.JsonObject.Keys

Gets the keys of this object.

P:Hjson.JsonObject.Values

Gets the values of this object.

M:Hjson.JsonObject.Add(System.String,Hjson.JsonValue)

Adds a new item.

You can also initialize an object using the C# add syntax: new JsonObject { { "key", "value" }, ... }

M:Hjson.JsonObject.Add(System.Collections.Generic.KeyValuePair{System.String,Hjson.JsonValue})

Adds a new item.

M:Hjson.JsonObject.AddRange(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,Hjson.JsonValue}})

Adds a range of items.

M:Hjson.JsonObject.Clear

Clears the object.

M:Hjson.JsonObject.ContainsKey(System.String)

Determines whether the array contains a specific key.

M:Hjson.JsonObject.CopyTo(System.Collections.Generic.KeyValuePair{System.String,Hjson.JsonValue}[],System.Int32)

Copies the elements to an System.Array, starting at a particular System.Array index.

M:Hjson.JsonObject.Remove(System.String)

Removes the item with the specified key.

NameDescription
key:The key of the element to remove.
Returns: true if the element is successfully found and removed; otherwise, false.
M:Hjson.JsonObject.TryGetValue(System.String,Hjson.JsonValue@)

Gets the value associated with the specified key.

T:Hjson.JsonPrimitive

Implements a primitive value.

M:Hjson.JsonPrimitive.#ctor(System.String)

Initializes a new string.

M:Hjson.JsonPrimitive.#ctor(System.Char)

Initializes a new char.

M:Hjson.JsonPrimitive.#ctor(System.Boolean)

Initializes a new bool.

M:Hjson.JsonPrimitive.#ctor(System.Decimal)

Initializes a new decimal.

M:Hjson.JsonPrimitive.#ctor(System.Double)

Initializes a new double.

M:Hjson.JsonPrimitive.#ctor(System.Single)

Initializes a new float.

M:Hjson.JsonPrimitive.#ctor(System.Int64)

Initializes a new long.

M:Hjson.JsonPrimitive.#ctor(System.Int32)

Initializes a new int.

M:Hjson.JsonPrimitive.#ctor(System.Byte)

Initializes a new byte.

M:Hjson.JsonPrimitive.#ctor(System.Int16)

Initializes a new short.

P:Hjson.JsonPrimitive.JsonType

The type of this value.

T:Hjson.JsonType

Defines the known json types.

There is no null type as the primitive will be null instead of the JsonPrimitive containing null.

F:Hjson.JsonType.String

Json value of type string.

F:Hjson.JsonType.Number

Json value of type number.

F:Hjson.JsonType.Object

Json value of type object.

F:Hjson.JsonType.Array

Json value of type array.

F:Hjson.JsonType.Boolean

Json value of type boolean.

F:Hjson.JsonType.Unknown

Json value of an unknown type.

T:Hjson.JsonUtil

Provides Json extension methods.

M:Hjson.JsonUtil.Qb(Hjson.JsonValue)

For JsonValues with type boolean, this method will return its value as bool, otherwise it will throw.

M:Hjson.JsonUtil.Qb(Hjson.JsonObject,System.String,System.Boolean)

Gets the value of the member specified by key, then calls [[|M:Hjson.JsonUtil.Qb(Hjson.JsonValue)]]. If the object does not contain the key, the defaultValue is returned.

M:Hjson.JsonUtil.Qi(Hjson.JsonValue)

For JsonValues with type number, this method will return its value as int, otherwise it will throw.

M:Hjson.JsonUtil.Qi(Hjson.JsonObject,System.String,System.Int32)

Gets the value of the member specified by key, then calls [[|M:Hjson.JsonUtil.Qi(Hjson.JsonValue)]]. If the object does not contain the key, the defaultValue is returned.

M:Hjson.JsonUtil.Ql(Hjson.JsonValue)

For JsonValues with type number, this method will return its value as long, otherwise it will throw.

M:Hjson.JsonUtil.Ql(Hjson.JsonObject,System.String,System.Int64)

Gets the value of the member specified by key, then calls [[|M:Hjson.JsonUtil.Ql(Hjson.JsonValue)]]. If the object does not contain the key, the defaultValue is returned.

M:Hjson.JsonUtil.Qd(Hjson.JsonValue)

For JsonValues with type number, this method will return its value as double, otherwise it will throw.

M:Hjson.JsonUtil.Qd(Hjson.JsonObject,System.String,System.Double)

Gets the value of the member specified by key, then calls [[|M:Hjson.JsonUtil.Qd(Hjson.JsonValue)]]. If the object does not contain the key, the defaultValue is returned.

M:Hjson.JsonUtil.Qs(Hjson.JsonValue)

For JsonValues with type string, this method will return its value as string, otherwise it will throw. Use [[|M:Hjson.JsonUtil.Qstr(Hjson.JsonValue)]] to get a string value from number or boolean types as well.

M:Hjson.JsonUtil.Qs(Hjson.JsonObject,System.String,System.String)

Gets the value of the member specified by key, then calls [[|M:Hjson.JsonUtil.Qs(Hjson.JsonValue)]]. If the object does not contain the key, the defaultValue is returned.

M:Hjson.JsonUtil.Qstr(Hjson.JsonValue)

For JsonValues with type string, number or boolean, this method will return its value as a string (converted if necessary). For arrays or objects it will throw.

M:Hjson.JsonUtil.Qstr(Hjson.JsonObject,System.String,System.String)

Gets the value of the member specified by key, then, for string, number or boolean JsonValues, this method will return its value as a string (converted if necessary).

M:Hjson.JsonUtil.Qv(Hjson.JsonObject,System.String)

Gets the JsonValue of the member specified by key.

M:Hjson.JsonUtil.Qo(Hjson.JsonObject,System.String)

Gets a JsonObject from a JsonObject.

M:Hjson.JsonUtil.Qo(Hjson.JsonValue)

Gets the JsonObject from a JsonValue.

M:Hjson.JsonUtil.Qa(Hjson.JsonObject,System.String)

Gets a JsonArray from a JsonObject.

M:Hjson.JsonUtil.Qa(Hjson.JsonValue)

Gets the JsonArray from a JsonValue.

M:Hjson.JsonUtil.Qqo(Hjson.JsonObject)

Enumerates JsonObjects from a JsonObject.

M:Hjson.JsonUtil.ToJsonDate(System.DateTime)

Convert the date to json (unix epoch date offset).

M:Hjson.JsonUtil.ToDateTime(System.Int64)

Convert the json date (unix epoch date offset) to a DateTime.

M:Hjson.JsonUtil.ToJson(System.DateTime)

Convert the date to JSON/ISO 8601, compatible with ES5 Date.toJSON().

Use DateTime.Parse() to convert back (will be of local kind).

M:Hjson.JsonUtil.ToPrecise(System.DateTime)

Convert the date to a precise string representations (ten millionths of a second).

Use DateTime.Parse() to convert back (will be of local kind).

M:Hjson.JsonUtil.ToJson(System.TimeSpan)

Convert the timespan to JSON/ISO 8601.

T:Hjson.Stringify

The ToString format.

F:Hjson.Stringify.Plain

JSON (no whitespace).

F:Hjson.Stringify.Formatted

Formatted JSON.

F:Hjson.Stringify.Hjson

Hjson.

T:Hjson.JsonValue

JsonValue is the abstract base class for all values (string, number, true, false, null, object or array).

P:Hjson.JsonValue.Eol

Gets or sets the newline charater(s).

Defaults to Environment.NewLine.

P:Hjson.JsonValue.Count

Gets the count of the contained items for arrays/objects.

P:Hjson.JsonValue.JsonType

The type of this value.

P:Hjson.JsonValue.Item(System.Int32)

Gets or sets the value for the specified index.

P:Hjson.JsonValue.Item(System.String)

Gets or sets the value for the specified key.

M:Hjson.JsonValue.ContainsKey(System.String)

Returns true if the object contains the specified key.

M:Hjson.JsonValue.Save(System.String,Hjson.Stringify)

Saves the JSON to a file.

M:Hjson.JsonValue.Save(System.IO.Stream,Hjson.Stringify)

Saves the JSON to a stream.

M:Hjson.JsonValue.Save(System.IO.TextWriter,Hjson.Stringify)

Saves the JSON to a TextWriter.

M:Hjson.JsonValue.ToString(Hjson.HjsonOptions)

Saves as Hjson to a string.

M:Hjson.JsonValue.ToString(Hjson.Stringify)

Saves the JSON to a string.

M:Hjson.JsonValue.ToString

Saves the JSON to a string.

M:Hjson.JsonValue.ToValue

Returns the contained primitive value.

M:Hjson.JsonValue.FromObject(System.Object)

Wraps an unknown object into a JSON value (to be used with DSF).

M:Hjson.JsonValue.Load(System.String)

Loads JSON from a file.

M:Hjson.JsonValue.Load(System.IO.Stream)

Loads JSON from a stream.

M:Hjson.JsonValue.Load(System.IO.TextReader,Hjson.IJsonReader)

Loads JSON from a TextReader.

M:Hjson.JsonValue.Parse(System.String)

Parses the specified JSON string.

M:Hjson.JsonValue.op_Implicit(System.Boolean)~Hjson.JsonValue

Converts from bool.

M:Hjson.JsonValue.op_Implicit(System.Byte)~Hjson.JsonValue

Converts from byte.

M:Hjson.JsonValue.op_Implicit(System.Char)~Hjson.JsonValue

Converts from char.

M:Hjson.JsonValue.op_Implicit(System.Decimal)~Hjson.JsonValue

Converts from decimal.

M:Hjson.JsonValue.op_Implicit(System.Double)~Hjson.JsonValue

Converts from double.

M:Hjson.JsonValue.op_Implicit(System.Single)~Hjson.JsonValue

Converts from float.

M:Hjson.JsonValue.op_Implicit(System.Int32)~Hjson.JsonValue

Converts from int.

M:Hjson.JsonValue.op_Implicit(System.Int64)~Hjson.JsonValue

Converts from long.

M:Hjson.JsonValue.op_Implicit(System.Int16)~Hjson.JsonValue

Converts from short.

M:Hjson.JsonValue.op_Implicit(System.String)~Hjson.JsonValue

Converts from string.

M:Hjson.JsonValue.op_Implicit(Hjson.JsonValue)~System.Boolean

Converts to bool. Also see [[|T:Hjson.JsonUtil]].

M:Hjson.JsonValue.op_Implicit(Hjson.JsonValue)~System.Byte

Converts to byte. Also see [[|T:Hjson.JsonUtil]].

M:Hjson.JsonValue.op_Implicit(Hjson.JsonValue)~System.Char

Converts to char. Also see [[|T:Hjson.JsonUtil]].

M:Hjson.JsonValue.op_Implicit(Hjson.JsonValue)~System.Decimal

Converts to decimal. Also see [[|T:Hjson.JsonUtil]].

M:Hjson.JsonValue.op_Implicit(Hjson.JsonValue)~System.Double

Converts to double. Also see [[|T:Hjson.JsonUtil]].

M:Hjson.JsonValue.op_Implicit(Hjson.JsonValue)~System.Single

Converts to float. Also see [[|T:Hjson.JsonUtil]].

M:Hjson.JsonValue.op_Implicit(Hjson.JsonValue)~System.Int32

Converts to int. Also see [[|T:Hjson.JsonUtil]].

M:Hjson.JsonValue.op_Implicit(Hjson.JsonValue)~System.Int64

Converts to long. Also see [[|T:Hjson.JsonUtil]].

M:Hjson.JsonValue.op_Implicit(Hjson.JsonValue)~System.Int16

Converts to short. Also see [[|T:Hjson.JsonUtil]].

M:Hjson.JsonValue.op_Implicit(Hjson.JsonValue)~System.String

Converts to string. Also see [[|T:Hjson.JsonUtil]].