Class JsonReader

Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data.

Inheritance

System.Object

JsonReader

BsonReader

JsonTextReader

JTokenReader

TraceJsonReader

Implements

System.IDisposable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Bayat.Json

Assembly: Bayat.Json.Runtime.dll

Syntax

public abstract class JsonReader : IDisposable

Constructors

JsonReader()

Initializes a new instance of the JsonReader class with the specified System.IO.TextReader.

Declaration

protected JsonReader()

Fields

_currentState

Declaration

protected JsonReader.State _currentState

Field Value

Type	Description
JsonReader.State

_dateParseHandling

Declaration

protected DateParseHandling _dateParseHandling

Field Value

Type	Description
DateParseHandling

_floatParseHandling

Declaration

protected FloatParseHandling _floatParseHandling

Field Value

Type	Description
FloatParseHandling

_quoteChar

Declaration

protected char _quoteChar

Field Value

Type	Description
System.Char

Properties

CloseInput

Gets or sets a value indicating whether the underlying stream or System.IO.TextReader should be closed when the reader is closed.

Declaration

public bool CloseInput { get; set; }

Property Value

Type	Description
System.Boolean	true to close the underlying stream or System.IO.TextReader when the reader is closed; otherwise false. The default is true.

Culture

Gets or sets the culture used when reading JSON. Defaults to System.Globalization.CultureInfo.InvariantCulture.

Declaration

public CultureInfo Culture { get; set; }

Property Value

Type	Description
System.Globalization.CultureInfo

CurrentState

Gets the current reader state.

Declaration

protected JsonReader.State CurrentState { get; }

Property Value

Type	Description
JsonReader.State	The current reader state.

DateFormatString

Get or set how custom date formatted strings are parsed when reading JSON.

Declaration

public string DateFormatString { get; set; }

Property Value

Type	Description
System.String

DateParseHandling

Get or set how date formatted strings, e.g. "/Date(1198908717056)/" and "2012-03-21T05:40Z", are parsed when reading JSON.

Declaration

public DateParseHandling DateParseHandling { get; set; }

Property Value

Type	Description
DateParseHandling

DateTimeZoneHandling

Get or set how System.DateTime time zones are handling when reading JSON.

Declaration

public DateTimeZoneHandling DateTimeZoneHandling { get; set; }

Property Value

Type	Description
DateTimeZoneHandling

Depth

Gets the depth of the current token in the JSON document.

Declaration

public virtual int Depth { get; }

Property Value

Type	Description
System.Int32	The depth of the current token in the JSON document.

FloatParseHandling

Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text.

Declaration

public FloatParseHandling FloatParseHandling { get; set; }

Property Value

Type	Description
FloatParseHandling

MaxDepth

Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a JsonReaderException.

Declaration

public int? MaxDepth { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Path

Gets the path of the current JSON token.

Declaration

public virtual string Path { get; }

Property Value

Type	Description
System.String

QuoteChar

Gets the quotation mark character used to enclose the value of a string.

Declaration

public virtual char QuoteChar { get; protected set; }

Property Value

Type	Description
System.Char

SupportMultipleContent

Gets or sets a value indicating whether multiple pieces of JSON content can be read from a continuous stream without erroring.

Declaration

public bool SupportMultipleContent { get; set; }

Property Value

Type	Description
System.Boolean	true to support reading multiple pieces of JSON content; otherwise false. The default is false.

TokenType

Gets the type of the current JSON token.

Declaration

public virtual JsonToken TokenType { get; }

Property Value

Type	Description
JsonToken

Value

Gets the text value of the current JSON token.

Declaration

public virtual object Value { get; }

Property Value

Type	Description
System.Object

ValueType

Gets The Common Language Runtime (CLR) type for the current JSON token.

Declaration

public virtual Type ValueType { get; }

Property Value

Type	Description
System.Type

Methods

Close()

Changes the JsonReader.State to Closed.

Declaration

public virtual void Close()

CreateUnexpectedEndException()

Declaration

public JsonReaderException CreateUnexpectedEndException()

Returns

Type	Description
JsonReaderException

Dispose(Boolean)

Releases unmanaged and - optionally - managed resources

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	true to release both managed and unmanaged resources; false to release only unmanaged resources.

GetPosition(Int32)

Declaration

public JsonPosition GetPosition(int depth)

Parameters

Type	Name	Description
System.Int32	depth

Returns

Type	Description
JsonPosition

MoveToContent()

Declaration

public bool MoveToContent()

Returns

Type	Description
System.Boolean

Read()

Reads the next JSON token from the stream.

Declaration

public abstract bool Read()

Returns

Type	Description
System.Boolean	true if the next token was read successfully; false if there are no more tokens to read.

ReadAndAssert()

Declaration

public void ReadAndAssert()

ReadAndMoveToContent()

Declaration

public bool ReadAndMoveToContent()

Returns

Type	Description
System.Boolean

ReadArrayIntoByteArray()

Declaration

public byte[] ReadArrayIntoByteArray()

Returns

Type	Description
System.Byte[]

ReadAsBoolean()

Reads the next JSON token from the stream as a System.Nullable<T>.

Declaration

public virtual bool? ReadAsBoolean()

Returns

Type	Description
System.Nullable<System.Boolean>	A System.Nullable<T>. This method will return null at the end of an array.

ReadAsBytes()

Reads the next JSON token from the stream as a System.Byte[].

Declaration

public virtual byte[] ReadAsBytes()

Returns

Type	Description
System.Byte[]	A System.Byte[] or a null reference if the next JSON token is null. This method will return null at the end of an array.

ReadAsDateTime()

Reads the next JSON token from the stream as a System.Nullable<T>.

Declaration

public virtual DateTime? ReadAsDateTime()

Returns

Type	Description
System.Nullable<System.DateTime>	A System.Nullable<T>. This method will return null at the end of an array.

ReadAsDateTimeOffset()

Reads the next JSON token from the stream as a System.Nullable<T>.

Declaration

public virtual DateTimeOffset? ReadAsDateTimeOffset()

Returns

Type	Description
System.Nullable<System.DateTimeOffset>	A System.Nullable<T>. This method will return null at the end of an array.

ReadAsDecimal()

Reads the next JSON token from the stream as a System.Nullable<T>.

Declaration

public virtual decimal? ReadAsDecimal()

Returns

Type	Description
System.Nullable<System.Decimal>	A System.Nullable<T>. This method will return null at the end of an array.

ReadAsDouble()

Reads the next JSON token from the stream as a System.Nullable<T>.

Declaration

public virtual double? ReadAsDouble()

Returns

Type	Description
System.Nullable<System.Double>	A System.Nullable<T>. This method will return null at the end of an array.

ReadAsInt32()

Reads the next JSON token from the stream as a System.Nullable<T>.

Declaration

public virtual int? ReadAsInt32()

Returns

Type	Description
System.Nullable<System.Int32>	A System.Nullable<T>. This method will return null at the end of an array.

ReadAsString()

Reads the next JSON token from the stream as a System.String.

Declaration

public virtual string ReadAsString()

Returns

Type	Description
System.String	A System.String. This method will return null at the end of an array.

ReadBooleanString(String)

Declaration

public bool? ReadBooleanString(string s)

Parameters

Type	Name	Description
System.String	s

Returns

Type	Description
System.Nullable<System.Boolean>

ReadDateTimeOffsetString(String)

Declaration

public DateTimeOffset? ReadDateTimeOffsetString(string s)

Parameters

Type	Name	Description
System.String	s

Returns

Type	Description
System.Nullable<System.DateTimeOffset>

ReadDateTimeString(String)

Declaration

public DateTime? ReadDateTimeString(string s)

Parameters

Type	Name	Description
System.String	s

Returns

Type	Description
System.Nullable<System.DateTime>

ReadDecimalString(String)

Declaration

public decimal? ReadDecimalString(string s)

Parameters

Type	Name	Description
System.String	s

Returns

Type	Description
System.Nullable<System.Decimal>

ReadDoubleString(String)

Declaration

public double? ReadDoubleString(string s)

Parameters

Type	Name	Description
System.String	s

Returns

Type	Description
System.Nullable<System.Double>

ReaderReadAndAssert()

Declaration

public void ReaderReadAndAssert()

ReadInt32String(String)

Declaration

public int? ReadInt32String(string s)

Parameters

Type	Name	Description
System.String	s

Returns

Type	Description
System.Nullable<System.Int32>

ReadIntoWrappedTypeObject()

Declaration

public void ReadIntoWrappedTypeObject()

ReadProperty(Type)

Reads a property with primitive value.

Declaration

public virtual object ReadProperty(Type objectType)

Parameters

Type	Name	Description
System.Type	objectType

Returns

Type	Description
System.Object

ReadProperty<T>()

Reads a property with primitve value.

Declaration

public virtual T ReadProperty<T>()

Returns

Type	Description
T

Type Parameters

Name	Description
T

SetPostValueState(Boolean)

Declaration

public void SetPostValueState(bool updateIndex)

Parameters

Type	Name	Description
System.Boolean	updateIndex

SetStateBasedOnCurrent()

Sets the state based on current token type.

Declaration

protected void SetStateBasedOnCurrent()

SetToken(JsonToken)

Sets the current token.

Declaration

protected void SetToken(JsonToken newToken)

Parameters

Type	Name	Description
JsonToken	newToken	The new token.

SetToken(JsonToken, Object)

Sets the current token and value.

Declaration

protected void SetToken(JsonToken newToken, object value)

Parameters

Type	Name	Description
JsonToken	newToken	The new token.
System.Object	value	The value.

SetToken(JsonToken, Object, Boolean)

Declaration

public void SetToken(JsonToken newToken, object value, bool updateIndex)

Parameters

Type	Name	Description
JsonToken	newToken
System.Object	value
System.Boolean	updateIndex

Skip()

Skips the children of the current token.

Declaration

public void Skip()

Explicit Interface Implementations

IDisposable.Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

void IDisposable.Dispose()

Implements

System.IDisposable