Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
1082 lines (1018 sloc) 67.1 KB
<Type Name="Utf8JsonReader" FullName="System.Text.Json.Utf8JsonReader">
<TypeSignature Language="C#" Value="public struct Utf8JsonReader" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit Utf8JsonReader extends System.ValueType" />
<TypeSignature Language="DocId" Value="T:System.Text.Json.Utf8JsonReader" />
<TypeSignature Language="VB.NET" Value="Public Structure Utf8JsonReader" />
<TypeSignature Language="C++ CLI" Value="public value class Utf8JsonReader" />
<TypeSignature Language="F#" Value="type Utf8JsonReader = struct" />
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Runtime.CompilerServices.IsByRefLike</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Provides a high-performance API for forward-only, read-only access to the UTF-8 encoded JSON text.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
`Utf8JsonReader` processes the text sequentially with no caching and by default adheres strictly to the [JSON RFC](https://tools.ietf.org/html/rfc8259).
When `Utf8JsonReader` encounters invalid JSON, it throws a <xref:System.Text.Json.JsonReaderException> with basic error information like line number and byte position on the line.
Since this type is a ref struct, it doesn't directly support async. However, it does provide support for reentrancy to read incomplete data and to continue reading once more data is presented.
To be able to set max depth while reading OR allow skipping comments, create an instance of <xref:System.Text.Json.JsonReaderState> and pass it to the reader.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Utf8JsonReader (ref System.Buffers.ReadOnlySequence&lt;byte&gt; jsonData, bool isFinalBlock, System.Text.Json.JsonReaderState state);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor([in]valuetype System.Buffers.ReadOnlySequence`1&lt;unsigned int8&gt;&amp; jsonData, bool isFinalBlock, valuetype System.Text.Json.JsonReaderState state) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.#ctor(System.Buffers.ReadOnlySequence{System.Byte}@,System.Boolean,System.Text.Json.JsonReaderState)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (ByRef jsonData As ReadOnlySequence(Of Byte), isFinalBlock As Boolean, state As JsonReaderState)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; Utf8JsonReader(System::Buffers::ReadOnlySequence&lt;System::Byte&gt; % jsonData, bool isFinalBlock, System::Text::Json::JsonReaderState state);" />
<MemberSignature Language="F#" Value="new System.Text.Json.Utf8JsonReader : * bool * System.Text.Json.JsonReaderState -&gt; System.Text.Json.Utf8JsonReader" Usage="new System.Text.Json.Utf8JsonReader (jsonData, isFinalBlock, state)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="jsonData" Type="System.Buffers.ReadOnlySequence&lt;System.Byte&gt;" RefType="ref">
<Attributes>
<Attribute>
<AttributeName>System.Runtime.CompilerServices.IsReadOnly</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="isFinalBlock" Type="System.Boolean" />
<Parameter Name="state" Type="System.Text.Json.JsonReaderState" />
</Parameters>
<Docs>
<param name="jsonData">The UTF-8 encoded JSON text to process.</param>
<param name="isFinalBlock">
<see langword="true" /> when the input sequence contains the entire data to process. <see langword="false" /> only if it's known that the input span contains partial data with more data to follow.</param>
<param name="state">If this is the first call to the constructor, pass in a default state. Otherwise, capture the state from the previous instance of the <see cref="T:System.Text.Json.Utf8JsonReader" /> and pass that back.</param>
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonReader" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Since this type is a ref struct, it is a stack-only type, and all the limitations of ref structs apply to it.
This is the reason why the constructor accepts a <xref:System.Text.Json.JsonReaderState>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Utf8JsonReader (ReadOnlySpan&lt;byte&gt; jsonData, bool isFinalBlock, System.Text.Json.JsonReaderState state);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; jsonData, bool isFinalBlock, valuetype System.Text.Json.JsonReaderState state) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.#ctor(System.ReadOnlySpan{System.Byte},System.Boolean,System.Text.Json.JsonReaderState)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (jsonData As ReadOnlySpan(Of Byte), isFinalBlock As Boolean, state As JsonReaderState)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; Utf8JsonReader(ReadOnlySpan&lt;System::Byte&gt; jsonData, bool isFinalBlock, System::Text::Json::JsonReaderState state);" />
<MemberSignature Language="F#" Value="new System.Text.Json.Utf8JsonReader : ReadOnlySpan&lt;byte&gt; * bool * System.Text.Json.JsonReaderState -&gt; System.Text.Json.Utf8JsonReader" Usage="new System.Text.Json.Utf8JsonReader (jsonData, isFinalBlock, state)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="jsonData" Type="System.ReadOnlySpan&lt;System.Byte&gt;" />
<Parameter Name="isFinalBlock" Type="System.Boolean" />
<Parameter Name="state" Type="System.Text.Json.JsonReaderState" />
</Parameters>
<Docs>
<param name="jsonData">The UTF-8 encoded JSON text to process.</param>
<param name="isFinalBlock">
<see langword="true" /> when the input span contains the entire data to process. <see langword="false" /> only if it's known that the input span contains partial data with more data to follow.</param>
<param name="state">A struct that contains the reader state. On the first call to the constructor, it should reflect a default state; otherwise, it should capture the state from the previous instance instance of the <see cref="T:System.Text.Json.Utf8JsonReader" /> and pass that back.</param>
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonReader" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Since this type is a ref struct, it is a stack-only type, and all the limitations of ref structs apply to it.
This is the reason why the constructor accepts a <xref:System.Text.Json.JsonReaderState>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="BytesConsumed">
<MemberSignature Language="C#" Value="public long BytesConsumed { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 BytesConsumed" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.Utf8JsonReader.BytesConsumed" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property BytesConsumed As Long" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property long BytesConsumed { long get(); };" />
<MemberSignature Language="F#" Value="member this.BytesConsumed : int64" Usage="System.Text.Json.Utf8JsonReader.BytesConsumed" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the total number of bytes consumed by the <see cref="T:System.Text.Json.Utf8JsonReader" /> so far for the current instance of the <see cref="T:System.Text.Json.Utf8JsonReader" /> with the given UTF-8 encoded input text.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CurrentDepth">
<MemberSignature Language="C#" Value="public int CurrentDepth { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 CurrentDepth" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.Utf8JsonReader.CurrentDepth" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CurrentDepth As Integer" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property int CurrentDepth { int get(); };" />
<MemberSignature Language="F#" Value="member this.CurrentDepth : int" Usage="System.Text.Json.Utf8JsonReader.CurrentDepth" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the depth of the current token.</summary>
<value>The depth of the current token.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The `CurrentDepth` property tracks the recursive depth of the nested objects / arrays within the JSON text processed so far.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CurrentState">
<MemberSignature Language="C#" Value="public System.Text.Json.JsonReaderState CurrentState { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Text.Json.JsonReaderState CurrentState" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.Utf8JsonReader.CurrentState" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CurrentState As JsonReaderState" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Text::Json::JsonReaderState CurrentState { System::Text::Json::JsonReaderState get(); };" />
<MemberSignature Language="F#" Value="member this.CurrentState : System.Text.Json.JsonReaderState" Usage="System.Text.Json.Utf8JsonReader.CurrentState" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Text.Json.JsonReaderState</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the current snapshot of the <see cref="T:System.Text.Json.Utf8JsonReader" /> state that must be captured by the caller and passed back in to the <see cref="T:System.Text.Json.Utf8JsonReader" /> constructor with more data.</summary>
<value>To be added.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Unlike the <xref:System.Text.Json.Utf8JsonReader>, which is a ref struct, the state can survive across async/await boundaries, and hence this type is required to provide support for reading
in more data asynchronously before continuing with a new instance of the <xref:System.Text.Json.Utf8JsonReader>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetBoolean">
<MemberSignature Language="C#" Value="public bool GetBoolean ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool GetBoolean() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.GetBoolean" />
<MemberSignature Language="VB.NET" Value="Public Function GetBoolean () As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool GetBoolean();" />
<MemberSignature Language="F#" Value="member this.GetBoolean : unit -&gt; bool" Usage="utf8JsonReader.GetBoolean " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Reads the next JSON token value from the source as a <see cref="T:System.Boolean" />.</summary>
<returns><see langword="true" /> if the <see cref="P:System.Text.Json.Utf8JsonReader.TokenType" /> is <see cref="F:System.Text.Json.JsonTokenType.True" />; <see langword="false" /> if the <see cref="P:System.Text.Json.Utf8JsonReader.TokenType" /> is <see cref="F:System.Text.Json.JsonTokenType.False" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a boolean value (that is, <see cref="F:System.Text.Json.JsonTokenType.True" /> or <see cref="F:System.Text.Json.JsonTokenType.False" />).</exception>
<altmember cref="P:System.Text.Json.Utf8JsonReader.TokenType" />
</Docs>
</Member>
<Member MemberName="GetDateTime">
<MemberSignature Language="C#" Value="public DateTime GetDateTime ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.DateTime GetDateTime() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.GetDateTime" />
<MemberSignature Language="VB.NET" Value="Public Function GetDateTime () As DateTime" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; DateTime GetDateTime();" />
<MemberSignature Language="F#" Value="member this.GetDateTime : unit -&gt; DateTime" Usage="utf8JsonReader.GetDateTime " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.DateTime" />.</summary>
<returns>The date and time, if the entire UTF-8 encoded token value can be successfully parsed.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
<exception cref="T:System.FormatException">The JSON token value is in an unsupported format. Only a subset of ISO 8601 formats are supported.</exception>
</Docs>
</Member>
<Member MemberName="GetDateTimeOffset">
<MemberSignature Language="C#" Value="public DateTimeOffset GetDateTimeOffset ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.DateTimeOffset GetDateTimeOffset() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.GetDateTimeOffset" />
<MemberSignature Language="VB.NET" Value="Public Function GetDateTimeOffset () As DateTimeOffset" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; DateTimeOffset GetDateTimeOffset();" />
<MemberSignature Language="F#" Value="member this.GetDateTimeOffset : unit -&gt; DateTimeOffset" Usage="utf8JsonReader.GetDateTimeOffset " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.DateTimeOffset" />.</summary>
<returns>The date and time value, if the entire UTF-8 encoded token value can be successfully parsed.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
<exception cref="T:System.FormatException">The JSON token value is in an unsupported format. Only a subset of ISO 8601 formats are supported.</exception>
</Docs>
</Member>
<Member MemberName="GetDecimal">
<MemberSignature Language="C#" Value="public decimal GetDecimal ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Decimal GetDecimal() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.GetDecimal" />
<MemberSignature Language="VB.NET" Value="Public Function GetDecimal () As Decimal" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::Decimal GetDecimal();" />
<MemberSignature Language="F#" Value="member this.GetDecimal : unit -&gt; decimal" Usage="utf8JsonReader.GetDecimal " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Decimal</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.Decimal" />.</summary>
<returns>The UTF-8 encoded token value parsed to a <see cref="T:System.Decimal" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The `GetDecimal` method throws an exception if the entire UTF-8 encoded token value cannnot be parsed to a <xref:System.Decimal> value.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
<exception cref="T:System.FormatException">The JSON token value represents a number less than <see cref="F:System.Decimal.MinValue" /> or greater than <see cref="F:System.Decimal.MaxValue" />.</exception>
<altmember cref="P:System.Text.Json.Utf8JsonReader.TokenType" />
</Docs>
</Member>
<Member MemberName="GetDouble">
<MemberSignature Language="C#" Value="public double GetDouble ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance float64 GetDouble() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.GetDouble" />
<MemberSignature Language="VB.NET" Value="Public Function GetDouble () As Double" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; double GetDouble();" />
<MemberSignature Language="F#" Value="member this.GetDouble : unit -&gt; double" Usage="utf8JsonReader.GetDouble " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.Double" />.</summary>
<returns>The UTF-8 encoded token value parsed to a <see cref="T:System.Double" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The `GetDouble` method throws an exception if the entire UTF-8 encoded token value cannnot be parsed to a <xref:System.Double> value.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
<exception cref="T:System.FormatException">The JSON token value represents a number less than <see cref="F:System.Double.MinValue" /> or greater than <see cref="F:System.Double.MaxValue" />.</exception>
<altmember cref="P:System.Text.Json.Utf8JsonReader.TokenType" />
</Docs>
</Member>
<Member MemberName="GetGuid">
<MemberSignature Language="C#" Value="public Guid GetGuid ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Guid GetGuid() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.GetGuid" />
<MemberSignature Language="VB.NET" Value="Public Function GetGuid () As Guid" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; Guid GetGuid();" />
<MemberSignature Language="F#" Value="member this.GetGuid : unit -&gt; Guid" Usage="utf8JsonReader.GetGuid " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Guid</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.Guid" />.</summary>
<returns>The GUID value, if the entire UTF-8 encoded token value can be successfully parsed.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
<exception cref="T:System.FormatException">The JSON token value is in an unsupported format for a Guid.</exception>
</Docs>
</Member>
<Member MemberName="GetInt32">
<MemberSignature Language="C#" Value="public int GetInt32 ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 GetInt32() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.GetInt32" />
<MemberSignature Language="VB.NET" Value="Public Function GetInt32 () As Integer" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; int GetInt32();" />
<MemberSignature Language="F#" Value="member this.GetInt32 : unit -&gt; int" Usage="utf8JsonReader.GetInt32 " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Reads the next JSON token value from the source and parses it to an <see cref="T:System.Int32" />.</summary>
<returns>The UTF-8 encoded token value parsed to an <see cref="T:System.Int32" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The `GetInt32` method throws an exception if the entire UTF-8 encoded token value cannnot be parsed to a <xref:System.Int32> value.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
<exception cref="T:System.FormatException">The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation.
- or-
The JSON token value represents a number less than <see cref="F:System.Int32.MinValue" /> or greater than <see cref="F:System.Int32.MaxValue" />.</exception>
<altmember cref="P:System.Text.Json.Utf8JsonReader.TokenType" />
</Docs>
</Member>
<Member MemberName="GetInt64">
<MemberSignature Language="C#" Value="public long GetInt64 ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int64 GetInt64() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.GetInt64" />
<MemberSignature Language="VB.NET" Value="Public Function GetInt64 () As Long" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; long GetInt64();" />
<MemberSignature Language="F#" Value="member this.GetInt64 : unit -&gt; int64" Usage="utf8JsonReader.GetInt64 " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Reads the next JSON token value from the source and parses it to an <see cref="T:System.Int64" />.</summary>
<returns>The UTF-8 encoded token value parsed to an <see cref="T:System.Int64" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The `GetInt64` method throws an exception if the entire UTF-8 encoded token value cannnot be parsed to a <xref:System.Int64> value.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
<exception cref="T:System.FormatException">The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation.
- or-
The JSON token value represents a number less than <see cref="F:System.Int64.MinValue" /> or greater than <see cref="F:System.Int64.MaxValue" />.</exception>
<altmember cref="P:System.Text.Json.Utf8JsonReader.TokenType" />
</Docs>
</Member>
<Member MemberName="GetSingle">
<MemberSignature Language="C#" Value="public float GetSingle ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 GetSingle() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.GetSingle" />
<MemberSignature Language="VB.NET" Value="Public Function GetSingle () As Single" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; float GetSingle();" />
<MemberSignature Language="F#" Value="member this.GetSingle : unit -&gt; single" Usage="utf8JsonReader.GetSingle " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.Single" />.</summary>
<returns>The UTF-8 encoded token value parsed to a <see cref="T:System.Single" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The `GetSingle` method throws an exception if the entire UTF-8 encoded token value cannnot be parsed to a <xref:System.Single> value.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
<exception cref="T:System.FormatException">The JSON token value represents a number less than <see cref="F:System.Single.MinValue" /> or greater than <see cref="F:System.Single.MaxValue" />.</exception>
<altmember cref="P:System.Text.Json.Utf8JsonReader.TokenType" />
</Docs>
</Member>
<Member MemberName="GetString">
<MemberSignature Language="C#" Value="public string GetString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetString() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.GetString" />
<MemberSignature Language="VB.NET" Value="Public Function GetString () As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::String ^ GetString();" />
<MemberSignature Language="F#" Value="member this.GetString : unit -&gt; string" Usage="utf8JsonReader.GetString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Reads the next JSON token value from the source, unescaped, and transcoded as a <see cref="T:System.String" />.</summary>
<returns>The token value parsed to a <see cref="T:System.String" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The JSON token value isn't a string (that is, not a <see cref="F:System.Text.Json.JsonTokenType.String" /> or <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />).
-or-
The JSON string contains invalid UTF-8 bytes or invalid UTF-16 surrogates.</exception>
<altmember cref="P:System.Text.Json.Utf8JsonReader.TokenType" />
</Docs>
</Member>
<Member MemberName="GetUInt32">
<MemberSignature Language="C#" Value="public uint GetUInt32 ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int32 GetUInt32() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.GetUInt32" />
<MemberSignature Language="VB.NET" Value="Public Function GetUInt32 () As UInteger" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::UInt32 GetUInt32();" />
<MemberSignature Language="F#" Value="member this.GetUInt32 : unit -&gt; uint32" Usage="utf8JsonReader.GetUInt32 " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.CLSCompliant(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.UInt32" />.</summary>
<returns>The UTF-8 encoded token value parsed to a <see cref="T:System.UInt32" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
<exception cref="T:System.FormatException">The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation.
- or-
The JSON token value represents a number less than <see cref="F:System.UInt32.MinValue" /> or greater than <see cref="F:System.UInt32.MaxValue" />.</exception>
<altmember cref="P:System.Text.Json.Utf8JsonReader.TokenType" />
</Docs>
</Member>
<Member MemberName="GetUInt64">
<MemberSignature Language="C#" Value="public ulong GetUInt64 ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int64 GetUInt64() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.GetUInt64" />
<MemberSignature Language="VB.NET" Value="Public Function GetUInt64 () As ULong" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::UInt64 GetUInt64();" />
<MemberSignature Language="F#" Value="member this.GetUInt64 : unit -&gt; uint64" Usage="utf8JsonReader.GetUInt64 " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.CLSCompliant(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.UInt64</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.UInt64" />.</summary>
<returns>The UTF-8 encoded token value parsed to a <see cref="T:System.UInt64" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
<exception cref="T:System.FormatException">The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation.
- or-
The JSON token value represents a number less than <see cref="F:System.UInt64.MinValue" /> or greater than <see cref="F:System.UInt64.MaxValue" />.</exception>
<altmember cref="P:System.Text.Json.Utf8JsonReader.TokenType" />
</Docs>
</Member>
<Member MemberName="HasValueSequence">
<MemberSignature Language="C#" Value="public bool HasValueSequence { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HasValueSequence" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.Utf8JsonReader.HasValueSequence" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property HasValueSequence As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property bool HasValueSequence { bool get(); };" />
<MemberSignature Language="F#" Value="member this.HasValueSequence : bool" Usage="System.Text.Json.Utf8JsonReader.HasValueSequence" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates which <c>Value</c> property to use to get the token value.</summary>
<value>
<see langword="true" /> if <see cref="P:System.Text.Json.Utf8JsonReader.ValueSequence" /> should be used to get the token value. <see langword="false" /> if <see cref="P:System.Text.Json.Utf8JsonReader.ValueSpan" /> should be used instead.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If `HasValueSequence` is `false`, <xref:System.Text.Json.Utf8JsonReader.ValueSequence> is empty. Therefore, read the token value using the <xref:System.Text.Json.Utf8JsonReader.ValueSpan> property.
For input data within a `ReadOnlySpan<byte>`, this always returns `false`. For input data within a `ReadOnlySequence<byte>`, this only returns `true` if the token value straddles more than a single segment and hence can't be represented as a span.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Position">
<MemberSignature Language="C#" Value="public SequencePosition Position { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.SequencePosition Position" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.Utf8JsonReader.Position" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Position As SequencePosition" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property SequencePosition Position { SequencePosition get(); };" />
<MemberSignature Language="F#" Value="member this.Position : SequencePosition" Usage="System.Text.Json.Utf8JsonReader.Position" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.SequencePosition</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the current <see cref="T:System.SequencePosition" /> within the provided UTF-8 encoded input ReadOnlySequence&lt;byte&gt; or a default <see cref="T:System.SequencePosition" /> if the <see cref="T:System.Text.Json.Utf8JsonReader" /> struct was constructed with a ReadOnlySpan&lt;byte&gt;.</summary>
<value>The current <see cref="T:System.SequencePosition" /> within the provided UTF-8 encoded input ReadOnlySequence&lt;byte&gt; or a default <see cref="T:System.SequencePosition" /> if the <see cref="T:System.Text.Json.Utf8JsonReader" /> struct was constructed with a ReadOnlySpan&lt;byte&gt;.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Read">
<MemberSignature Language="C#" Value="public bool Read ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Read() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.Read" />
<MemberSignature Language="VB.NET" Value="Public Function Read () As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool Read();" />
<MemberSignature Language="F#" Value="member this.Read : unit -&gt; bool" Usage="utf8JsonReader.Read " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Read the next JSON token from the input source.</summary>
<returns><see langword="true" /> if the token was read successfully; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Text.Json.JsonReaderException">An invalid JSON token was encountered.
-or-
The current depth exceeds the recursive limit set by the maximum depth.</exception>
<exception cref="T:System.Text.Json.JsonException">An invalid JSON token according to the JSON RFC is encountered.
-or-
The current depth exceeds the recursive limit set by the maximum depth.</exception>
</Docs>
</Member>
<Member MemberName="TextEquals">
<MemberSignature Language="C#" Value="public bool TextEquals (ReadOnlySpan&lt;byte&gt; otherUtf8Text);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TextEquals(valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; otherUtf8Text) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.TextEquals(System.ReadOnlySpan{System.Byte})" />
<MemberSignature Language="VB.NET" Value="Public Function TextEquals (otherUtf8Text As ReadOnlySpan(Of Byte)) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool TextEquals(ReadOnlySpan&lt;System::Byte&gt; otherUtf8Text);" />
<MemberSignature Language="F#" Value="member this.TextEquals : ReadOnlySpan&lt;byte&gt; -&gt; bool" Usage="utf8JsonReader.TextEquals otherUtf8Text" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="otherUtf8Text" Type="System.ReadOnlySpan&lt;System.Byte&gt;" />
</Parameters>
<Docs>
<param name="otherUtf8Text">The UTF-8 encoded text to compare against.</param>
<summary>Compares the UTF-8 encoded text to the unescaped JSON token value in the source and returns <see langword="true" /> if they match.</summary>
<returns><see langword="true" /> if the JSON token value in the source matches the UTF-8 encoded look up text; otherwise, <see langword="false" />.</returns>
<remarks>
<format><![CDATA[
If the look up text is invalid UTF-8 text, the method will return `false` since you cannot have invalid UTF-8 within the JSON payload.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The JSON token isn't a string (that is, its type is other than <see cref="F:System.Text.Json.JsonTokenType.String" /> or <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />).</exception>
</Docs>
</Member>
<Member MemberName="TextEquals">
<MemberSignature Language="C#" Value="public bool TextEquals (ReadOnlySpan&lt;char&gt; otherText);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TextEquals(valuetype System.ReadOnlySpan`1&lt;char&gt; otherText) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.TextEquals(System.ReadOnlySpan{System.Char})" />
<MemberSignature Language="VB.NET" Value="Public Function TextEquals (otherText As ReadOnlySpan(Of Char)) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool TextEquals(ReadOnlySpan&lt;char&gt; otherText);" />
<MemberSignature Language="F#" Value="member this.TextEquals : ReadOnlySpan&lt;char&gt; -&gt; bool" Usage="utf8JsonReader.TextEquals otherText" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="otherText" Type="System.ReadOnlySpan&lt;System.Char&gt;" />
</Parameters>
<Docs>
<param name="otherText">The UTF-16 encoded text to compare against.</param>
<summary>Compares the UTF-16 encoded text to the unescaped JSON token value in the source and returns true if they match.</summary>
<returns><see langword="true" /> if the JSON token value in the source matches the UTF-16 encoded look up text; otherwise, <see langword="false" />.</returns>
<remarks>
<format><![CDATA[
If the look up text is invalid or incomplete UTF-16 text (such as unpaired surrogates), the method returns `false` since there cannot be invalid UTF-16 within the JSON payload.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The JSON text isn't a string (its type is not <see cref="F:System.Text.Json.JsonTokenType.String" /> or <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />).</exception>
</Docs>
</Member>
<Member MemberName="TokenType">
<MemberSignature Language="C#" Value="public System.Text.Json.JsonTokenType TokenType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Text.Json.JsonTokenType TokenType" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.Utf8JsonReader.TokenType" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TokenType As JsonTokenType" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Text::Json::JsonTokenType TokenType { System::Text::Json::JsonTokenType get(); };" />
<MemberSignature Language="F#" Value="member this.TokenType : System.Text.Json.JsonTokenType" Usage="System.Text.Json.Utf8JsonReader.TokenType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Text.Json.JsonTokenType</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the type of the last processed JSON token in the UTF-8 encoded JSON text.</summary>
<value>The type of the last processed JSON token.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryGetDateTime">
<MemberSignature Language="C#" Value="public bool TryGetDateTime (out DateTime value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetDateTime([out] valuetype System.DateTime&amp; value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.TryGetDateTime(System.DateTime@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetDateTime (ByRef value As DateTime) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool TryGetDateTime([Runtime::InteropServices::Out] DateTime % value);" />
<MemberSignature Language="F#" Value="member this.TryGetDateTime : -&gt; bool" Usage="utf8JsonReader.TryGetDateTime value" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.DateTime" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains the parsed value.</param>
<summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.DateTime" />. </summary>
<returns><see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="T:System.DateTime" /> value; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
</Docs>
</Member>
<Member MemberName="TryGetDateTimeOffset">
<MemberSignature Language="C#" Value="public bool TryGetDateTimeOffset (out DateTimeOffset value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetDateTimeOffset([out] valuetype System.DateTimeOffset&amp; value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.TryGetDateTimeOffset(System.DateTimeOffset@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetDateTimeOffset (ByRef value As DateTimeOffset) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool TryGetDateTimeOffset([Runtime::InteropServices::Out] DateTimeOffset % value);" />
<MemberSignature Language="F#" Value="member this.TryGetDateTimeOffset : -&gt; bool" Usage="utf8JsonReader.TryGetDateTimeOffset value" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.DateTimeOffset" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains the parsed value.</param>
<summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.DateTimeOffset" />. </summary>
<returns><see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="T:System.DateTimeOffset" /> value; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
</Docs>
</Member>
<Member MemberName="TryGetDecimal">
<MemberSignature Language="C#" Value="public bool TryGetDecimal (out decimal value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetDecimal([out] valuetype System.Decimal&amp; value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.TryGetDecimal(System.Decimal@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetDecimal (ByRef value As Decimal) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool TryGetDecimal([Runtime::InteropServices::Out] System::Decimal % value);" />
<MemberSignature Language="F#" Value="member this.TryGetDecimal : -&gt; bool" Usage="utf8JsonReader.TryGetDecimal value" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Decimal" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains the parsed value.</param>
<summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.Decimal" />.</summary>
<returns><see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="T:System.Decimal" /> value; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
<altmember cref="P:System.Text.Json.Utf8JsonReader.TokenType" />
</Docs>
</Member>
<Member MemberName="TryGetDouble">
<MemberSignature Language="C#" Value="public bool TryGetDouble (out double value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetDouble([out] float64&amp; value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.TryGetDouble(System.Double@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetDouble (ByRef value As Double) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool TryGetDouble([Runtime::InteropServices::Out] double % value);" />
<MemberSignature Language="F#" Value="member this.TryGetDouble : -&gt; bool" Usage="utf8JsonReader.TryGetDouble value" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Double" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains the parsed value.</param>
<summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.Double" />.</summary>
<returns><see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="T:System.Double" /> value; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
<altmember cref="P:System.Text.Json.Utf8JsonReader.TokenType" />
</Docs>
</Member>
<Member MemberName="TryGetGuid">
<MemberSignature Language="C#" Value="public bool TryGetGuid (out Guid value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetGuid([out] valuetype System.Guid&amp; value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.TryGetGuid(System.Guid@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetGuid (ByRef value As Guid) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool TryGetGuid([Runtime::InteropServices::Out] Guid % value);" />
<MemberSignature Language="F#" Value="member this.TryGetGuid : -&gt; bool" Usage="utf8JsonReader.TryGetGuid value" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Guid" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains the parsed value.</param>
<summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.Guid" />.</summary>
<returns><see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="T:System.Guid" /> value; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
This method only parses <xref:System.Guid> values with hyphens and without any surrounding decorations.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
</Docs>
</Member>
<Member MemberName="TryGetInt32">
<MemberSignature Language="C#" Value="public bool TryGetInt32 (out int value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetInt32([out] int32&amp; value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.TryGetInt32(System.Int32@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetInt32 (ByRef value As Integer) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool TryGetInt32([Runtime::InteropServices::Out] int % value);" />
<MemberSignature Language="F#" Value="member this.TryGetInt32 : -&gt; bool" Usage="utf8JsonReader.TryGetInt32 value" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Int32" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains the parsed value.</param>
<summary>Reads the next JSON token value from the source and parses it to an <see cref="T:System.Int32" />.</summary>
<returns><see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to an <see cref="T:System.Int32" /> value; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
<altmember cref="P:System.Text.Json.Utf8JsonReader.TokenType" />
</Docs>
</Member>
<Member MemberName="TryGetInt64">
<MemberSignature Language="C#" Value="public bool TryGetInt64 (out long value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetInt64([out] int64&amp; value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.TryGetInt64(System.Int64@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetInt64 (ByRef value As Long) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool TryGetInt64([Runtime::InteropServices::Out] long % value);" />
<MemberSignature Language="F#" Value="member this.TryGetInt64 : -&gt; bool" Usage="utf8JsonReader.TryGetInt64 value" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Int64" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains the parsed value.</param>
<summary>Reads the next JSON token value from the source and parses it to an <see cref="T:System.Int64" />.</summary>
<returns><see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to an <see cref="T:System.Int64" /> value; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
<altmember cref="P:System.Text.Json.Utf8JsonReader.TokenType" />
</Docs>
</Member>
<Member MemberName="TryGetSingle">
<MemberSignature Language="C#" Value="public bool TryGetSingle (out float value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetSingle([out] float32&amp; value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.TryGetSingle(System.Single@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetSingle (ByRef value As Single) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool TryGetSingle([Runtime::InteropServices::Out] float % value);" />
<MemberSignature Language="F#" Value="member this.TryGetSingle : -&gt; bool" Usage="utf8JsonReader.TryGetSingle value" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Single" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains the parsed value.</param>
<summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.Single" />.</summary>
<returns><see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to an <see cref="T:System.Single" /> value; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
<altmember cref="P:System.Text.Json.Utf8JsonReader.TokenType" />
</Docs>
</Member>
<Member MemberName="TryGetUInt32">
<MemberSignature Language="C#" Value="public bool TryGetUInt32 (out uint value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetUInt32([out] unsigned int32&amp; value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.TryGetUInt32(System.UInt32@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetUInt32 (ByRef value As UInteger) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool TryGetUInt32([Runtime::InteropServices::Out] System::UInt32 % value);" />
<MemberSignature Language="F#" Value="member this.TryGetUInt32 : -&gt; bool" Usage="utf8JsonReader.TryGetUInt32 value" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.CLSCompliant(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.UInt32" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains the parsed value.</param>
<summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.UInt32" />.</summary>
<returns><see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="T:System.UInt32" /> value; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
<altmember cref="P:System.Text.Json.Utf8JsonReader.TokenType" />
</Docs>
</Member>
<Member MemberName="TryGetUInt64">
<MemberSignature Language="C#" Value="public bool TryGetUInt64 (out ulong value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetUInt64([out] unsigned int64&amp; value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonReader.TryGetUInt64(System.UInt64@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetUInt64 (ByRef value As ULong) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool TryGetUInt64([Runtime::InteropServices::Out] System::UInt64 % value);" />
<MemberSignature Language="F#" Value="member this.TryGetUInt64 : -&gt; bool" Usage="utf8JsonReader.TryGetUInt64 value" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.CLSCompliant(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.UInt64" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains the parsed value.</param>
<summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.UInt64" />.</summary>
<returns><see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="T:System.UInt64" /> value; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
<altmember cref="P:System.Text.Json.Utf8JsonReader.TokenType" />
</Docs>
</Member>
<Member MemberName="ValueSequence">
<MemberSignature Language="C#" Value="public System.Buffers.ReadOnlySequence&lt;byte&gt; ValueSequence { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Buffers.ReadOnlySequence`1&lt;unsigned int8&gt; ValueSequence" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.Utf8JsonReader.ValueSequence" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ValueSequence As ReadOnlySequence(Of Byte)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Buffers::ReadOnlySequence&lt;System::Byte&gt; ValueSequence { System::Buffers::ReadOnlySequence&lt;System::Byte&gt; get(); };" />
<MemberSignature Language="F#" Value="member this.ValueSequence : System.Buffers.ReadOnlySequence&lt;byte&gt;" Usage="System.Text.Json.Utf8JsonReader.ValueSequence" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Buffers.ReadOnlySequence&lt;System.Byte&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the value of the last processed token as a ReadOnlySpan&lt;byte&gt; slice of the input payload. If the JSON is provided within a ReadOnlySequence&lt;byte&gt;
and the slice that represents the token value fits in a single segment, then <see cref="P:System.Text.Json.Utf8JsonReader.ValueSpan" /> contains the sliced value since it can be represented as a span.
Otherwise, <see cref="P:System.Text.Json.Utf8JsonReader.ValueSequence" /> contains the token value.</summary>
<value>To be added.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If <xref:System.Text.Json.Utf8JsonReader.HasValueSequence> is `false`, `ValueSequence` is empty.
Therefore, only access `ValueSequence` if <xref:System.Text.Json.Utf8JsonReader.HasValueSequence> is `true`.
Otherwise, the token value must be accessed from <xref:System.Text.Json.Utf8JsonReader.ValueSpan>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ValueSpan">
<MemberSignature Language="C#" Value="public ReadOnlySpan&lt;byte&gt; ValueSpan { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; ValueSpan" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.Utf8JsonReader.ValueSpan" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ValueSpan As ReadOnlySpan(Of Byte)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property ReadOnlySpan&lt;System::Byte&gt; ValueSpan { ReadOnlySpan&lt;System::Byte&gt; get(); };" />
<MemberSignature Language="F#" Value="member this.ValueSpan : ReadOnlySpan&lt;byte&gt;" Usage="System.Text.Json.Utf8JsonReader.ValueSpan" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ReadOnlySpan&lt;System.Byte&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the value of the last processed token as a ReadOnlySpan&lt;byte&gt; slice of the input payload. If the JSON is provided within a ReadOnlySequence&lt;byte&gt;
and the slice that represents the token value fits in a single segment, then <see cref="P:System.Text.Json.Utf8JsonReader.ValueSpan" /> contains the sliced value since it can be represented as a span.
Otherwise, the <see cref="P:System.Text.Json.Utf8JsonReader.ValueSequence" /> contains the token value.</summary>
<value>To be added.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If <xref:System.Text.Json.Utf8JsonReader.HasValueSequence> is `true`, <xref:System.Text.Json.Utf8JsonReader.ValueSpan> is empty.
Therefore, only access `ValueSpan` if <xref:System.Text.Json.Utf8JsonReader.HasValueSequence> is `false`.
Otherwise, the token value must be accessed from <xref:System.Text.Json.Utf8JsonReader.ValueSequence>.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.