IJsonWriter

Description

interface Tinman.Core.Json.IJsonWriter

Derived from: IPathInfo
Extended by: IJsonStream

Base interface for classes that allow sequential writing of JSON data.

To write a single JSON value, use one of the following methods:

Write a primitive value:
Write¹, Write², Write³, Write⁴, Write⁵
Write an array of values with this sequence:
- WriteArrayBegin
- Write zero or more JSON values.
- WriteArrayEnd
Write an object with this sequence:
- WriteObjectBegin
- (A) Write the member name with WriteMember.
- Write exactly one JSON value.
- Jump to (A) zero or more times.
- WriteObjectEnd

Public / Methods

Write

_5 overloads

public method Write¹ → ()

Writes a null JSON value.

IOException: If an I/O error has occurred.

See also: JsonValue.Set¹

public method Write² → (1)

value ⁱⁿ : bool: The value to write.

Writes a JSON value.

IOException: If an I/O error has occurred.

See also: JsonValue.Set²

public method Write³ → (1)

value ⁱⁿ : int64: The value to write.

Writes a JSON value.

IOException: If an I/O error has occurred.

See also: JsonValue.Set⁴

public method Write⁴ → (1)

value ⁱⁿ : float64: The value to write.

Writes a JSON value.

IOException: If an I/O error has occurred.

See also: JsonValue.Set⁵

public method Write⁵ → (1)

value ⁱⁿ : string: The value to write.

Writes a JSON value.

IOException: If an I/O error has occurred.

See also: JsonValue.Set⁶

WriteArrayBegin

public method WriteArrayBegin → (1)

n ^opt : int32 = -1: [>=-1]
The number of array elements or -1 if not known.

Writes the start of a JSON array node.

IOException: If an I/O error has occurred.

See also: IJsonValue.Elements

WriteArrayEnd

public method WriteArrayEnd → ()

Writes the end of a JSON array node.

IOException: If an I/O error has occurred.

See also: IJsonValue.Elements

WriteMember

public method WriteMember → (2)

name ⁱⁿ : string: [not-empty]
The member name.
comment ^opt : string = null: Optional member comment.

Writes the name of the next object member value.

IOException: If an I/O error has occurred.

See also: JsonValue.MemberAdd

WriteObjectBegin

public method WriteObjectBegin → (1)

n ^opt : int32 = -1: [>=-1]
The number of object members or -1 if not known.

Writes the start of a JSON object node.

IOException: If an I/O error has occurred.

See also: JsonValue

WriteObjectEnd

public method WriteObjectEnd → ()

Writes the end of a JSON object node.

IOException: If an I/O error has occurred.

See also: JsonValue

IJsonWriter

Description

Public / Methods

Write

Write​Array​Begin

Write​Array​End

Write​Member

Write​Object​Begin

Write​Object​End

WriteArrayBegin

WriteArrayEnd

WriteMember

WriteObjectBegin

WriteObjectEnd