JsonValue

Description

sealed class Tinman.Core.Formatting.JsonValue

Derived from: IJsonValue

Represents a mutable JSON value.

A formatted JSON value must be written in the following Grammar:

json     := value ;

array    := '[' (value .. ',')? ']' ;
member   := string ':' value ;
object   := '{' (comment* member .. ',')? '}' ;
value    := 'false' | 'null' | 'true' | object | array | number | string ;

string   := '"' (no-chars+ | escape)* '"' ;

escape   := '\\' (["/\\bfnrt] | 'u' hexdigit[4]) ;

hexdigit := 'a'..'f' | 'A'..'F' | digit ;
number   := '-'? ('0' | '1'..'9' digit*) ('.' digit+)? (('e' | 'E') ('+' | '-')? digit+)? ;

comment  := '//' ' '? ]\n\r[* '\r'? '\n' ;
digit    := '0'..'9' ;
no-chars := ]\0\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0B\x0C\r\x0E\x0F\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F"\\[ ;

The following methods may be used to set the value, changing the value type:

Set¹ : null
Set² : boolean
Set³ : integer
Set⁴ : integer
Set⁵ : number
Set⁶ : string

The following methods may be used to build array values, changing the value type to array:

Element¹
Element²
Element³
Element⁴
Element⁵
Element⁶
ElementAdd
ElementPrepare

The following methods may be used to build object values, changing the value type to object:

Member¹
Member²
Member³
Member⁴
Member⁵
Member⁶
MemberAdd
MemberPrepare

The IJsonValue interface may be used to pass around read-only references to JsonValue objects.

Public / Constants

Empty

[ShutdownSurvive]
public static readonly attribute Empty → (IJsonValue)

The JSON value for the empty string.

This is not a singleton value, there may be other JsonValue objects that are equal to this one.

See also: IJsonValue.IsString

False

[ShutdownSurvive]
public static readonly attribute False → (IJsonValue)

The false JSON value.

This is not a singleton value, there may be other JsonValue objects that are equal to this one.

See also: IJsonValue.IsBoolean

Null

[ShutdownSurvive]
public static readonly attribute Null → (IJsonValue)

The null JSON value.

This is not a singleton value, there may be other JsonValue objects that are equal to this one.

See also: IJsonValue.IsNull

True

[ShutdownSurvive]
public static readonly attribute True → (IJsonValue)

The true JSON value.

This is not a singleton value, there may be other JsonValue objects that are equal to this one.

See also: IJsonValue.IsBoolean

Public / Constructors

From

_2 overloads

public static method From¹ → (1)

text ⁱⁿ : string: [not-null]
The JSON code.
returns → JsonValue: The JsonValue object.

Creates a JsonValue from the given text.

ValidatingException: If the given source code text ⁱⁿ is malformed.

See also: IJsonValue.ToString

public static method From² → (1)

value ⁱⁿ : IJsonValue: The source value.
returns → JsonValue: The JsonValue object. Will be the same object as value ⁱⁿ if the latter is an instance of JsonValue.

Creates a new instance of JsonValue.

FromFile

public static method FromFile → (1)

file ⁱⁿ : Path: [not-null]
The file path.
returns → JsonValue: The JsonValue object or Null if the file does not exist.

Creates a JsonValue from the given file.

The given file ⁱⁿ is expected to be in UTF-8 encoding, without BOM.

IOException: If an I/O error has occurred.

ValidatingException: If the given file ⁱⁿ contains malformed source code.

See also: IJsonValue.ToFile

JsonValue

public constructor JsonValue → ()

Creates a new instance of JsonValue.

See also: IJsonValue.IsNull

Public / Methods