Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
234 lines (225 sloc) 13 KB
<Type Name="JsonProperty" FullName="System.Text.Json.JsonProperty">
<TypeSignature Language="C#" Value="public struct JsonProperty" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit JsonProperty extends System.ValueType" />
<TypeSignature Language="DocId" Value="T:System.Text.Json.JsonProperty" />
<TypeSignature Language="VB.NET" Value="Public Structure JsonProperty" />
<TypeSignature Language="C++ CLI" Value="public value class JsonProperty" />
<TypeSignature Language="F#" Value="type JsonProperty = struct" />
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Runtime.CompilerServices.IsReadOnly</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a single property for a JSON object.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.JsonProperty.Name" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Name As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ Name { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="System.Text.Json.JsonProperty.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the name of this property.</summary>
<value>The name of this property.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NameEquals">
<MemberSignature Language="C#" Value="public bool NameEquals (ReadOnlySpan&lt;byte&gt; utf8Text);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool NameEquals(valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; utf8Text) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.JsonProperty.NameEquals(System.ReadOnlySpan{System.Byte})" />
<MemberSignature Language="VB.NET" Value="Public Function NameEquals (utf8Text As ReadOnlySpan(Of Byte)) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool NameEquals(ReadOnlySpan&lt;System::Byte&gt; utf8Text);" />
<MemberSignature Language="F#" Value="member this.NameEquals : ReadOnlySpan&lt;byte&gt; -&gt; bool" Usage="jsonProperty.NameEquals utf8Text" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="utf8Text" Type="System.ReadOnlySpan&lt;System.Byte&gt;" />
</Parameters>
<Docs>
<param name="utf8Text">The UTF-8 encoded text to compare against.</param>
<summary>Compares the specified UTF-8 encoded text to the name of this property.</summary>
<returns>
<see langword="true" /> if the name of this property has the same UTF-8 encoding as <paramref name="utf8Text" />; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is functionally equal to doing an ordinal comparison of `utf8Text` and <xref:System.Text.Json.JsonProperty.Name>, but it can avoid creating the string instance.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">This value's <see cref="T:System.Type" /> is not <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />.</exception>
</Docs>
</Member>
<Member MemberName="NameEquals">
<MemberSignature Language="C#" Value="public bool NameEquals (ReadOnlySpan&lt;char&gt; text);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool NameEquals(valuetype System.ReadOnlySpan`1&lt;char&gt; text) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.JsonProperty.NameEquals(System.ReadOnlySpan{System.Char})" />
<MemberSignature Language="VB.NET" Value="Public Function NameEquals (text As ReadOnlySpan(Of Char)) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool NameEquals(ReadOnlySpan&lt;char&gt; text);" />
<MemberSignature Language="F#" Value="member this.NameEquals : ReadOnlySpan&lt;char&gt; -&gt; bool" Usage="jsonProperty.NameEquals text" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.ReadOnlySpan&lt;System.Char&gt;" />
</Parameters>
<Docs>
<param name="text">The text to compare against.</param>
<summary>Compares the specified text as a character span to the name of this property.</summary>
<returns>
<see langword="true" /> if the name of this property matches <paramref name="text" />; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is functionally equal to doing an ordinal comparison of `text` and <xref:System.Text.Json.JsonProperty.Name>, but it can avoid creating the string instance.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">This value's <see cref="T:System.Type" /> is not <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />.</exception>
</Docs>
</Member>
<Member MemberName="NameEquals">
<MemberSignature Language="C#" Value="public bool NameEquals (string text);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool NameEquals(string text) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.JsonProperty.NameEquals(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function NameEquals (text As String) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool NameEquals(System::String ^ text);" />
<MemberSignature Language="F#" Value="member this.NameEquals : string -&gt; bool" Usage="jsonProperty.NameEquals text" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<param name="text">The text to compare against.</param>
<summary>Compares the specified string to the name of this property.</summary>
<returns>
<see langword="true" /> if the name of this property matches <paramref name="text" />; otherwise <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is functionally equal to doing an ordinal comparison of `text` and <xref:System.Text.Json.JsonProperty.Name>.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">This value's <see cref="T:System.Type" /> is not <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />.</exception>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.JsonProperty.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; override System::String ^ ToString();" />
<MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="jsonProperty.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Provides a string representation of the property for debugging purposes.</summary>
<returns>A string containing the uninterpreted value of the property, beginning at the declaring open-quote and ending at the last character that is part of the value.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Value">
<MemberSignature Language="C#" Value="public System.Text.Json.JsonElement Value { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Text.Json.JsonElement Value" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.JsonProperty.Value" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Value As JsonElement" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Text::Json::JsonElement Value { System::Text::Json::JsonElement get(); };" />
<MemberSignature Language="F#" Value="member this.Value : System.Text.Json.JsonElement" Usage="System.Text.Json.JsonProperty.Value" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Text.Json.JsonElement</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the value of this property.</summary>
<value>The value of this property.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WriteTo">
<MemberSignature Language="C#" Value="public void WriteTo (System.Text.Json.Utf8JsonWriter writer);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteTo(class System.Text.Json.Utf8JsonWriter writer) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.JsonProperty.WriteTo(System.Text.Json.Utf8JsonWriter)" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteTo (writer As Utf8JsonWriter)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; void WriteTo(System::Text::Json::Utf8JsonWriter ^ writer);" />
<MemberSignature Language="F#" Value="member this.WriteTo : System.Text.Json.Utf8JsonWriter -&gt; unit" Usage="jsonProperty.WriteTo writer" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Text.Json.Utf8JsonWriter" />
</Parameters>
<Docs>
<param name="writer">The writer to which to write the property.</param>
<summary>Writes the property to the provided writer as a named JSON object property.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="writer" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<see cref="P:System.Text.Json.JsonProperty.Name" /> is too large to be a JSON object property.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Text.Json.JsonElement.ValueKind" /> of this JSON property's <see cref="P:System.Text.Json.JsonProperty.Value" /> would result in invalid JSON.</exception>
<exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.