main
parent
5499d5c726
commit
ccfdb5f6b9
@ -0,0 +1,13 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<Project ToolsVersion="Current" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
||||
<PropertyGroup>
|
||||
<PublishUrlHistory>publish\</PublishUrlHistory>
|
||||
<InstallUrlHistory />
|
||||
<SupportUrlHistory />
|
||||
<UpdateUrlHistory />
|
||||
<BootstrapperUrlHistory />
|
||||
<ErrorReportUrlHistory />
|
||||
<FallbackCulture>zh-CN</FallbackCulture>
|
||||
<VerifyUploadedFiles>false</VerifyUploadedFiles>
|
||||
</PropertyGroup>
|
||||
</Project>
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@ -0,0 +1,23 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) .NET Foundation and Contributors
|
||||
|
||||
All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@ -0,0 +1,49 @@
|
||||
## About
|
||||
|
||||
<!-- A description of the package and where one can find more documentation -->
|
||||
|
||||
A library designed to make it easier to do high-performance I/O.
|
||||
|
||||
Apps that parse streaming data are composed of boilerplate code having many specialized and unusual code flows.
|
||||
The boilerplate and special case code is complex and difficult to maintain.
|
||||
|
||||
`System.IO.Pipelines` was architected to:
|
||||
|
||||
* Have high performance parsing streaming data.
|
||||
* Reduce code complexity.
|
||||
|
||||
## Key Features
|
||||
|
||||
<!-- The key features of this package -->
|
||||
|
||||
* Single producer/single consumer byte buffer management.
|
||||
* Reduction in code complexity and boilerplate code associated with I/O operations.
|
||||
|
||||
## How to Use
|
||||
|
||||
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
|
||||
|
||||
Check the [System.IO.Pipelines in .NET article](https://learn.microsoft.com/dotnet/standard/io/pipelines) for a full example.
|
||||
|
||||
## Main Types
|
||||
|
||||
<!-- The main types provided in this library -->
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `System.IO.Pipelines.Pipe`
|
||||
* `System.IO.Pipelines.PipeWriter`
|
||||
* `System.IO.Pipelines.PipeReader`
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
|
||||
|
||||
* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/io/pipelines)
|
||||
* [API documentation](https://learn.microsoft.com/dotnet/api/system.io.pipelines)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
<!-- How to provide feedback on this package and contribute to it -->
|
||||
|
||||
System.IO.Pipelines is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
|
||||
Binary file not shown.
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_System_IO_Pipelines_net462">
|
||||
<Target Name="NETStandardCompatError_System_IO_Pipelines_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="System.IO.Pipelines 9.0.6 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net462 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_System_IO_Pipelines_net8_0">
|
||||
<Target Name="NETStandardCompatError_System_IO_Pipelines_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="System.IO.Pipelines 9.0.6 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net8.0 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@ -0,0 +1,23 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) .NET Foundation and Contributors
|
||||
|
||||
All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@ -0,0 +1,132 @@
|
||||
## About
|
||||
|
||||
<!-- A description of the package and where one can find more documentation -->
|
||||
|
||||
Provides types for encoding and escaping strings for use in JavaScript, HTML, and URLs.
|
||||
|
||||
This package is essential for protecting web applications against cross-site scripting (XSS) attacks by safely encoding text, and it offers extensive support for Unicode, allowing fine-grained control over which characters are encoded and which are left unescaped.
|
||||
|
||||
## Key Features
|
||||
|
||||
<!-- The key features of this package -->
|
||||
|
||||
* Safe encoders for HTML, JavaScript, and URL strings.
|
||||
* Extensible to support custom encoding scenarios, including the ability to specify Unicode ranges.
|
||||
* Helps prevent cross-site scripting (XSS) vulnerabilities.
|
||||
* Flexible Unicode encoding with support for specifying individual or predefined ranges to cover broader sets of characters, including options to avoid escaping specific language character sets.
|
||||
|
||||
## How to Use
|
||||
|
||||
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
|
||||
|
||||
### Encoding HTML, JavaScript, and URLs
|
||||
|
||||
```csharp
|
||||
using System.Text.Encodings.Web;
|
||||
|
||||
string unsafeString = "<script>alert('XSS Attack!');</script>";
|
||||
|
||||
// HTML encode the string to safely display it on a web page.
|
||||
string safeHtml = HtmlEncoder.Default.Encode(unsafeString);
|
||||
Console.WriteLine(safeHtml);
|
||||
// <script>alert('XSS Attack!');</script>
|
||||
|
||||
// JavaScript encode the string to safely include it in a JavaScript context.
|
||||
string safeJavaScript = JavaScriptEncoder.Default.Encode(unsafeString);
|
||||
Console.WriteLine(safeJavaScript);
|
||||
// \u003Cscript\u003Ealert(\u0027XSS Attack!\u0027);\u003C/script\u003E
|
||||
|
||||
string urlPart = "user input with spaces and & symbols";
|
||||
|
||||
// URL encode the string to safely include it in a URL.
|
||||
string encodedUrlPart = UrlEncoder.Default.Encode(urlPart);
|
||||
Console.WriteLine(encodedUrlPart);
|
||||
// user%20input%20with%20spaces%20and%20%26%20symbols
|
||||
```
|
||||
|
||||
### Custom Encoding Scenario with Specific Unicode Ranges
|
||||
|
||||
```csharp
|
||||
using System.Text.Encodings.Web;
|
||||
using System.Text.Unicode;
|
||||
|
||||
TextEncoderSettings customEncoderSettings = new TextEncoderSettings();
|
||||
customEncoderSettings.AllowCharacters('!', '*', '-', '.', '_', '~'); // RFC 3986 unreserved characters
|
||||
customEncoderSettings.AllowRange(new UnicodeRange('a', 26));
|
||||
customEncoderSettings.AllowRange(new UnicodeRange('A', 26));
|
||||
customEncoderSettings.AllowRange(new UnicodeRange('0', 10));
|
||||
|
||||
// Create a URL encoder with the custom settings
|
||||
UrlEncoder customUrlEncoder = UrlEncoder.Create(customEncoderSettings);
|
||||
|
||||
string customUrlPart = "custom data: (@123!)";
|
||||
|
||||
// By default, the symbols '(', ')', and '@' are not encoded
|
||||
string defaultEncoded = UrlEncoder.Default.Encode(customUrlPart);
|
||||
Console.WriteLine(defaultEncoded);
|
||||
// custom%20data%3A%20(@123!)
|
||||
|
||||
// Now, the symbols '(', ')', and '@' are also encoded
|
||||
string customEncoded = customUrlEncoder.Encode(customUrlPart);
|
||||
Console.WriteLine(customEncoded);
|
||||
// custom%20data%3A%20%28%40123!%29
|
||||
```
|
||||
|
||||
### Serialization with Specific Unicode Character Sets
|
||||
|
||||
By default Cyrillic characters are encoded as Unicode escape sequences in JSON.
|
||||
|
||||
```json
|
||||
{
|
||||
"Date": "2019-08-01T00:00:00-07:00",
|
||||
"TemperatureCelsius": 25,
|
||||
"Summary": "\u0436\u0430\u0440\u043A\u043E"
|
||||
}
|
||||
```
|
||||
|
||||
This can be customized by providing a custom `JavaScriptEncoder` to `JsonSerializerOptions`:
|
||||
|
||||
```csharp
|
||||
JsonSerializerOptions options = new JsonSerializerOptions
|
||||
{
|
||||
Encoder = JavaScriptEncoder.Create(UnicodeRanges.BasicLatin, UnicodeRanges.Cyrillic),
|
||||
WriteIndented = true
|
||||
};
|
||||
jsonString = JsonSerializer.Serialize(weatherForecast, options1);
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"Date": "2019-08-01T00:00:00-07:00",
|
||||
"TemperatureCelsius": 25,
|
||||
"Summary": "жарко"
|
||||
}
|
||||
```
|
||||
|
||||
More information about this can be found in the [How to customize character encoding with System.Text.Json](https://learn.microsoft.com/dotnet/standard/serialization/system-text-json/character-encoding) article.
|
||||
|
||||
## Main Types
|
||||
|
||||
<!-- The main types provided in this library -->
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `System.Text.Encodings.Web.HtmlEncoder`
|
||||
* `System.Text.Encodings.Web.JavaScriptEncoder`
|
||||
* `System.Text.Encodings.Web.UrlEncoder`
|
||||
* `System.Text.Encodings.Web.TextEncoder`
|
||||
* `System.Text.Encodings.Web.TextEncoderSettings`
|
||||
* `System.Text.Unicode.UnicodeRange`
|
||||
* `System.Text.Unicode.UnicodeRanges`
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
|
||||
|
||||
* [API documentation](https://learn.microsoft.com/dotnet/api/system.text.encodings.web)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
<!-- How to provide feedback on this package and contribute to it -->
|
||||
|
||||
System.Text.Encodings.Web is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
|
||||
Binary file not shown.
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_System_Text_Encodings_Web_net462">
|
||||
<Target Name="NETStandardCompatError_System_Text_Encodings_Web_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="System.Text.Encodings.Web 9.0.6 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net462 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_System_Text_Encodings_Web_net8_0">
|
||||
<Target Name="NETStandardCompatError_System_Text_Encodings_Web_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="System.Text.Encodings.Web 9.0.6 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net8.0 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File diff suppressed because it is too large
Load Diff
Binary file not shown.
File diff suppressed because it is too large
Load Diff
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@ -0,0 +1,23 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) .NET Foundation and Contributors
|
||||
|
||||
All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@ -0,0 +1,257 @@
|
||||
## About
|
||||
|
||||
<!-- A description of the package and where one can find more documentation -->
|
||||
|
||||
Provides high-performance and low-allocating types that serialize objects to JavaScript Object Notation (JSON) text and deserialize JSON text to objects, with UTF-8 support built-in. Also provides types to read and write JSON text encoded as UTF-8, and to create an in-memory document object model (DOM), that is read-only, for random access of the JSON elements within a structured view of the data.
|
||||
|
||||
## Key Features
|
||||
|
||||
<!-- The key features of this package -->
|
||||
|
||||
* High-performance reader and writer types for UTF-8 encoded JSON.
|
||||
* A fully-featured JSON serializer for .NET types using reflection or source generated contracts.
|
||||
* A high-performance read-only JSON DOM (JsonDocument) and a mutable DOM that interoperates with the serializer (JsonNode).
|
||||
* Built-in support for async serialization, including IAsyncEnumerable support.
|
||||
* Fully customizable contract model for serializable types.
|
||||
|
||||
## How to Use
|
||||
|
||||
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
|
||||
|
||||
The System.Text.Json library is built-in as part of the shared framework in .NET Runtime. The package can be installed when you need to use the most recent version in older target frameworks.
|
||||
|
||||
Serialization:
|
||||
```csharp
|
||||
using System;
|
||||
using System.Text.Json;
|
||||
|
||||
WeatherForecast forecast = new (DateTimeOffset.Now, 26.6f, "Sunny");
|
||||
var serialized = JsonSerializer.Serialize(forecast);
|
||||
|
||||
Console.WriteLine(serialized);
|
||||
// {"Date":"2023-08-02T16:01:20.9025406+00:00","TemperatureCelsius":26.6,"Summary":"Sunny"}
|
||||
|
||||
var forecastDeserialized = JsonSerializer.Deserialize<WeatherForecast>(serialized);
|
||||
Console.WriteLine(forecast == forecastDeserialized);
|
||||
// True
|
||||
|
||||
public record WeatherForecast(DateTimeOffset Date, float TemperatureCelsius, string? Summary);
|
||||
```
|
||||
|
||||
Serialization using the source generator:
|
||||
```csharp
|
||||
using System.Text.Json;
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
WeatherForecast forecast = new (DateTimeOffset.Now, 26.6f, "Sunny");
|
||||
var serialized = JsonSerializer.Serialize(forecast, SourceGenerationContext.Default.WeatherForecast);
|
||||
|
||||
Console.WriteLine(serialized);
|
||||
// {"Date":"2023-08-02T16:01:20.9025406+00:00","TemperatureCelsius":26.6,"Summary":"Sunny"}
|
||||
|
||||
var forecastDeserialized = JsonSerializer.Deserialize<WeatherForecast>(serialized, SourceGenerationContext.Default.WeatherForecast);
|
||||
Console.WriteLine(forecast == forecastDeserialized);
|
||||
// True
|
||||
|
||||
public record WeatherForecast(DateTimeOffset Date, float TemperatureCelsius, string? Summary);
|
||||
|
||||
[JsonSourceGenerationOptions(WriteIndented = true)]
|
||||
[JsonSerializable(typeof(WeatherForecast))]
|
||||
internal partial class SourceGenerationContext : JsonSerializerContext
|
||||
{
|
||||
}
|
||||
```
|
||||
|
||||
Using the JSON DOM:
|
||||
```csharp
|
||||
|
||||
using System;
|
||||
using System.Text.Json;
|
||||
using System.Text.Json.Nodes;
|
||||
|
||||
string jsonString =
|
||||
@"{
|
||||
""Date"": ""2019-08-01T00:00:00"",
|
||||
""Temperature"": 25,
|
||||
""Summary"": ""Hot"",
|
||||
""DatesAvailable"": [
|
||||
""2019-08-01T00:00:00"",
|
||||
""2019-08-02T00:00:00""
|
||||
],
|
||||
""TemperatureRanges"": {
|
||||
""Cold"": {
|
||||
""High"": 20,
|
||||
""Low"": -10
|
||||
},
|
||||
""Hot"": {
|
||||
""High"": 60,
|
||||
""Low"": 20
|
||||
}
|
||||
}
|
||||
}
|
||||
";
|
||||
|
||||
JsonNode forecastNode = JsonNode.Parse(jsonString)!;
|
||||
|
||||
|
||||
// Get value from a JsonNode.
|
||||
JsonNode temperatureNode = forecastNode["Temperature"]!;
|
||||
Console.WriteLine($"Type={temperatureNode.GetType()}");
|
||||
Console.WriteLine($"JSON={temperatureNode.ToJsonString()}");
|
||||
//output:
|
||||
//Type = System.Text.Json.Nodes.JsonValue`1[System.Text.Json.JsonElement]
|
||||
//JSON = 25
|
||||
|
||||
// Get a typed value from a JsonNode.
|
||||
int temperatureInt = (int)forecastNode["Temperature"]!;
|
||||
Console.WriteLine($"Value={temperatureInt}");
|
||||
//output:
|
||||
//Value=25
|
||||
|
||||
// Get a typed value from a JsonNode by using GetValue<T>.
|
||||
temperatureInt = forecastNode["Temperature"]!.GetValue<int>();
|
||||
Console.WriteLine($"TemperatureInt={temperatureInt}");
|
||||
//output:
|
||||
//Value=25
|
||||
|
||||
// Get a JSON object from a JsonNode.
|
||||
JsonNode temperatureRanges = forecastNode["TemperatureRanges"]!;
|
||||
Console.WriteLine($"Type={temperatureRanges.GetType()}");
|
||||
Console.WriteLine($"JSON={temperatureRanges.ToJsonString()}");
|
||||
//output:
|
||||
//Type = System.Text.Json.Nodes.JsonObject
|
||||
//JSON = { "Cold":{ "High":20,"Low":-10},"Hot":{ "High":60,"Low":20} }
|
||||
|
||||
// Get a JSON array from a JsonNode.
|
||||
JsonNode datesAvailable = forecastNode["DatesAvailable"]!;
|
||||
Console.WriteLine($"Type={datesAvailable.GetType()}");
|
||||
Console.WriteLine($"JSON={datesAvailable.ToJsonString()}");
|
||||
//output:
|
||||
//datesAvailable Type = System.Text.Json.Nodes.JsonArray
|
||||
//datesAvailable JSON =["2019-08-01T00:00:00", "2019-08-02T00:00:00"]
|
||||
|
||||
// Get an array element value from a JsonArray.
|
||||
JsonNode firstDateAvailable = datesAvailable[0]!;
|
||||
Console.WriteLine($"Type={firstDateAvailable.GetType()}");
|
||||
Console.WriteLine($"JSON={firstDateAvailable.ToJsonString()}");
|
||||
//output:
|
||||
//Type = System.Text.Json.Nodes.JsonValue`1[System.Text.Json.JsonElement]
|
||||
//JSON = "2019-08-01T00:00:00"
|
||||
|
||||
// Get a typed value by chaining references.
|
||||
int coldHighTemperature = (int)forecastNode["TemperatureRanges"]!["Cold"]!["High"]!;
|
||||
Console.WriteLine($"TemperatureRanges.Cold.High={coldHighTemperature}");
|
||||
//output:
|
||||
//TemperatureRanges.Cold.High = 20
|
||||
|
||||
// Parse a JSON array
|
||||
JsonNode datesNode = JsonNode.Parse(@"[""2019-08-01T00:00:00"",""2019-08-02T00:00:00""]")!;
|
||||
JsonNode firstDate = datesNode[0]!.GetValue<DateTime>();
|
||||
Console.WriteLine($"firstDate={ firstDate}");
|
||||
//output:
|
||||
//firstDate = "2019-08-01T00:00:00"
|
||||
```
|
||||
|
||||
Using the low-level JSON reader/writer types
|
||||
```csharp
|
||||
using System;
|
||||
using System.IO;
|
||||
using System.Text;
|
||||
using System.Text.Json;
|
||||
|
||||
var writerOptions = new JsonWriterOptions
|
||||
{
|
||||
Indented = true
|
||||
};
|
||||
|
||||
using var stream = new MemoryStream();
|
||||
using var writer = new Utf8JsonWriter(stream, writerOptions);
|
||||
|
||||
writer.WriteStartObject();
|
||||
writer.WriteString("date", DateTimeOffset.Parse("8/2/2023 9:00 AM"));
|
||||
writer.WriteNumber("temp", 42);
|
||||
writer.WriteEndObject();
|
||||
writer.Flush();
|
||||
|
||||
var jsonBytes = stream.ToArray();
|
||||
string json = Encoding.UTF8.GetString(jsonBytes);
|
||||
Console.WriteLine(json);
|
||||
// {
|
||||
// "date": "2023-08-02T09:00:00+00:00"
|
||||
// "temp": 42
|
||||
// }
|
||||
|
||||
var readerOptions = new JsonReaderOptions
|
||||
{
|
||||
AllowTrailingCommas = true,
|
||||
CommentHandling = JsonCommentHandling.Skip
|
||||
};
|
||||
var reader = new Utf8JsonReader(jsonBytes, readerOptions);
|
||||
|
||||
while (reader.Read())
|
||||
{
|
||||
Console.Write(reader.TokenType);
|
||||
|
||||
switch (reader.TokenType)
|
||||
{
|
||||
case JsonTokenType.PropertyName:
|
||||
case JsonTokenType.String:
|
||||
{
|
||||
string? text = reader.GetString();
|
||||
Console.Write(" ");
|
||||
Console.Write(text);
|
||||
break;
|
||||
}
|
||||
|
||||
case JsonTokenType.Number:
|
||||
{
|
||||
int intValue = reader.GetInt32();
|
||||
Console.Write(" ");
|
||||
Console.Write(intValue);
|
||||
break;
|
||||
}
|
||||
|
||||
// Other token types elided for brevity
|
||||
}
|
||||
Console.WriteLine();
|
||||
}
|
||||
// StartObject
|
||||
// PropertyName date
|
||||
// String 2023-08-02T09:00:00+00:00
|
||||
// PropertyName temp
|
||||
// Number 42
|
||||
// EndObject
|
||||
```
|
||||
|
||||
## Main Types
|
||||
|
||||
<!-- The main types provided in this library -->
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `System.Text.Json.Utf8JsonWriter`
|
||||
* `System.Text.Json.Utf8JsonReader`
|
||||
* `System.Text.Json.JsonSerializer`
|
||||
* `System.Text.Json.JsonConverter`
|
||||
* `System.Text.Json.JsonDocument`
|
||||
* `System.Text.Json.Nodes.JsonNode`
|
||||
* `System.Text.Json.Serialization.Metadata.JsonTypeInfo`
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/system-text-json/overview)
|
||||
* [API documentation](https://learn.microsoft.com/dotnet/api/system.text.json)
|
||||
|
||||
## Related Packages
|
||||
|
||||
<!-- The related packages associated with this package -->
|
||||
|
||||
* Lightweight data formats abstraction: [System.Memory.Data](https://www.nuget.org/packages/System.Memory.Data/)
|
||||
* Serialization of HttpContent: [System.Net.Http.Json](https://www.nuget.org/packages/System.Net.Http.Json/)
|
||||
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
<!-- How to provide feedback on this package and contribute to it -->
|
||||
|
||||
System.Text.Json is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
|
||||
Binary file not shown.
File diff suppressed because it is too large
Load Diff
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue