nuget updates

This commit is contained in:
StellaOps Bot
2025-11-22 14:02:06 +02:00
parent 96352c9d27
commit a7f3c7869a
1681 changed files with 1334973 additions and 0 deletions

View File

@@ -0,0 +1,5 @@
{
"version": 2,
"contentHash": "Mp/3KeMPbvqDoEEI+qf4gwaq4+QO1uehmYodPvtVO+tb6AGhTjPF8f7PNG73BJ79p4EryWa/pAH4urrafl9+lQ==",
"source": "https://api.nuget.org/v3/index.json"
}

Binary file not shown.

View File

@@ -0,0 +1,40 @@
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
<metadata>
<id>AngleSharp</id>
<version>1.1.1</version>
<authors>AngleSharp</authors>
<owners>Florian Rappl</owners>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<license type="expression">MIT</license>
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
<icon>logo.png</icon>
<readme>README.md</readme>
<projectUrl>https://anglesharp.github.io/</projectUrl>
<description>AngleSharp is the ultimate angle brackets parser library. It parses HTML5, CSS3, and XML to construct a DOM based on the official W3C specification.</description>
<releaseNotes>https://github.com/AngleSharp/AngleSharp/blob/main/CHANGELOG.md</releaseNotes>
<copyright>Copyright 2013-2024, AngleSharp.</copyright>
<tags>html html5 css css3 xml dom dom4 parser engine hypertext markup language query selector attributes linq angle bracket web internet text headless browser</tags>
<repository type="git" url="https://github.com/AngleSharp/AngleSharp" />
<dependencies>
<group targetFramework=".NETStandard2.0">
<dependency id="System.Text.Encoding.CodePages" version="7.0.0" />
</group>
<group targetFramework=".NETFramework4.6.1">
<dependency id="System.Text.Encoding.CodePages" version="6.0.0" />
</group>
<group targetFramework=".NETFramework4.7.2">
<dependency id="System.Text.Encoding.CodePages" version="6.0.0" />
</group>
<group targetFramework="net6.0">
<dependency id="System.Text.Encoding.CodePages" version="6.0.0" />
</group>
<group targetFramework="net7.0">
<dependency id="System.Text.Encoding.CodePages" version="7.0.0" />
</group>
<group targetFramework="net8.0">
<dependency id="System.Text.Encoding.CodePages" version="8.0.0" />
</group>
</dependencies>
</metadata>
</package>

View File

@@ -0,0 +1,162 @@
![logo](https://raw.githubusercontent.com/AngleSharp/AngleSharp/master/header.png)
# AngleSharp
[![CI](https://github.com/AngleSharp/AngleSharp/actions/workflows/ci.yml/badge.svg)](https://github.com/AngleSharp/AngleSharp/actions/workflows/ci.yml)
[![GitHub Tag](https://img.shields.io/github/tag/AngleSharp/AngleSharp.svg?style=flat-square)](https://github.com/AngleSharp/AngleSharp/releases)
[![NuGet Count](https://img.shields.io/nuget/dt/AngleSharp.svg?style=flat-square)](https://www.nuget.org/packages/AngleSharp/)
[![Issues Open](https://img.shields.io/github/issues/AngleSharp/AngleSharp.svg?style=flat-square)](https://github.com/AngleSharp/AngleSharp/issues)
[![Gitter Chat](http://img.shields.io/badge/gitter-AngleSharp/AngleSharp-blue.svg?style=flat-square)](https://gitter.im/AngleSharp/AngleSharp)
[![StackOverflow Questions](https://img.shields.io/stackexchange/stackoverflow/t/anglesharp.svg?style=flat-square)](https://stackoverflow.com/tags/anglesharp)
[![CLA Assistant](https://cla-assistant.io/readme/badge/AngleSharp/AngleSharp?style=flat-square)](https://cla-assistant.io/AngleSharp/AngleSharp)
AngleSharp is a .NET library that gives you the ability to parse angle bracket based hyper-texts like HTML, SVG, and MathML. XML without validation is also supported by the library. An important aspect of AngleSharp is that CSS can also be parsed. The included parser is built upon the official W3C specification. This produces a perfectly portable HTML5 DOM representation of the given source code and ensures compatibility with results in evergreen browsers. Also standard DOM features such as `querySelector` or `querySelectorAll` work for tree traversal.
:zap::zap: **Migrating from AngleSharp 0.9 to AngleSharp 0.10 or later** (incl. 1.0)? Look at our [migration documentation](docs/tutorials/05-Migration.md). :zap::zap:
## Key Features
- **Portable** (using .NET Standard 2.0)
- **Standards conform** (works exactly as evergreen browsers)
- **Great performance** (outperforms similar parsers in most scenarios)
- **Extensible** (extend with your own services)
- **Useful abstractions** (type helpers, jQuery like construction)
- **Fully functional DOM** (all the lists, iterators, and events you know)
- **Form submission** (easily log in everywhere)
- **Navigation** (a `BrowsingContext` is like a browser tab - control it from .NET!).
- **LINQ enhanced** (use LINQ with DOM elements, naturally without wrappers)
The advantage over similar libraries like *HtmlAgilityPack* is that the exposed DOM is using the official W3C specified API, i.e., that even things like `querySelectorAll` are available in AngleSharp. Also the parser uses the HTML 5.1 specification, which defines error handling and element correction. The AngleSharp library focuses on standards compliance, interactivity, and extensibility. It is therefore giving web developers working with C# all possibilities as they know from using the DOM in any modern browser.
The performance of AngleSharp is quite close to the performance of browsers. Even very large pages can be processed within milliseconds. AngleSharp tries to minimize memory allocations and reuses elements internally to avoid unnecessary object creation.
## Simple Demo
The simple example will use the website of Wikipedia for data retrieval.
```cs
var config = Configuration.Default.WithDefaultLoader();
var address = "https://en.wikipedia.org/wiki/List_of_The_Big_Bang_Theory_episodes";
var context = BrowsingContext.New(config);
var document = await context.OpenAsync(address);
var cellSelector = "tr.vevent td:nth-child(3)";
var cells = document.QuerySelectorAll(cellSelector);
var titles = cells.Select(m => m.TextContent);
```
Or the same with explicit types:
```cs
IConfiguration config = Configuration.Default.WithDefaultLoader();
string address = "https://en.wikipedia.org/wiki/List_of_The_Big_Bang_Theory_episodes";
IBrowsingContext context = BrowsingContext.New(config);
IDocument document = await context.OpenAsync(address);
string cellSelector = "tr.vevent td:nth-child(3)";
IHtmlCollection<IElement> cells = document.QuerySelectorAll(cellSelector);
IEnumerable<string> titles = cells.Select(m => m.TextContent);
```
In the example we see:
* How to setup the configuration for supporting document loading
* Asynchronously get the document in a new context using the configuration
* Performing a query to get all cells with the content of interest
* The whole DOM supports LINQ queries
Every collection in AngleSharp supports LINQ statements. AngleSharp also provides many useful extension methods for element collections that cannot be found in the official DOM.
## Supported Platforms
AngleSharp has been created as a .NET Standard 2.0 compatible library. This includes, but is not limited to:
- .NET Core (2.0 and later)
- .NET Framework (4.6.1 and later)
- Xamarin.Android (7.0 and 8.0)
- Xamarin.iOS (10.0 and 10.14)
- Xamarin.Mac (3.0 and 3.8)
- Mono (4.6 and 5.4)
- UWP (10.0 and 10.0.16299)
- Unity (2018.1)
## Documentation
The documentation of AngleSharp is located [in the docs folder](docs/README.md). More examples, best-practices, and general information can be found there. The documentation also contains a list of [frequently asked questions](docs/tutorials/06-Questions.md).
More information is also available by following some of the hyper references mentioned in the Wiki. In-depth articles will be published on the CodeProject, with links being placed in the Wiki at GitHub.
## Use-Cases
- Parsing HTML (incl. fragments)
- Parsing CSS (incl. selectors, declarations, ...)
- Constructing HTML (e.g., view-engine)
- Minifying CSS, HTML, ...
- Querying document elements
- Crawling information
- Gathering statistics
- Web automation
- Tools with HTML / CSS / ... support
- Connection to page analytics
- HTML / DOM unit tests
- Automated JavaScript interaction
- Testing other concepts, e.g., script engines
- ...
## Vision
The project aims to bring a solid implementation of the W3C DOM for HTML, SVG, MathML, and CSS to the CLR - all written in C#. The idea is that you can basically do everything with the DOM in C# that you can do in JavaScript (plus, of course, more).
Most parts of the DOM are included, even though some may still miss their (fully specified / correct) implementation. The goal for v1.0 is to have *all practically relevant* parts implemented according to the official W3C specification (with useful extensions by the WHATWG).
The API is close to the DOM4 specification, however, the naming has been adjusted to apply with .NET conventions. Nevertheless, to make AngleSharp really useful for, e.g., a JavaScript engine, attributes have been placed on the corresponding interfaces (and methods, properties, ...) to indicate the status of the field in the official specification. This allows automatic generation of DOM objects with the official API.
This is a long-term project which will eventually result in a state of the art parser for the most important angle bracket based hyper-texts.
Our hope is to build a community around web parsing and libraries from this project. So far we had great contributions, but that goal was not fully achieved. Want to help? Get in touch with us!
## Participating in the Project
If you know some feature that AngleSharp is currently missing, and you are willing to implement the feature, then your contribution is more than welcome! Also if you have a really cool idea - do not be shy, we'd like to hear it.
If you have an idea how to improve the API (or what is missing) then posts / messages are also welcome. For instance there have been ongoing discussions about some styles that have been used by AngleSharp (e.g., `HTMLDocument` or `HtmlDocument`) in the past. In the end AngleSharp stopped using `HTMLDocument` (at least visible outside of the library). Now AngleSharp uses names like `IDocument`, `IHtmlElement` and so on. This change would not have been possible without such fruitful discussions.
The project is always searching for additional contributors. Even if you do not have any code to contribute, but rather an idea for improvement, a bug report or a mistake in the documentation. These are the contributions that keep this project active.
Live discussions can take place in our [Gitter chat](https://gitter.im/AngleSharp/AngleSharp), which supports using GitHub accounts.
More information is found in the [contribution guidelines](.github/CONTRIBUTING.md). All contributors can be found [in the CONTRIBUTORS](CONTRIBUTORS.md) file.
This project has also adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.
For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
## Funding / Support
If you use AngleSharp frequently, but you do not have the time to support the project by active participation you may still be interested to ensure that the AngleSharp projects keeps the lights on.
Therefore we created a backing model via [Bountysource](https://salt.bountysource.com/teams/anglesharp). Any donation is welcome and much appreciated. We will mostly spend the money on dedicated development time to improve AngleSharp where it needs to be improved, plus invest in the web utility eco-system in .NET (e.g., in JavaScript engines, other parsers, or a renderer for AngleSharp to mention some outstanding projects).
> Visit [Bountysource](https://salt.bountysource.com/teams/anglesharp) for more details.
## Development
AngleSharp is written in the most recent version of C# and thus requires Roslyn as a compiler. Using an IDE like Visual Studio 2019+ is recommended on Windows. Alternatively, VSCode (with OmniSharp or another suitable Language Server Protocol implementation) should be the tool of choice on other platforms.
The code tries to be as clean as possible. Notably the following rules are used:
- Use braces for any conditional / loop body
- Use the `-Async` suffixed methods when available
- Use VIP ("Var If Possible") style (in C++ called AAA: Almost Always Auto) to place types on the right
More important, however, is the proper usage of tests. Any new feature should come with a set of tests to cover the functionality and prevent regression.
## Changelog
A very detailed [changelog](CHANGELOG.md) exists. If you are just interested in major releases then have a look at [the GitHub releases](https://github.com/AngleSharp/AngleSharp/releases).
## .NET Foundation
This project is supported by the [.NET Foundation](https://dotnetfoundation.org).
## License
AngleSharp is released using the MIT license. For more information see the [license file](./LICENSE).

Binary file not shown.

View File

@@ -0,0 +1 @@
ziiduOsv2cM5Gip8AeXDAEp8EXmdHdsD8DsDSwsOaoNvvm8JDVCTvaJggh4mED+srpmlVdK+7wMl0TyJwdv8Cg==

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.4 KiB

View File

@@ -0,0 +1,5 @@
{
"version": 2,
"contentHash": "zy8TMeTP+1FH2NrLaNZtdRbBdq7u5MI+NFZQOBSM69u5RFkciinwzV2eveY6Kjf5MzgsYvvl6kTStsj3JrXqkg==",
"source": "https://api.nuget.org/v3/index.json"
}

View File

@@ -0,0 +1,25 @@
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
<metadata>
<id>BouncyCastle.Cryptography</id>
<version>2.5.1</version>
<title>BouncyCastle.NET Cryptography</title>
<authors>Legion of the Bouncy Castle Inc.</authors>
<license type="expression">MIT</license>
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
<icon>packageIcon.png</icon>
<readme>README.md</readme>
<projectUrl>https://www.bouncycastle.org/stable/nuget/csharp/website</projectUrl>
<iconUrl>https://www.bouncycastle.org/stable/nuget/csharp/packageIcon.png</iconUrl>
<description>BouncyCastle.NET is a popular cryptography library for .NET</description>
<releaseNotes>https://www.bouncycastle.org/stable/nuget/csharp/release_notes</releaseNotes>
<copyright>Copyright © Legion of the Bouncy Castle Inc. 2000-2024</copyright>
<tags>bouncycastle cryptography dtls encryption open-source openpgp post-quantum security tls</tags>
<repository type="git" url="https://github.com/bcgit/bc-csharp" branch="refs/heads/release/v2.5" commit="71250c8b20b4a98cf7574febf2fc216763e4ca6a" />
<dependencies>
<group targetFramework=".NETFramework4.6.1" />
<group targetFramework="net6.0" />
<group targetFramework=".NETStandard2.0" />
</dependencies>
</metadata>
</package>

View File

@@ -0,0 +1,13 @@
Copyright (c) 2000-2024 The Legion of the Bouncy Castle Inc. (https://www.bouncycastle.org).
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,
sub license, 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.**

View File

@@ -0,0 +1,45 @@
# The Bouncy Castle Cryptography Library For .NET
[![NuGet](https://img.shields.io/nuget/dt/BouncyCastle.Cryptography.svg)](https://www.nuget.org/packages/BouncyCastle.Cryptography) [![NuGet](https://img.shields.io/nuget/vpre/BouncyCastle.Cryptography.svg)](https://www.nuget.org/packages/BouncyCastle.Cryptography)
The Bouncy Castle Cryptography library is a .NET implementation of cryptographic algorithms and protocols. It was developed by the Legion of the Bouncy Castle, a registered Australian Charity, with a little help! The Legion, and the latest goings on with this package, can be found at [https://www.bouncycastle.org](https://www.bouncycastle.org).
In addition to providing basic cryptography algorithms, the package also provides support for CMS, OpenPGP, (D)TLS, TSP, X.509 certificate generation and more. The package also includes implementations of the following NIST Post-Quantum Cryptography Standardization algorithms: CRYSTALS-Dilithium, CRYSTALS-Kyber, Falcon, SPHINCS+, Classic McEliece, FrodoKEM, NTRU, NTRU Prime, Picnic, Saber, BIKE, and SIKE. These should all be considered EXPERIMENTAL and subject to change or removal. SIKE in particular is already slated for removal and should be used for research purposes only.
The Legion also gratefully acknowledges the contributions made to this package by others (see [here](https://www.bouncycastle.org/csharp/contributors.html) for the current list). If you would like to contribute to our efforts please feel free to get in touch with us or visit our [donations page](https://www.bouncycastle.org/donate), sponsor some specific work, or purchase a [support contract](https://www.keyfactor.com/platform/bouncy-castle-support/).
Except where otherwise stated, this software is distributed under a license based on the MIT X Consortium license. To view the license, [see here](https://www.bouncycastle.org/licence.html). This software includes a modified Bzip2 library, which is licensed under the [Apache Software License, Version 2.0](http://www.apache.org/licenses/).
**Note**: This source tree is not the FIPS version of the APIs - if you are interested in our FIPS version please visit us [here](https://www.bouncycastle.org/fips-csharp) or contact us directly at [office@bouncycastle.org](mailto:office@bouncycastle.org).
## Installing BouncyCastle
You should install [BouncyCastle with NuGet:](https://www.nuget.org/packages/BouncyCastle.Cryptography)
Install-Package BouncyCastle.Cryptography
Or via the .NET Core command line interface:
dotnet add package BouncyCastle.Cryptography
Either commands, from Package Manager Console or .NET Core CLI, will download and install BouncyCastle.Cryptography.
## Mailing Lists
For those who are interested, there are 2 mailing lists for participation in this project. To subscribe use the links below and include the word subscribe in the message body. (To unsubscribe, replace **subscribe** with **unsubscribe** in the message body)
* [announce-crypto-csharp-request@bouncycastle.org](mailto:announce-crypto-csharp-request@bouncycastle.org)
This mailing list is for new release announcements only, general subscribers cannot post to it.
* [dev-crypto-csharp-request@bouncycastle.org](mailto:dev-crypto-csharp-request@bouncycastle.org)
This mailing list is for discussion of development of the package. This includes bugs, comments, requests for enhancements, questions about use or operation.
**NOTE:** You need to be subscribed to send mail to the above mailing list.
## Feedback
If you want to provide feedback directly to the members of **The Legion** then please use [feedback-crypto@bouncycastle.org](mailto:feedback-crypto@bouncycastle.org). If you want to help this project survive please consider [donating](https://www.bouncycastle.org/donate).
For bug reporting/requests you can report issues on [github](https://github.com/bcgit/bc-csharp), or via [feedback-crypto@bouncycastle.org](mailto:feedback-crypto@bouncycastle.org) if required. We will accept pull requests based on this repository as well, but only on the basis that any code included may be distributed under the [Bouncy Castle License](https://www.bouncycastle.org/licence.html).
## Finally
Enjoy!

View File

@@ -0,0 +1 @@
zBLXFaejrNoOUbaASuEOHD6VQwCcEISFrmxOvodz3uV2Qvi+KR3CytzRSghqAjfZJSmJl97YoBpNWngce2erPQ==

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

View File

@@ -0,0 +1,5 @@
{
"version": 2,
"contentHash": "kKSyoVfndMriKHLfYGmr0uzQuI4jcc3TKGyww7buJFCYeHb/X0kodYBPL7n9454q7v6ASiRmDgpPGaDGerg/Hg==",
"source": "https://api.nuget.org/v3/index.json"
}

View File

@@ -0,0 +1,31 @@
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
<metadata>
<id>JetBrains.Annotations</id>
<version>2021.2.0</version>
<title>JetBrains ReSharper Annotations</title>
<authors>JetBrains</authors>
<owners>JetBrains</owners>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<license type="expression">MIT</license>
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
<icon>icon.png</icon>
<projectUrl>https://www.jetbrains.com/help/resharper/Code_Analysis__Code_Annotations.html</projectUrl>
<iconUrl>https://resources.jetbrains.com/storage/products/resharper/img/meta/ReSharper_64.png</iconUrl>
<description>ReSharper Annotations help reduce false positive warnings, explicitly declare purity and nullability in your code, deal with implicit usages of members, support special semantics of APIs in ASP.NET and XAML frameworks and otherwise increase accuracy of ReSharper code inspections.
All usages of ReSharper Annotations attributes are erased from metadata by default, which means no actual binary reference to 'JetBrains.Annotations.dll' assembly is produced. If you need to preserve these attributes in metadata, just define 'JETBRAINS_ANNOTATIONS' conditional compilation symbol in your projects.</description>
<summary>Annotations to increase accuracy of ReSharper code inspections</summary>
<releaseNotes>• Added 'UriStringAttribute' to enable URL features on string literals
• Added 'RequireStaticDelegateAttribute' to enforce the allocation-less usage patterns</releaseNotes>
<tags>jetbrains resharper annotations canbenull notnull</tags>
<dependencies>
<group targetFramework=".NETFramework2.0" />
<group targetFramework=".NETPortable4.0-Profile328" />
<group targetFramework=".NETStandard1.0">
<dependency id="System.Runtime" version="4.1.0" />
</group>
<group targetFramework=".NETStandard2.0" />
</dependencies>
</metadata>
</package>

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.4 KiB

View File

@@ -0,0 +1 @@
5PHop6aJCyEWoqW0SDNG4b3QrHsw1ntcAmuFlsUVCoaGi7LT6soi0OIugNvP7u2udV7BwpJYyIlaz8P5cQUXxQ==

View File

@@ -0,0 +1,823 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>JetBrains.Annotations</name>
</assembly>
<members>
<member name="T:JetBrains.Annotations.CanBeNullAttribute">
<summary>
Indicates that the value of the marked element could be <c>null</c> sometimes,
so checking for <c>null</c> is required before its usage.
</summary>
<example><code>
[CanBeNull] object Test() => null;
void UseTest() {
var p = Test();
var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.NotNullAttribute">
<summary>
Indicates that the value of the marked element can never be <c>null</c>.
</summary>
<example><code>
[NotNull] object Foo() {
return null; // Warning: Possible 'null' assignment
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.ItemNotNullAttribute">
<summary>
Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task
and Lazy classes to indicate that the value of a collection item, of the Task.Result property
or of the Lazy.Value property can never be null.
</summary>
<example><code>
public void Foo([ItemNotNull]List&lt;string&gt; books)
{
foreach (var book in books) {
if (book != null) // Warning: Expression is always true
Console.WriteLine(book.ToUpper());
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.ItemCanBeNullAttribute">
<summary>
Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task
and Lazy classes to indicate that the value of a collection item, of the Task.Result property
or of the Lazy.Value property can be null.
</summary>
<example><code>
public void Foo([ItemCanBeNull]List&lt;string&gt; books)
{
foreach (var book in books)
{
// Warning: Possible 'System.NullReferenceException'
Console.WriteLine(book.ToUpper());
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.StringFormatMethodAttribute">
<summary>
Indicates that the marked method builds string by the format pattern and (optional) arguments.
The parameter, which contains the format string, should be given in the constructor. The format string
should be in <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/>-like form.
</summary>
<example><code>
[StringFormatMethod("message")]
void ShowError(string message, params object[] args) { /* do something */ }
void Foo() {
ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
}
</code></example>
</member>
<member name="M:JetBrains.Annotations.StringFormatMethodAttribute.#ctor(System.String)">
<param name="formatParameterName">
Specifies which parameter of an annotated method should be treated as the format string
</param>
</member>
<member name="T:JetBrains.Annotations.StructuredMessageTemplateAttribute">
<summary>
Indicates that the marked parameter is a message template where placeholders are to be replaced by the following arguments
in the order in which they appear
</summary>
<example><code>
void LogInfo([StructuredMessageTemplate]string message, params object[] args) { /* do something */ }
void Foo() {
LogInfo("User created: {username}"); // Warning: Non-existing argument in format string
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.ValueProviderAttribute">
<summary>
Use this annotation to specify a type that contains static or const fields
with values for the annotated property/field/parameter.
The specified type will be used to improve completion suggestions.
</summary>
<example><code>
namespace TestNamespace
{
public class Constants
{
public static int INT_CONST = 1;
public const string STRING_CONST = "1";
}
public class Class1
{
[ValueProvider("TestNamespace.Constants")] public int myField;
public void Foo([ValueProvider("TestNamespace.Constants")] string str) { }
public void Test()
{
Foo(/*try completion here*/);//
myField = /*try completion here*/
}
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.ValueRangeAttribute">
<summary>
Indicates that the integral value falls into the specified interval.
It's allowed to specify multiple non-intersecting intervals.
Values of interval boundaries are inclusive.
</summary>
<example><code>
void Foo([ValueRange(0, 100)] int value) {
if (value == -1) { // Warning: Expression is always 'false'
...
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.NonNegativeValueAttribute">
<summary>
Indicates that the integral value never falls below zero.
</summary>
<example><code>
void Foo([NonNegativeValue] int value) {
if (value == -1) { // Warning: Expression is always 'false'
...
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.InvokerParameterNameAttribute">
<summary>
Indicates that the function argument should be a string literal and match one
of the parameters of the caller function. For example, ReSharper annotates
the parameter of <see cref="T:System.ArgumentNullException"/>.
</summary>
<example><code>
void Foo(string param) {
if (param == null)
throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.NotifyPropertyChangedInvocatorAttribute">
<summary>
Indicates that the method is contained in a type that implements
<c>System.ComponentModel.INotifyPropertyChanged</c> interface and this method
is used to notify that some property value changed.
</summary>
<remarks>
The method should be non-static and conform to one of the supported signatures:
<list>
<item><c>NotifyChanged(string)</c></item>
<item><c>NotifyChanged(params string[])</c></item>
<item><c>NotifyChanged{T}(Expression{Func{T}})</c></item>
<item><c>NotifyChanged{T,U}(Expression{Func{T,U}})</c></item>
<item><c>SetProperty{T}(ref T, T, string)</c></item>
</list>
</remarks>
<example><code>
public class Foo : INotifyPropertyChanged {
public event PropertyChangedEventHandler PropertyChanged;
[NotifyPropertyChangedInvocator]
protected virtual void NotifyChanged(string propertyName) { ... }
string _name;
public string Name {
get { return _name; }
set { _name = value; NotifyChanged("LastName"); /* Warning */ }
}
}
</code>
Examples of generated notifications:
<list>
<item><c>NotifyChanged("Property")</c></item>
<item><c>NotifyChanged(() =&gt; Property)</c></item>
<item><c>NotifyChanged((VM x) =&gt; x.Property)</c></item>
<item><c>SetProperty(ref myField, value, "Property")</c></item>
</list>
</example>
</member>
<member name="T:JetBrains.Annotations.ContractAnnotationAttribute">
<summary>
Describes dependency between method input and output.
</summary>
<syntax>
<p>Function Definition Table syntax:</p>
<list>
<item>FDT ::= FDTRow [;FDTRow]*</item>
<item>FDTRow ::= Input =&gt; Output | Output &lt;= Input</item>
<item>Input ::= ParameterName: Value [, Input]*</item>
<item>Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value}</item>
<item>Value ::= true | false | null | notnull | canbenull</item>
</list>
If the method has a single input parameter, its name could be omitted.<br/>
Using <c>halt</c> (or <c>void</c>/<c>nothing</c>, which is the same) for the method output
means that the method doesn't return normally (throws or terminates the process).<br/>
Value <c>canbenull</c> is only applicable for output parameters.<br/>
You can use multiple <c>[ContractAnnotation]</c> for each FDT row, or use single attribute
with rows separated by the semicolon. There is no notion of order rows, all rows are checked
for applicability and applied per each program state tracked by the analysis engine.<br/>
</syntax>
<examples><list>
<item><code>
[ContractAnnotation("=&gt; halt")]
public void TerminationMethod()
</code></item>
<item><code>
[ContractAnnotation("null &lt;= param:null")] // reverse condition syntax
public string GetName(string surname)
</code></item>
<item><code>
[ContractAnnotation("s:null =&gt; true")]
public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty()
</code></item>
<item><code>
// A method that returns null if the parameter is null,
// and not null if the parameter is not null
[ContractAnnotation("null =&gt; null; notnull =&gt; notnull")]
public object Transform(object data)
</code></item>
<item><code>
[ContractAnnotation("=&gt; true, result: notnull; =&gt; false, result: null")]
public bool TryParse(string s, out Person result)
</code></item>
</list></examples>
</member>
<member name="T:JetBrains.Annotations.LocalizationRequiredAttribute">
<summary>
Indicates whether the marked element should be localized.
</summary>
<example><code>
[LocalizationRequiredAttribute(true)]
class Foo {
string str = "my string"; // Warning: Localizable string
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.CannotApplyEqualityOperatorAttribute">
<summary>
Indicates that the value of the marked type (or its derivatives)
cannot be compared using '==' or '!=' operators and <c>Equals()</c>
should be used instead. However, using '==' or '!=' for comparison
with <c>null</c> is always permitted.
</summary>
<example><code>
[CannotApplyEqualityOperator]
class NoEquality { }
class UsesNoEquality {
void Test() {
var ca1 = new NoEquality();
var ca2 = new NoEquality();
if (ca1 != null) { // OK
bool condition = ca1 == ca2; // Warning
}
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.BaseTypeRequiredAttribute">
<summary>
When applied to a target attribute, specifies a requirement for any type marked
with the target attribute to implement or inherit specific type or types.
</summary>
<example><code>
[BaseTypeRequired(typeof(IComponent)] // Specify requirement
class ComponentAttribute : Attribute { }
[Component] // ComponentAttribute requires implementing IComponent interface
class MyComponent : IComponent { }
</code></example>
</member>
<member name="T:JetBrains.Annotations.UsedImplicitlyAttribute">
<summary>
Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library),
so this symbol will be ignored by usage-checking inspections. <br/>
You can use <see cref="T:JetBrains.Annotations.ImplicitUseKindFlags"/> and <see cref="T:JetBrains.Annotations.ImplicitUseTargetFlags"/>
to configure how this attribute is applied.
</summary>
<example><code>
[UsedImplicitly]
public class TypeConverter {}
public class SummaryData
{
[UsedImplicitly(ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature)]
public SummaryData() {}
}
[UsedImplicitly(ImplicitUseTargetFlags.WithInheritors | ImplicitUseTargetFlags.Default)]
public interface IService {}
</code></example>
</member>
<member name="T:JetBrains.Annotations.MeansImplicitUseAttribute">
<summary>
Can be applied to attributes, type parameters, and parameters of a type assignable from <see cref="T:System.Type"/> .
When applied to an attribute, the decorated attribute behaves the same as <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
When applied to a type parameter or to a parameter of type <see cref="T:System.Type"/>,
indicates that the corresponding type is used implicitly.
</summary>
</member>
<member name="T:JetBrains.Annotations.ImplicitUseKindFlags">
<summary>
Specifies the details of implicitly used symbol when it is marked
with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Access">
<summary>Only entity marked with attribute considered used.</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Assign">
<summary>Indicates implicit assignment to a member.</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature">
<summary>
Indicates implicit instantiation of a type with fixed constructor signature.
That means any unused constructor parameters won't be reported as such.
</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature">
<summary>Indicates implicit instantiation of a type.</summary>
</member>
<member name="T:JetBrains.Annotations.ImplicitUseTargetFlags">
<summary>
Specifies what is considered to be used implicitly when marked
with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.Members">
<summary>Members of the type marked with the attribute are considered used.</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.WithInheritors">
<summary> Inherited entities are considered used. </summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.WithMembers">
<summary>Entity marked with the attribute and all its members considered used.</summary>
</member>
<member name="T:JetBrains.Annotations.PublicAPIAttribute">
<summary>
This attribute is intended to mark publicly available API,
which should not be removed and so is treated as used.
</summary>
</member>
<member name="T:JetBrains.Annotations.InstantHandleAttribute">
<summary>
Tells the code analysis engine if the parameter is completely handled when the invoked method is on stack.
If the parameter is a delegate, indicates that delegate is executed while the method is executed.
If the parameter is an enumerable, indicates that it is enumerated while the method is executed.
</summary>
</member>
<member name="T:JetBrains.Annotations.PureAttribute">
<summary>
Indicates that a method does not make any observable state changes.
The same as <c>System.Diagnostics.Contracts.PureAttribute</c>.
</summary>
<example><code>
[Pure] int Multiply(int x, int y) => x * y;
void M() {
Multiply(123, 42); // Warning: Return value of pure method is not used
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.MustUseReturnValueAttribute">
<summary>
Indicates that the return value of the method invocation must be used.
</summary>
<remarks>
Methods decorated with this attribute (in contrast to pure methods) might change state,
but make no sense without using their return value. <br/>
Similarly to <see cref="T:JetBrains.Annotations.PureAttribute"/>, this attribute
will help to detect usages of the method when the return value is not used.
Optionally, you can specify a message to use when showing warnings, e.g.
<code>[MustUseReturnValue("Use the return value to...")]</code>.
</remarks>
</member>
<member name="T:JetBrains.Annotations.RequireStaticDelegateAttribute">
<summary>
This annotation allows to enforce allocation-less usage patterns of delegates for performance-critical APIs.
When this annotation is applied to the parameter of delegate type, IDE checks the input argument of this parameter:
* When lambda expression or anonymous method is passed as an argument, IDE verifies that the passed closure
has no captures of the containing local variables and the compiler is able to cache the delegate instance
to avoid heap allocations. Otherwise the warning is produced.
* IDE warns when method name or local function name is passed as an argument as this always results
in heap allocation of the delegate instance.
</summary>
<remarks>
In C# 9.0 code IDE would also suggest to annotate the anonymous function with 'static' modifier
to make use of the similar analysis provided by the language/compiler.
</remarks>
</member>
<member name="T:JetBrains.Annotations.ProvidesContextAttribute">
<summary>
Indicates the type member or parameter of some type, that should be used instead of all other ways
to get the value of that type. This annotation is useful when you have some "context" value evaluated
and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one.
</summary>
<example><code>
class Foo {
[ProvidesContext] IBarService _barService = ...;
void ProcessNode(INode node) {
DoSomething(node, node.GetGlobalServices().Bar);
// ^ Warning: use value of '_barService' field
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.PathReferenceAttribute">
<summary>
Indicates that a parameter is a path to a file or a folder within a web project.
Path can be relative or absolute, starting from web root (~).
</summary>
</member>
<member name="T:JetBrains.Annotations.SourceTemplateAttribute">
<summary>
An extension method marked with this attribute is processed by code completion
as a 'Source Template'. When the extension method is completed over some expression, its source code
is automatically expanded like a template at call site.
</summary>
<remarks>
Template method body can contain valid source code and/or special comments starting with '$'.
Text inside these comments is added as source code when the template is applied. Template parameters
can be used either as additional method parameters or as identifiers wrapped in two '$' signs.
Use the <see cref="T:JetBrains.Annotations.MacroAttribute"/> attribute to specify macros for parameters.
</remarks>
<example>
In this example, the 'forEach' method is a source template available over all values
of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block:
<code>
[SourceTemplate]
public static void forEach&lt;T&gt;(this IEnumerable&lt;T&gt; xs) {
foreach (var x in xs) {
//$ $END$
}
}
</code>
</example>
</member>
<member name="T:JetBrains.Annotations.MacroAttribute">
<summary>
Allows specifying a macro for a parameter of a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see>.
</summary>
<remarks>
You can apply the attribute on the whole method or on any of its additional parameters. The macro expression
is defined in the <see cref="P:JetBrains.Annotations.MacroAttribute.Expression"/> property. When applied on a method, the target
template parameter is defined in the <see cref="P:JetBrains.Annotations.MacroAttribute.Target"/> property. To apply the macro silently
for the parameter, set the <see cref="P:JetBrains.Annotations.MacroAttribute.Editable"/> property value = -1.
</remarks>
<example>
Applying the attribute on a source template method:
<code>
[SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")]
public static void forEach&lt;T&gt;(this IEnumerable&lt;T&gt; collection) {
foreach (var item in collection) {
//$ $END$
}
}
</code>
Applying the attribute on a template method parameter:
<code>
[SourceTemplate]
public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) {
/*$ var $x$Id = "$newguid$" + x.ToString();
x.DoSomething($x$Id); */
}
</code>
</example>
</member>
<member name="P:JetBrains.Annotations.MacroAttribute.Expression">
<summary>
Allows specifying a macro that will be executed for a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see>
parameter when the template is expanded.
</summary>
</member>
<member name="P:JetBrains.Annotations.MacroAttribute.Editable">
<summary>
Allows specifying which occurrence of the target parameter becomes editable when the template is deployed.
</summary>
<remarks>
If the target parameter is used several times in the template, only one occurrence becomes editable;
other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence,
use values >= 0. To make the parameter non-editable when the template is expanded, use -1.
</remarks>
</member>
<member name="P:JetBrains.Annotations.MacroAttribute.Target">
<summary>
Identifies the target parameter of a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see> if the
<see cref="T:JetBrains.Annotations.MacroAttribute"/> is applied on a template method.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcActionAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
is an MVC action. If applied to a method, the MVC action name is calculated
implicitly from the context. Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcAreaAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC area.
Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcControllerAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is
an MVC controller. If applied to a method, the MVC controller name is calculated
implicitly from the context. Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcMasterAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC Master. Use this attribute
for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcModelTypeAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC model type. Use this attribute
for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, Object)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcPartialViewAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC
partial view. If applied to a method, the MVC partial view name is calculated implicitly
from the context. Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcSuppressViewErrorAttribute">
<summary>
ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcDisplayTemplateAttribute">
<summary>
ASP.NET MVC attribute. Indicates that a parameter is an MVC display template.
Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcEditorTemplateAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC editor template.
Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcTemplateAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC template.
Use this attribute for custom wrappers similar to
<c>System.ComponentModel.DataAnnotations.UIHintAttribute(System.String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcViewAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
is an MVC view component. If applied to a method, the MVC view name is calculated implicitly
from the context. Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Controller.View(Object)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcViewComponentAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
is an MVC view component name.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcViewComponentViewAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
is an MVC view component view. If applied to a method, the MVC view component view name is default.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcActionSelectorAttribute">
<summary>
ASP.NET MVC attribute. When applied to a parameter of an attribute,
indicates that this parameter is an MVC action name.
</summary>
<example><code>
[ActionName("Foo")]
public ActionResult Login(string returnUrl) {
ViewBag.ReturnUrl = Url.Action("Foo"); // OK
return RedirectToAction("Bar"); // Error: Cannot resolve action
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.RazorSectionAttribute">
<summary>
Razor attribute. Indicates that the marked parameter or method is a Razor section.
Use this attribute for custom wrappers similar to
<c>System.Web.WebPages.WebPageBase.RenderSection(String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.CollectionAccessAttribute">
<summary>
Indicates how method, constructor invocation, or property access
over collection type affects the contents of the collection.
Use <see cref="P:JetBrains.Annotations.CollectionAccessAttribute.CollectionAccessType"/> to specify the access type.
</summary>
<remarks>
Using this attribute only makes sense if all collection methods are marked with this attribute.
</remarks>
<example><code>
public class MyStringCollection : List&lt;string&gt;
{
[CollectionAccess(CollectionAccessType.Read)]
public string GetFirstString()
{
return this.ElementAt(0);
}
}
class Test
{
public void Foo()
{
// Warning: Contents of the collection is never updated
var col = new MyStringCollection();
string x = col.GetFirstString();
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.CollectionAccessType">
<summary>
Provides a value for the <see cref="T:JetBrains.Annotations.CollectionAccessAttribute"/> to define
how the collection method invocation affects the contents of the collection.
</summary>
</member>
<member name="F:JetBrains.Annotations.CollectionAccessType.None">
<summary>Method does not use or modify content of the collection.</summary>
</member>
<member name="F:JetBrains.Annotations.CollectionAccessType.Read">
<summary>Method only reads content of the collection but does not modify it.</summary>
</member>
<member name="F:JetBrains.Annotations.CollectionAccessType.ModifyExistingContent">
<summary>Method can change content of the collection but does not add new elements.</summary>
</member>
<member name="F:JetBrains.Annotations.CollectionAccessType.UpdatedContent">
<summary>Method can add new elements to the collection.</summary>
</member>
<member name="T:JetBrains.Annotations.AssertionMethodAttribute">
<summary>
Indicates that the marked method is assertion method, i.e. it halts the control flow if
one of the conditions is satisfied. To set the condition, mark one of the parameters with
<see cref="T:JetBrains.Annotations.AssertionConditionAttribute"/> attribute.
</summary>
</member>
<member name="T:JetBrains.Annotations.AssertionConditionAttribute">
<summary>
Indicates the condition parameter of the assertion method. The method itself should be
marked by <see cref="T:JetBrains.Annotations.AssertionMethodAttribute"/> attribute. The mandatory argument of
the attribute is the assertion type.
</summary>
</member>
<member name="T:JetBrains.Annotations.AssertionConditionType">
<summary>
Specifies assertion type. If the assertion method argument satisfies the condition,
then the execution continues. Otherwise, execution is assumed to be halted.
</summary>
</member>
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_TRUE">
<summary>Marked parameter should be evaluated to true.</summary>
</member>
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_FALSE">
<summary>Marked parameter should be evaluated to false.</summary>
</member>
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_NULL">
<summary>Marked parameter should be evaluated to null value.</summary>
</member>
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_NOT_NULL">
<summary>Marked parameter should be evaluated to not null value.</summary>
</member>
<member name="T:JetBrains.Annotations.TerminatesProgramAttribute">
<summary>
Indicates that the marked method unconditionally terminates control flow execution.
For example, it could unconditionally throw exception.
</summary>
</member>
<member name="T:JetBrains.Annotations.LinqTunnelAttribute">
<summary>
Indicates that the method is a pure LINQ method, with postponed enumeration (like Enumerable.Select,
.Where). This annotation allows inference of [InstantHandle] annotation for parameters
of delegate type by analyzing LINQ method chains.
</summary>
</member>
<member name="T:JetBrains.Annotations.NoEnumerationAttribute">
<summary>
Indicates that IEnumerable passed as a parameter is not enumerated.
Use this annotation to suppress the 'Possible multiple enumeration of IEnumerable' inspection.
</summary>
<example><code>
static void ThrowIfNull&lt;T&gt;([NoEnumeration] T v, string n) where T : class
{
// custom check for null but no enumeration
}
void Foo(IEnumerable&lt;string&gt; values)
{
ThrowIfNull(values, nameof(values));
var x = values.ToList(); // No warnings about multiple enumeration
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.RegexPatternAttribute">
<summary>
Indicates that the marked parameter, field, or property is a regular expression pattern.
</summary>
</member>
<member name="T:JetBrains.Annotations.NoReorderAttribute">
<summary>
Prevents the Member Reordering feature from tossing members of the marked class.
</summary>
<remarks>
The attribute must be mentioned in your member reordering patterns.
</remarks>
</member>
<member name="T:JetBrains.Annotations.XamlItemsControlAttribute">
<summary>
XAML attribute. Indicates the type that has <c>ItemsSource</c> property and should be treated
as <c>ItemsControl</c>-derived type, to enable inner items <c>DataContext</c> type resolve.
</summary>
</member>
<member name="T:JetBrains.Annotations.XamlItemBindingOfItemsControlAttribute">
<summary>
XAML attribute. Indicates the property of some <c>BindingBase</c>-derived type, that
is used to bind some item of <c>ItemsControl</c>-derived type. This annotation will
enable the <c>DataContext</c> type resolve for XAML bindings for such properties.
</summary>
<remarks>
Property should have the tree ancestor of the <c>ItemsControl</c> type or
marked with the <see cref="T:JetBrains.Annotations.XamlItemsControlAttribute"/> attribute.
</remarks>
</member>
<member name="T:JetBrains.Annotations.XamlItemStyleOfItemsControlAttribute">
<summary>
XAML attribute. Indicates the property of some <c>Style</c>-derived type, that
is used to style items of <c>ItemsControl</c>-derived type. This annotation will
enable the <c>DataContext</c> type resolve for XAML bindings for such properties.
</summary>
<remarks>
Property should have the tree ancestor of the <c>ItemsControl</c> type or
marked with the <see cref="T:JetBrains.Annotations.XamlItemsControlAttribute"/> attribute.
</remarks>
</member>
<member name="T:JetBrains.Annotations.XamlOneWayBindingModeByDefaultAttribute">
<summary>
XAML attribute. Indicates that DependencyProperty has <c>OneWay</c> binding mode by default.
</summary>
<remarks>
This attribute must be applied to DependencyProperty's CLR accessor property if it is present, to DependencyProperty descriptor field otherwise.
</remarks>
</member>
<member name="T:JetBrains.Annotations.XamlTwoWayBindingModeByDefaultAttribute">
<summary>
XAML attribute. Indicates that DependencyProperty has <c>TwoWay</c> binding mode by default.
</summary>
<remarks>
This attribute must be applied to DependencyProperty's CLR accessor property if it is present, to DependencyProperty descriptor field otherwise.
</remarks>
</member>
<member name="T:JetBrains.Annotations.RouteTemplateAttribute">
<summary>
Indicates that the marked parameter, field, or property is a route template.
</summary>
<remarks>
This attribute allows IDE to recognize the use of web frameworks' route templates
to enable syntax highlighting, code completion, navigation, rename and other features in string literals.
</remarks>
</member>
<member name="T:JetBrains.Annotations.RouteParameterConstraintAttribute">
<summary>
Indicates that the marked type is custom route parameter constraint,
which is registered in application's Startup with name <c>ConstraintName</c>
</summary>
<remarks>
You can specify <c>ProposedType</c> if target constraint matches only route parameters of specific type,
it will allow IDE to create method's parameter from usage in route template
with specified type instead of default <c>System.String</c>
and check if constraint's proposed type conflicts with matched parameter's type
</remarks>
</member>
<member name="T:JetBrains.Annotations.UriStringAttribute">
<summary>
Indicates that the marked parameter, field, or property is an URI string.
</summary>
<remarks>
This attribute enables code completion, navigation, rename and other features
in URI string literals assigned to annotated parameter, field or property.
</remarks>
</member>
</members>
</doc>

View File

@@ -0,0 +1,386 @@
{
"runtimeTarget": {
"name": ".NETStandard,Version=v1.0/",
"signature": ""
},
"compilationOptions": {},
"targets": {
".NETStandard,Version=v1.0": {},
".NETStandard,Version=v1.0/": {
"JetBrains.Annotations/2021.2": {
"dependencies": {
"NETStandard.Library": "1.6.0"
},
"runtime": {
"JetBrains.Annotations.dll": {}
}
},
"Microsoft.NETCore.Platforms/1.0.1": {},
"Microsoft.NETCore.Targets/1.0.1": {},
"NETStandard.Library/1.6.0": {
"dependencies": {
"Microsoft.NETCore.Platforms": "1.0.1",
"System.Collections": "4.0.11",
"System.Diagnostics.Debug": "4.0.11",
"System.Diagnostics.Tools": "4.0.1",
"System.Globalization": "4.0.11",
"System.IO": "4.1.0",
"System.Linq": "4.1.0",
"System.Linq.Expressions": "4.1.0",
"System.Net.Primitives": "4.0.11",
"System.ObjectModel": "4.0.12",
"System.Reflection": "4.1.0",
"System.Reflection.Extensions": "4.0.1",
"System.Reflection.Primitives": "4.0.1",
"System.Resources.ResourceManager": "4.0.1",
"System.Runtime": "4.1.0",
"System.Runtime.Extensions": "4.1.0",
"System.Text.Encoding": "4.0.11",
"System.Text.Encoding.Extensions": "4.0.11",
"System.Text.RegularExpressions": "4.1.0",
"System.Threading": "4.0.11",
"System.Threading.Tasks": "4.0.11",
"System.Xml.ReaderWriter": "4.0.11",
"System.Xml.XDocument": "4.0.11"
}
},
"System.Collections/4.0.11": {
"dependencies": {
"Microsoft.NETCore.Platforms": "1.0.1",
"Microsoft.NETCore.Targets": "1.0.1",
"System.Runtime": "4.1.0"
}
},
"System.Diagnostics.Debug/4.0.11": {
"dependencies": {
"Microsoft.NETCore.Platforms": "1.0.1",
"Microsoft.NETCore.Targets": "1.0.1",
"System.Runtime": "4.1.0"
}
},
"System.Diagnostics.Tools/4.0.1": {
"dependencies": {
"Microsoft.NETCore.Platforms": "1.0.1",
"Microsoft.NETCore.Targets": "1.0.1",
"System.Runtime": "4.1.0"
}
},
"System.Globalization/4.0.11": {
"dependencies": {
"Microsoft.NETCore.Platforms": "1.0.1",
"Microsoft.NETCore.Targets": "1.0.1",
"System.Runtime": "4.1.0"
}
},
"System.IO/4.1.0": {
"dependencies": {
"Microsoft.NETCore.Platforms": "1.0.1",
"Microsoft.NETCore.Targets": "1.0.1",
"System.Runtime": "4.1.0",
"System.Text.Encoding": "4.0.11",
"System.Threading.Tasks": "4.0.11"
}
},
"System.Linq/4.1.0": {
"dependencies": {
"System.Collections": "4.0.11",
"System.Runtime": "4.1.0"
}
},
"System.Linq.Expressions/4.1.0": {
"dependencies": {
"System.Reflection": "4.1.0",
"System.Runtime": "4.1.0"
}
},
"System.Net.Primitives/4.0.11": {
"dependencies": {
"Microsoft.NETCore.Platforms": "1.0.1",
"Microsoft.NETCore.Targets": "1.0.1",
"System.Runtime": "4.1.0"
}
},
"System.ObjectModel/4.0.12": {
"dependencies": {
"System.Runtime": "4.1.0"
}
},
"System.Reflection/4.1.0": {
"dependencies": {
"Microsoft.NETCore.Platforms": "1.0.1",
"Microsoft.NETCore.Targets": "1.0.1",
"System.IO": "4.1.0",
"System.Reflection.Primitives": "4.0.1",
"System.Runtime": "4.1.0"
}
},
"System.Reflection.Extensions/4.0.1": {
"dependencies": {
"Microsoft.NETCore.Platforms": "1.0.1",
"Microsoft.NETCore.Targets": "1.0.1",
"System.Reflection": "4.1.0",
"System.Runtime": "4.1.0"
}
},
"System.Reflection.Primitives/4.0.1": {
"dependencies": {
"Microsoft.NETCore.Platforms": "1.0.1",
"Microsoft.NETCore.Targets": "1.0.1",
"System.Runtime": "4.1.0"
}
},
"System.Resources.ResourceManager/4.0.1": {
"dependencies": {
"Microsoft.NETCore.Platforms": "1.0.1",
"Microsoft.NETCore.Targets": "1.0.1",
"System.Globalization": "4.0.11",
"System.Reflection": "4.1.0",
"System.Runtime": "4.1.0"
}
},
"System.Runtime/4.1.0": {
"dependencies": {
"Microsoft.NETCore.Platforms": "1.0.1",
"Microsoft.NETCore.Targets": "1.0.1"
}
},
"System.Runtime.Extensions/4.1.0": {
"dependencies": {
"Microsoft.NETCore.Platforms": "1.0.1",
"Microsoft.NETCore.Targets": "1.0.1",
"System.Runtime": "4.1.0"
}
},
"System.Text.Encoding/4.0.11": {
"dependencies": {
"Microsoft.NETCore.Platforms": "1.0.1",
"Microsoft.NETCore.Targets": "1.0.1",
"System.Runtime": "4.1.0"
}
},
"System.Text.Encoding.Extensions/4.0.11": {
"dependencies": {
"Microsoft.NETCore.Platforms": "1.0.1",
"Microsoft.NETCore.Targets": "1.0.1",
"System.Runtime": "4.1.0",
"System.Text.Encoding": "4.0.11"
}
},
"System.Text.RegularExpressions/4.1.0": {
"dependencies": {
"System.Runtime": "4.1.0"
}
},
"System.Threading/4.0.11": {
"dependencies": {
"System.Runtime": "4.1.0",
"System.Threading.Tasks": "4.0.11"
}
},
"System.Threading.Tasks/4.0.11": {
"dependencies": {
"Microsoft.NETCore.Platforms": "1.0.1",
"Microsoft.NETCore.Targets": "1.0.1",
"System.Runtime": "4.1.0"
}
},
"System.Xml.ReaderWriter/4.0.11": {
"dependencies": {
"System.IO": "4.1.0",
"System.Runtime": "4.1.0",
"System.Text.Encoding": "4.0.11",
"System.Threading.Tasks": "4.0.11"
}
},
"System.Xml.XDocument/4.0.11": {
"dependencies": {
"System.IO": "4.1.0",
"System.Runtime": "4.1.0",
"System.Xml.ReaderWriter": "4.0.11"
}
}
}
},
"libraries": {
"JetBrains.Annotations/2021.2": {
"type": "project",
"serviceable": false,
"sha512": ""
},
"Microsoft.NETCore.Platforms/1.0.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-2G6OjjJzwBfNOO8myRV/nFrbTw5iA+DEm0N+qUqhrOmaVtn4pC77h38I1jsXGw5VH55+dPfQsqHD0We9sCl9FQ==",
"path": "microsoft.netcore.platforms/1.0.1",
"hashPath": "microsoft.netcore.platforms.1.0.1.nupkg.sha512"
},
"Microsoft.NETCore.Targets/1.0.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-rkn+fKobF/cbWfnnfBOQHKVKIOpxMZBvlSHkqDWgBpwGDcLRduvs3D9OLGeV6GWGvVwNlVi2CBbTjuPmtHvyNw==",
"path": "microsoft.netcore.targets/1.0.1",
"hashPath": "microsoft.netcore.targets.1.0.1.nupkg.sha512"
},
"NETStandard.Library/1.6.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-ypsCvIdCZ4IoYASJHt6tF2fMo7N30NLgV1EbmC+snO490OMl9FvVxmumw14rhReWU3j3g7BYudG6YCrchwHJlA==",
"path": "netstandard.library/1.6.0",
"hashPath": "netstandard.library.1.6.0.nupkg.sha512"
},
"System.Collections/4.0.11": {
"type": "package",
"serviceable": true,
"sha512": "sha512-YUJGz6eFKqS0V//mLt25vFGrrCvOnsXjlvFQs+KimpwNxug9x0Pzy4PlFMU3Q2IzqAa9G2L4LsK3+9vCBK7oTg==",
"path": "system.collections/4.0.11",
"hashPath": "system.collections.4.0.11.nupkg.sha512"
},
"System.Diagnostics.Debug/4.0.11": {
"type": "package",
"serviceable": true,
"sha512": "sha512-w5U95fVKHY4G8ASs/K5iK3J5LY+/dLFd4vKejsnI/ZhBsWS9hQakfx3Zr7lRWKg4tAw9r4iktyvsTagWkqYCiw==",
"path": "system.diagnostics.debug/4.0.11",
"hashPath": "system.diagnostics.debug.4.0.11.nupkg.sha512"
},
"System.Diagnostics.Tools/4.0.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-xBfJ8pnd4C17dWaC9FM6aShzbJcRNMChUMD42I6772KGGrqaFdumwhn9OdM68erj1ueNo3xdQ1EwiFjK5k8p0g==",
"path": "system.diagnostics.tools/4.0.1",
"hashPath": "system.diagnostics.tools.4.0.1.nupkg.sha512"
},
"System.Globalization/4.0.11": {
"type": "package",
"serviceable": true,
"sha512": "sha512-B95h0YLEL2oSnwF/XjqSWKnwKOy/01VWkNlsCeMTFJLLabflpGV26nK164eRs5GiaRSBGpOxQ3pKoSnnyZN5pg==",
"path": "system.globalization/4.0.11",
"hashPath": "system.globalization.4.0.11.nupkg.sha512"
},
"System.IO/4.1.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-3KlTJceQc3gnGIaHZ7UBZO26SHL1SHE4ddrmiwumFnId+CEHP+O8r386tZKaE6zlk5/mF8vifMBzHj9SaXN+mQ==",
"path": "system.io/4.1.0",
"hashPath": "system.io.4.1.0.nupkg.sha512"
},
"System.Linq/4.1.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-bQ0iYFOQI0nuTnt+NQADns6ucV4DUvMdwN6CbkB1yj8i7arTGiTN5eok1kQwdnnNWSDZfIUySQY+J3d5KjWn0g==",
"path": "system.linq/4.1.0",
"hashPath": "system.linq.4.1.0.nupkg.sha512"
},
"System.Linq.Expressions/4.1.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-I+y02iqkgmCAyfbqOmSDOgqdZQ5tTj80Akm5BPSS8EeB0VGWdy6X1KCoYe8Pk6pwDoAKZUOdLVxnTJcExiv5zw==",
"path": "system.linq.expressions/4.1.0",
"hashPath": "system.linq.expressions.4.1.0.nupkg.sha512"
},
"System.Net.Primitives/4.0.11": {
"type": "package",
"serviceable": true,
"sha512": "sha512-hVvfl4405DRjA2408luZekbPhplJK03j2Y2lSfMlny7GHXlkByw1iLnc9mgKW0GdQn73vvMcWrWewAhylXA4Nw==",
"path": "system.net.primitives/4.0.11",
"hashPath": "system.net.primitives.4.0.11.nupkg.sha512"
},
"System.ObjectModel/4.0.12": {
"type": "package",
"serviceable": true,
"sha512": "sha512-tAgJM1xt3ytyMoW4qn4wIqgJYm7L7TShRZG4+Q4Qsi2PCcj96pXN7nRywS9KkB3p/xDUjc2HSwP9SROyPYDYKQ==",
"path": "system.objectmodel/4.0.12",
"hashPath": "system.objectmodel.4.0.12.nupkg.sha512"
},
"System.Reflection/4.1.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-JCKANJ0TI7kzoQzuwB/OoJANy1Lg338B6+JVacPl4TpUwi3cReg3nMLplMq2uqYfHFQpKIlHAUVAJlImZz/4ng==",
"path": "system.reflection/4.1.0",
"hashPath": "system.reflection.4.1.0.nupkg.sha512"
},
"System.Reflection.Extensions/4.0.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-GYrtRsZcMuHF3sbmRHfMYpvxZoIN2bQGrYGerUiWLEkqdEUQZhH3TRSaC/oI4wO0II1RKBPlpIa1TOMxIcOOzQ==",
"path": "system.reflection.extensions/4.0.1",
"hashPath": "system.reflection.extensions.4.0.1.nupkg.sha512"
},
"System.Reflection.Primitives/4.0.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-4inTox4wTBaDhB7V3mPvp9XlCbeGYWVEM9/fXALd52vNEAVisc1BoVWQPuUuD0Ga//dNbA/WeMy9u9mzLxGTHQ==",
"path": "system.reflection.primitives/4.0.1",
"hashPath": "system.reflection.primitives.4.0.1.nupkg.sha512"
},
"System.Resources.ResourceManager/4.0.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-TxwVeUNoTgUOdQ09gfTjvW411MF+w9MBYL7AtNVc+HtBCFlutPLhUCdZjNkjbhj3bNQWMdHboF0KIWEOjJssbA==",
"path": "system.resources.resourcemanager/4.0.1",
"hashPath": "system.resources.resourcemanager.4.0.1.nupkg.sha512"
},
"System.Runtime/4.1.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-v6c/4Yaa9uWsq+JMhnOFewrYkgdNHNG2eMKuNqRn8P733rNXeRCGvV5FkkjBXn2dbVkPXOsO0xjsEeM1q2zC0g==",
"path": "system.runtime/4.1.0",
"hashPath": "system.runtime.4.1.0.nupkg.sha512"
},
"System.Runtime.Extensions/4.1.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-CUOHjTT/vgP0qGW22U4/hDlOqXmcPq5YicBaXdUR2UiUoLwBT+olO6we4DVbq57jeX5uXH2uerVZhf0qGj+sVQ==",
"path": "system.runtime.extensions/4.1.0",
"hashPath": "system.runtime.extensions.4.1.0.nupkg.sha512"
},
"System.Text.Encoding/4.0.11": {
"type": "package",
"serviceable": true,
"sha512": "sha512-U3gGeMlDZXxCEiY4DwVLSacg+DFWCvoiX+JThA/rvw37Sqrku7sEFeVBBBMBnfB6FeZHsyDx85HlKL19x0HtZA==",
"path": "system.text.encoding/4.0.11",
"hashPath": "system.text.encoding.4.0.11.nupkg.sha512"
},
"System.Text.Encoding.Extensions/4.0.11": {
"type": "package",
"serviceable": true,
"sha512": "sha512-jtbiTDtvfLYgXn8PTfWI+SiBs51rrmO4AAckx4KR6vFK9Wzf6tI8kcRdsYQNwriUeQ1+CtQbM1W4cMbLXnj/OQ==",
"path": "system.text.encoding.extensions/4.0.11",
"hashPath": "system.text.encoding.extensions.4.0.11.nupkg.sha512"
},
"System.Text.RegularExpressions/4.1.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-i88YCXpRTjCnoSQZtdlHkAOx4KNNik4hMy83n0+Ftlb7jvV6ZiZWMpnEZHhjBp6hQVh8gWd/iKNPzlPF7iyA2g==",
"path": "system.text.regularexpressions/4.1.0",
"hashPath": "system.text.regularexpressions.4.1.0.nupkg.sha512"
},
"System.Threading/4.0.11": {
"type": "package",
"serviceable": true,
"sha512": "sha512-N+3xqIcg3VDKyjwwCGaZ9HawG9aC6cSDI+s7ROma310GQo8vilFZa86hqKppwTHleR/G0sfOzhvgnUxWCR/DrQ==",
"path": "system.threading/4.0.11",
"hashPath": "system.threading.4.0.11.nupkg.sha512"
},
"System.Threading.Tasks/4.0.11": {
"type": "package",
"serviceable": true,
"sha512": "sha512-k1S4Gc6IGwtHGT8188RSeGaX86Qw/wnrgNLshJvsdNUOPP9etMmo8S07c+UlOAx4K/xLuN9ivA1bD0LVurtIxQ==",
"path": "system.threading.tasks/4.0.11",
"hashPath": "system.threading.tasks.4.0.11.nupkg.sha512"
},
"System.Xml.ReaderWriter/4.0.11": {
"type": "package",
"serviceable": true,
"sha512": "sha512-ZIiLPsf67YZ9zgr31vzrFaYQqxRPX9cVHjtPSnmx4eN6lbS/yEyYNr2vs1doGDEscF0tjCZFsk9yUg1sC9e8tg==",
"path": "system.xml.readerwriter/4.0.11",
"hashPath": "system.xml.readerwriter.4.0.11.nupkg.sha512"
},
"System.Xml.XDocument/4.0.11": {
"type": "package",
"serviceable": true,
"sha512": "sha512-Mk2mKmPi0nWaoiYeotq1dgeNK1fqWh61+EK+w4Wu8SWuTYLzpUnschb59bJtGywaPq7SmTuPf44wrXRwbIrukg==",
"path": "system.xml.xdocument/4.0.11",
"hashPath": "system.xml.xdocument.4.0.11.nupkg.sha512"
}
}
}

View File

@@ -0,0 +1,823 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>JetBrains.Annotations</name>
</assembly>
<members>
<member name="T:JetBrains.Annotations.CanBeNullAttribute">
<summary>
Indicates that the value of the marked element could be <c>null</c> sometimes,
so checking for <c>null</c> is required before its usage.
</summary>
<example><code>
[CanBeNull] object Test() => null;
void UseTest() {
var p = Test();
var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.NotNullAttribute">
<summary>
Indicates that the value of the marked element can never be <c>null</c>.
</summary>
<example><code>
[NotNull] object Foo() {
return null; // Warning: Possible 'null' assignment
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.ItemNotNullAttribute">
<summary>
Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task
and Lazy classes to indicate that the value of a collection item, of the Task.Result property
or of the Lazy.Value property can never be null.
</summary>
<example><code>
public void Foo([ItemNotNull]List&lt;string&gt; books)
{
foreach (var book in books) {
if (book != null) // Warning: Expression is always true
Console.WriteLine(book.ToUpper());
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.ItemCanBeNullAttribute">
<summary>
Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task
and Lazy classes to indicate that the value of a collection item, of the Task.Result property
or of the Lazy.Value property can be null.
</summary>
<example><code>
public void Foo([ItemCanBeNull]List&lt;string&gt; books)
{
foreach (var book in books)
{
// Warning: Possible 'System.NullReferenceException'
Console.WriteLine(book.ToUpper());
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.StringFormatMethodAttribute">
<summary>
Indicates that the marked method builds string by the format pattern and (optional) arguments.
The parameter, which contains the format string, should be given in the constructor. The format string
should be in <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/>-like form.
</summary>
<example><code>
[StringFormatMethod("message")]
void ShowError(string message, params object[] args) { /* do something */ }
void Foo() {
ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
}
</code></example>
</member>
<member name="M:JetBrains.Annotations.StringFormatMethodAttribute.#ctor(System.String)">
<param name="formatParameterName">
Specifies which parameter of an annotated method should be treated as the format string
</param>
</member>
<member name="T:JetBrains.Annotations.StructuredMessageTemplateAttribute">
<summary>
Indicates that the marked parameter is a message template where placeholders are to be replaced by the following arguments
in the order in which they appear
</summary>
<example><code>
void LogInfo([StructuredMessageTemplate]string message, params object[] args) { /* do something */ }
void Foo() {
LogInfo("User created: {username}"); // Warning: Non-existing argument in format string
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.ValueProviderAttribute">
<summary>
Use this annotation to specify a type that contains static or const fields
with values for the annotated property/field/parameter.
The specified type will be used to improve completion suggestions.
</summary>
<example><code>
namespace TestNamespace
{
public class Constants
{
public static int INT_CONST = 1;
public const string STRING_CONST = "1";
}
public class Class1
{
[ValueProvider("TestNamespace.Constants")] public int myField;
public void Foo([ValueProvider("TestNamespace.Constants")] string str) { }
public void Test()
{
Foo(/*try completion here*/);//
myField = /*try completion here*/
}
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.ValueRangeAttribute">
<summary>
Indicates that the integral value falls into the specified interval.
It's allowed to specify multiple non-intersecting intervals.
Values of interval boundaries are inclusive.
</summary>
<example><code>
void Foo([ValueRange(0, 100)] int value) {
if (value == -1) { // Warning: Expression is always 'false'
...
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.NonNegativeValueAttribute">
<summary>
Indicates that the integral value never falls below zero.
</summary>
<example><code>
void Foo([NonNegativeValue] int value) {
if (value == -1) { // Warning: Expression is always 'false'
...
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.InvokerParameterNameAttribute">
<summary>
Indicates that the function argument should be a string literal and match one
of the parameters of the caller function. For example, ReSharper annotates
the parameter of <see cref="T:System.ArgumentNullException"/>.
</summary>
<example><code>
void Foo(string param) {
if (param == null)
throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.NotifyPropertyChangedInvocatorAttribute">
<summary>
Indicates that the method is contained in a type that implements
<c>System.ComponentModel.INotifyPropertyChanged</c> interface and this method
is used to notify that some property value changed.
</summary>
<remarks>
The method should be non-static and conform to one of the supported signatures:
<list>
<item><c>NotifyChanged(string)</c></item>
<item><c>NotifyChanged(params string[])</c></item>
<item><c>NotifyChanged{T}(Expression{Func{T}})</c></item>
<item><c>NotifyChanged{T,U}(Expression{Func{T,U}})</c></item>
<item><c>SetProperty{T}(ref T, T, string)</c></item>
</list>
</remarks>
<example><code>
public class Foo : INotifyPropertyChanged {
public event PropertyChangedEventHandler PropertyChanged;
[NotifyPropertyChangedInvocator]
protected virtual void NotifyChanged(string propertyName) { ... }
string _name;
public string Name {
get { return _name; }
set { _name = value; NotifyChanged("LastName"); /* Warning */ }
}
}
</code>
Examples of generated notifications:
<list>
<item><c>NotifyChanged("Property")</c></item>
<item><c>NotifyChanged(() =&gt; Property)</c></item>
<item><c>NotifyChanged((VM x) =&gt; x.Property)</c></item>
<item><c>SetProperty(ref myField, value, "Property")</c></item>
</list>
</example>
</member>
<member name="T:JetBrains.Annotations.ContractAnnotationAttribute">
<summary>
Describes dependency between method input and output.
</summary>
<syntax>
<p>Function Definition Table syntax:</p>
<list>
<item>FDT ::= FDTRow [;FDTRow]*</item>
<item>FDTRow ::= Input =&gt; Output | Output &lt;= Input</item>
<item>Input ::= ParameterName: Value [, Input]*</item>
<item>Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value}</item>
<item>Value ::= true | false | null | notnull | canbenull</item>
</list>
If the method has a single input parameter, its name could be omitted.<br/>
Using <c>halt</c> (or <c>void</c>/<c>nothing</c>, which is the same) for the method output
means that the method doesn't return normally (throws or terminates the process).<br/>
Value <c>canbenull</c> is only applicable for output parameters.<br/>
You can use multiple <c>[ContractAnnotation]</c> for each FDT row, or use single attribute
with rows separated by the semicolon. There is no notion of order rows, all rows are checked
for applicability and applied per each program state tracked by the analysis engine.<br/>
</syntax>
<examples><list>
<item><code>
[ContractAnnotation("=&gt; halt")]
public void TerminationMethod()
</code></item>
<item><code>
[ContractAnnotation("null &lt;= param:null")] // reverse condition syntax
public string GetName(string surname)
</code></item>
<item><code>
[ContractAnnotation("s:null =&gt; true")]
public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty()
</code></item>
<item><code>
// A method that returns null if the parameter is null,
// and not null if the parameter is not null
[ContractAnnotation("null =&gt; null; notnull =&gt; notnull")]
public object Transform(object data)
</code></item>
<item><code>
[ContractAnnotation("=&gt; true, result: notnull; =&gt; false, result: null")]
public bool TryParse(string s, out Person result)
</code></item>
</list></examples>
</member>
<member name="T:JetBrains.Annotations.LocalizationRequiredAttribute">
<summary>
Indicates whether the marked element should be localized.
</summary>
<example><code>
[LocalizationRequiredAttribute(true)]
class Foo {
string str = "my string"; // Warning: Localizable string
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.CannotApplyEqualityOperatorAttribute">
<summary>
Indicates that the value of the marked type (or its derivatives)
cannot be compared using '==' or '!=' operators and <c>Equals()</c>
should be used instead. However, using '==' or '!=' for comparison
with <c>null</c> is always permitted.
</summary>
<example><code>
[CannotApplyEqualityOperator]
class NoEquality { }
class UsesNoEquality {
void Test() {
var ca1 = new NoEquality();
var ca2 = new NoEquality();
if (ca1 != null) { // OK
bool condition = ca1 == ca2; // Warning
}
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.BaseTypeRequiredAttribute">
<summary>
When applied to a target attribute, specifies a requirement for any type marked
with the target attribute to implement or inherit specific type or types.
</summary>
<example><code>
[BaseTypeRequired(typeof(IComponent)] // Specify requirement
class ComponentAttribute : Attribute { }
[Component] // ComponentAttribute requires implementing IComponent interface
class MyComponent : IComponent { }
</code></example>
</member>
<member name="T:JetBrains.Annotations.UsedImplicitlyAttribute">
<summary>
Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library),
so this symbol will be ignored by usage-checking inspections. <br/>
You can use <see cref="T:JetBrains.Annotations.ImplicitUseKindFlags"/> and <see cref="T:JetBrains.Annotations.ImplicitUseTargetFlags"/>
to configure how this attribute is applied.
</summary>
<example><code>
[UsedImplicitly]
public class TypeConverter {}
public class SummaryData
{
[UsedImplicitly(ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature)]
public SummaryData() {}
}
[UsedImplicitly(ImplicitUseTargetFlags.WithInheritors | ImplicitUseTargetFlags.Default)]
public interface IService {}
</code></example>
</member>
<member name="T:JetBrains.Annotations.MeansImplicitUseAttribute">
<summary>
Can be applied to attributes, type parameters, and parameters of a type assignable from <see cref="T:System.Type"/> .
When applied to an attribute, the decorated attribute behaves the same as <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
When applied to a type parameter or to a parameter of type <see cref="T:System.Type"/>,
indicates that the corresponding type is used implicitly.
</summary>
</member>
<member name="T:JetBrains.Annotations.ImplicitUseKindFlags">
<summary>
Specifies the details of implicitly used symbol when it is marked
with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Access">
<summary>Only entity marked with attribute considered used.</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Assign">
<summary>Indicates implicit assignment to a member.</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature">
<summary>
Indicates implicit instantiation of a type with fixed constructor signature.
That means any unused constructor parameters won't be reported as such.
</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature">
<summary>Indicates implicit instantiation of a type.</summary>
</member>
<member name="T:JetBrains.Annotations.ImplicitUseTargetFlags">
<summary>
Specifies what is considered to be used implicitly when marked
with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.Members">
<summary>Members of the type marked with the attribute are considered used.</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.WithInheritors">
<summary> Inherited entities are considered used. </summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.WithMembers">
<summary>Entity marked with the attribute and all its members considered used.</summary>
</member>
<member name="T:JetBrains.Annotations.PublicAPIAttribute">
<summary>
This attribute is intended to mark publicly available API,
which should not be removed and so is treated as used.
</summary>
</member>
<member name="T:JetBrains.Annotations.InstantHandleAttribute">
<summary>
Tells the code analysis engine if the parameter is completely handled when the invoked method is on stack.
If the parameter is a delegate, indicates that delegate is executed while the method is executed.
If the parameter is an enumerable, indicates that it is enumerated while the method is executed.
</summary>
</member>
<member name="T:JetBrains.Annotations.PureAttribute">
<summary>
Indicates that a method does not make any observable state changes.
The same as <c>System.Diagnostics.Contracts.PureAttribute</c>.
</summary>
<example><code>
[Pure] int Multiply(int x, int y) => x * y;
void M() {
Multiply(123, 42); // Warning: Return value of pure method is not used
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.MustUseReturnValueAttribute">
<summary>
Indicates that the return value of the method invocation must be used.
</summary>
<remarks>
Methods decorated with this attribute (in contrast to pure methods) might change state,
but make no sense without using their return value. <br/>
Similarly to <see cref="T:JetBrains.Annotations.PureAttribute"/>, this attribute
will help to detect usages of the method when the return value is not used.
Optionally, you can specify a message to use when showing warnings, e.g.
<code>[MustUseReturnValue("Use the return value to...")]</code>.
</remarks>
</member>
<member name="T:JetBrains.Annotations.RequireStaticDelegateAttribute">
<summary>
This annotation allows to enforce allocation-less usage patterns of delegates for performance-critical APIs.
When this annotation is applied to the parameter of delegate type, IDE checks the input argument of this parameter:
* When lambda expression or anonymous method is passed as an argument, IDE verifies that the passed closure
has no captures of the containing local variables and the compiler is able to cache the delegate instance
to avoid heap allocations. Otherwise the warning is produced.
* IDE warns when method name or local function name is passed as an argument as this always results
in heap allocation of the delegate instance.
</summary>
<remarks>
In C# 9.0 code IDE would also suggest to annotate the anonymous function with 'static' modifier
to make use of the similar analysis provided by the language/compiler.
</remarks>
</member>
<member name="T:JetBrains.Annotations.ProvidesContextAttribute">
<summary>
Indicates the type member or parameter of some type, that should be used instead of all other ways
to get the value of that type. This annotation is useful when you have some "context" value evaluated
and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one.
</summary>
<example><code>
class Foo {
[ProvidesContext] IBarService _barService = ...;
void ProcessNode(INode node) {
DoSomething(node, node.GetGlobalServices().Bar);
// ^ Warning: use value of '_barService' field
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.PathReferenceAttribute">
<summary>
Indicates that a parameter is a path to a file or a folder within a web project.
Path can be relative or absolute, starting from web root (~).
</summary>
</member>
<member name="T:JetBrains.Annotations.SourceTemplateAttribute">
<summary>
An extension method marked with this attribute is processed by code completion
as a 'Source Template'. When the extension method is completed over some expression, its source code
is automatically expanded like a template at call site.
</summary>
<remarks>
Template method body can contain valid source code and/or special comments starting with '$'.
Text inside these comments is added as source code when the template is applied. Template parameters
can be used either as additional method parameters or as identifiers wrapped in two '$' signs.
Use the <see cref="T:JetBrains.Annotations.MacroAttribute"/> attribute to specify macros for parameters.
</remarks>
<example>
In this example, the 'forEach' method is a source template available over all values
of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block:
<code>
[SourceTemplate]
public static void forEach&lt;T&gt;(this IEnumerable&lt;T&gt; xs) {
foreach (var x in xs) {
//$ $END$
}
}
</code>
</example>
</member>
<member name="T:JetBrains.Annotations.MacroAttribute">
<summary>
Allows specifying a macro for a parameter of a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see>.
</summary>
<remarks>
You can apply the attribute on the whole method or on any of its additional parameters. The macro expression
is defined in the <see cref="P:JetBrains.Annotations.MacroAttribute.Expression"/> property. When applied on a method, the target
template parameter is defined in the <see cref="P:JetBrains.Annotations.MacroAttribute.Target"/> property. To apply the macro silently
for the parameter, set the <see cref="P:JetBrains.Annotations.MacroAttribute.Editable"/> property value = -1.
</remarks>
<example>
Applying the attribute on a source template method:
<code>
[SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")]
public static void forEach&lt;T&gt;(this IEnumerable&lt;T&gt; collection) {
foreach (var item in collection) {
//$ $END$
}
}
</code>
Applying the attribute on a template method parameter:
<code>
[SourceTemplate]
public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) {
/*$ var $x$Id = "$newguid$" + x.ToString();
x.DoSomething($x$Id); */
}
</code>
</example>
</member>
<member name="P:JetBrains.Annotations.MacroAttribute.Expression">
<summary>
Allows specifying a macro that will be executed for a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see>
parameter when the template is expanded.
</summary>
</member>
<member name="P:JetBrains.Annotations.MacroAttribute.Editable">
<summary>
Allows specifying which occurrence of the target parameter becomes editable when the template is deployed.
</summary>
<remarks>
If the target parameter is used several times in the template, only one occurrence becomes editable;
other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence,
use values >= 0. To make the parameter non-editable when the template is expanded, use -1.
</remarks>
</member>
<member name="P:JetBrains.Annotations.MacroAttribute.Target">
<summary>
Identifies the target parameter of a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see> if the
<see cref="T:JetBrains.Annotations.MacroAttribute"/> is applied on a template method.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcActionAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
is an MVC action. If applied to a method, the MVC action name is calculated
implicitly from the context. Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcAreaAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC area.
Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcControllerAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is
an MVC controller. If applied to a method, the MVC controller name is calculated
implicitly from the context. Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcMasterAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC Master. Use this attribute
for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcModelTypeAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC model type. Use this attribute
for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, Object)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcPartialViewAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC
partial view. If applied to a method, the MVC partial view name is calculated implicitly
from the context. Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcSuppressViewErrorAttribute">
<summary>
ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcDisplayTemplateAttribute">
<summary>
ASP.NET MVC attribute. Indicates that a parameter is an MVC display template.
Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcEditorTemplateAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC editor template.
Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcTemplateAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC template.
Use this attribute for custom wrappers similar to
<c>System.ComponentModel.DataAnnotations.UIHintAttribute(System.String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcViewAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
is an MVC view component. If applied to a method, the MVC view name is calculated implicitly
from the context. Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Controller.View(Object)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcViewComponentAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
is an MVC view component name.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcViewComponentViewAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
is an MVC view component view. If applied to a method, the MVC view component view name is default.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcActionSelectorAttribute">
<summary>
ASP.NET MVC attribute. When applied to a parameter of an attribute,
indicates that this parameter is an MVC action name.
</summary>
<example><code>
[ActionName("Foo")]
public ActionResult Login(string returnUrl) {
ViewBag.ReturnUrl = Url.Action("Foo"); // OK
return RedirectToAction("Bar"); // Error: Cannot resolve action
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.RazorSectionAttribute">
<summary>
Razor attribute. Indicates that the marked parameter or method is a Razor section.
Use this attribute for custom wrappers similar to
<c>System.Web.WebPages.WebPageBase.RenderSection(String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.CollectionAccessAttribute">
<summary>
Indicates how method, constructor invocation, or property access
over collection type affects the contents of the collection.
Use <see cref="P:JetBrains.Annotations.CollectionAccessAttribute.CollectionAccessType"/> to specify the access type.
</summary>
<remarks>
Using this attribute only makes sense if all collection methods are marked with this attribute.
</remarks>
<example><code>
public class MyStringCollection : List&lt;string&gt;
{
[CollectionAccess(CollectionAccessType.Read)]
public string GetFirstString()
{
return this.ElementAt(0);
}
}
class Test
{
public void Foo()
{
// Warning: Contents of the collection is never updated
var col = new MyStringCollection();
string x = col.GetFirstString();
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.CollectionAccessType">
<summary>
Provides a value for the <see cref="T:JetBrains.Annotations.CollectionAccessAttribute"/> to define
how the collection method invocation affects the contents of the collection.
</summary>
</member>
<member name="F:JetBrains.Annotations.CollectionAccessType.None">
<summary>Method does not use or modify content of the collection.</summary>
</member>
<member name="F:JetBrains.Annotations.CollectionAccessType.Read">
<summary>Method only reads content of the collection but does not modify it.</summary>
</member>
<member name="F:JetBrains.Annotations.CollectionAccessType.ModifyExistingContent">
<summary>Method can change content of the collection but does not add new elements.</summary>
</member>
<member name="F:JetBrains.Annotations.CollectionAccessType.UpdatedContent">
<summary>Method can add new elements to the collection.</summary>
</member>
<member name="T:JetBrains.Annotations.AssertionMethodAttribute">
<summary>
Indicates that the marked method is assertion method, i.e. it halts the control flow if
one of the conditions is satisfied. To set the condition, mark one of the parameters with
<see cref="T:JetBrains.Annotations.AssertionConditionAttribute"/> attribute.
</summary>
</member>
<member name="T:JetBrains.Annotations.AssertionConditionAttribute">
<summary>
Indicates the condition parameter of the assertion method. The method itself should be
marked by <see cref="T:JetBrains.Annotations.AssertionMethodAttribute"/> attribute. The mandatory argument of
the attribute is the assertion type.
</summary>
</member>
<member name="T:JetBrains.Annotations.AssertionConditionType">
<summary>
Specifies assertion type. If the assertion method argument satisfies the condition,
then the execution continues. Otherwise, execution is assumed to be halted.
</summary>
</member>
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_TRUE">
<summary>Marked parameter should be evaluated to true.</summary>
</member>
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_FALSE">
<summary>Marked parameter should be evaluated to false.</summary>
</member>
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_NULL">
<summary>Marked parameter should be evaluated to null value.</summary>
</member>
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_NOT_NULL">
<summary>Marked parameter should be evaluated to not null value.</summary>
</member>
<member name="T:JetBrains.Annotations.TerminatesProgramAttribute">
<summary>
Indicates that the marked method unconditionally terminates control flow execution.
For example, it could unconditionally throw exception.
</summary>
</member>
<member name="T:JetBrains.Annotations.LinqTunnelAttribute">
<summary>
Indicates that the method is a pure LINQ method, with postponed enumeration (like Enumerable.Select,
.Where). This annotation allows inference of [InstantHandle] annotation for parameters
of delegate type by analyzing LINQ method chains.
</summary>
</member>
<member name="T:JetBrains.Annotations.NoEnumerationAttribute">
<summary>
Indicates that IEnumerable passed as a parameter is not enumerated.
Use this annotation to suppress the 'Possible multiple enumeration of IEnumerable' inspection.
</summary>
<example><code>
static void ThrowIfNull&lt;T&gt;([NoEnumeration] T v, string n) where T : class
{
// custom check for null but no enumeration
}
void Foo(IEnumerable&lt;string&gt; values)
{
ThrowIfNull(values, nameof(values));
var x = values.ToList(); // No warnings about multiple enumeration
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.RegexPatternAttribute">
<summary>
Indicates that the marked parameter, field, or property is a regular expression pattern.
</summary>
</member>
<member name="T:JetBrains.Annotations.NoReorderAttribute">
<summary>
Prevents the Member Reordering feature from tossing members of the marked class.
</summary>
<remarks>
The attribute must be mentioned in your member reordering patterns.
</remarks>
</member>
<member name="T:JetBrains.Annotations.XamlItemsControlAttribute">
<summary>
XAML attribute. Indicates the type that has <c>ItemsSource</c> property and should be treated
as <c>ItemsControl</c>-derived type, to enable inner items <c>DataContext</c> type resolve.
</summary>
</member>
<member name="T:JetBrains.Annotations.XamlItemBindingOfItemsControlAttribute">
<summary>
XAML attribute. Indicates the property of some <c>BindingBase</c>-derived type, that
is used to bind some item of <c>ItemsControl</c>-derived type. This annotation will
enable the <c>DataContext</c> type resolve for XAML bindings for such properties.
</summary>
<remarks>
Property should have the tree ancestor of the <c>ItemsControl</c> type or
marked with the <see cref="T:JetBrains.Annotations.XamlItemsControlAttribute"/> attribute.
</remarks>
</member>
<member name="T:JetBrains.Annotations.XamlItemStyleOfItemsControlAttribute">
<summary>
XAML attribute. Indicates the property of some <c>Style</c>-derived type, that
is used to style items of <c>ItemsControl</c>-derived type. This annotation will
enable the <c>DataContext</c> type resolve for XAML bindings for such properties.
</summary>
<remarks>
Property should have the tree ancestor of the <c>ItemsControl</c> type or
marked with the <see cref="T:JetBrains.Annotations.XamlItemsControlAttribute"/> attribute.
</remarks>
</member>
<member name="T:JetBrains.Annotations.XamlOneWayBindingModeByDefaultAttribute">
<summary>
XAML attribute. Indicates that DependencyProperty has <c>OneWay</c> binding mode by default.
</summary>
<remarks>
This attribute must be applied to DependencyProperty's CLR accessor property if it is present, to DependencyProperty descriptor field otherwise.
</remarks>
</member>
<member name="T:JetBrains.Annotations.XamlTwoWayBindingModeByDefaultAttribute">
<summary>
XAML attribute. Indicates that DependencyProperty has <c>TwoWay</c> binding mode by default.
</summary>
<remarks>
This attribute must be applied to DependencyProperty's CLR accessor property if it is present, to DependencyProperty descriptor field otherwise.
</remarks>
</member>
<member name="T:JetBrains.Annotations.RouteTemplateAttribute">
<summary>
Indicates that the marked parameter, field, or property is a route template.
</summary>
<remarks>
This attribute allows IDE to recognize the use of web frameworks' route templates
to enable syntax highlighting, code completion, navigation, rename and other features in string literals.
</remarks>
</member>
<member name="T:JetBrains.Annotations.RouteParameterConstraintAttribute">
<summary>
Indicates that the marked type is custom route parameter constraint,
which is registered in application's Startup with name <c>ConstraintName</c>
</summary>
<remarks>
You can specify <c>ProposedType</c> if target constraint matches only route parameters of specific type,
it will allow IDE to create method's parameter from usage in route template
with specified type instead of default <c>System.String</c>
and check if constraint's proposed type conflicts with matched parameter's type
</remarks>
</member>
<member name="T:JetBrains.Annotations.UriStringAttribute">
<summary>
Indicates that the marked parameter, field, or property is an URI string.
</summary>
<remarks>
This attribute enables code completion, navigation, rename and other features
in URI string literals assigned to annotated parameter, field or property.
</remarks>
</member>
</members>
</doc>

View File

@@ -0,0 +1,47 @@
{
"runtimeTarget": {
"name": ".NETStandard,Version=v2.0/",
"signature": ""
},
"compilationOptions": {},
"targets": {
".NETStandard,Version=v2.0": {},
".NETStandard,Version=v2.0/": {
"JetBrains.Annotations/2021.2": {
"dependencies": {
"NETStandard.Library": "2.0.3"
},
"runtime": {
"JetBrains.Annotations.dll": {}
}
},
"Microsoft.NETCore.Platforms/1.1.0": {},
"NETStandard.Library/2.0.3": {
"dependencies": {
"Microsoft.NETCore.Platforms": "1.1.0"
}
}
}
},
"libraries": {
"JetBrains.Annotations/2021.2": {
"type": "project",
"serviceable": false,
"sha512": ""
},
"Microsoft.NETCore.Platforms/1.1.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-kz0PEW2lhqygehI/d6XsPCQzD7ff7gUJaVGPVETX611eadGsA3A877GdSlU0LRVMCTH/+P3o2iDTak+S08V2+A==",
"path": "microsoft.netcore.platforms/1.1.0",
"hashPath": "microsoft.netcore.platforms.1.1.0.nupkg.sha512"
},
"NETStandard.Library/2.0.3": {
"type": "package",
"serviceable": true,
"sha512": "sha512-st47PosZSHrjECdjeIzZQbzivYBJFv6P2nv4cj2ypdI204DO+vZ7l5raGMiX4eXMJ53RfOIg+/s4DHVZ54Nu2A==",
"path": "netstandard.library/2.0.3",
"hashPath": "netstandard.library.2.0.3.nupkg.sha512"
}
}
}

View File

@@ -0,0 +1,823 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>JetBrains.Annotations</name>
</assembly>
<members>
<member name="T:JetBrains.Annotations.CanBeNullAttribute">
<summary>
Indicates that the value of the marked element could be <c>null</c> sometimes,
so checking for <c>null</c> is required before its usage.
</summary>
<example><code>
[CanBeNull] object Test() => null;
void UseTest() {
var p = Test();
var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.NotNullAttribute">
<summary>
Indicates that the value of the marked element can never be <c>null</c>.
</summary>
<example><code>
[NotNull] object Foo() {
return null; // Warning: Possible 'null' assignment
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.ItemNotNullAttribute">
<summary>
Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task
and Lazy classes to indicate that the value of a collection item, of the Task.Result property
or of the Lazy.Value property can never be null.
</summary>
<example><code>
public void Foo([ItemNotNull]List&lt;string&gt; books)
{
foreach (var book in books) {
if (book != null) // Warning: Expression is always true
Console.WriteLine(book.ToUpper());
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.ItemCanBeNullAttribute">
<summary>
Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task
and Lazy classes to indicate that the value of a collection item, of the Task.Result property
or of the Lazy.Value property can be null.
</summary>
<example><code>
public void Foo([ItemCanBeNull]List&lt;string&gt; books)
{
foreach (var book in books)
{
// Warning: Possible 'System.NullReferenceException'
Console.WriteLine(book.ToUpper());
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.StringFormatMethodAttribute">
<summary>
Indicates that the marked method builds string by the format pattern and (optional) arguments.
The parameter, which contains the format string, should be given in the constructor. The format string
should be in <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/>-like form.
</summary>
<example><code>
[StringFormatMethod("message")]
void ShowError(string message, params object[] args) { /* do something */ }
void Foo() {
ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
}
</code></example>
</member>
<member name="M:JetBrains.Annotations.StringFormatMethodAttribute.#ctor(System.String)">
<param name="formatParameterName">
Specifies which parameter of an annotated method should be treated as the format string
</param>
</member>
<member name="T:JetBrains.Annotations.StructuredMessageTemplateAttribute">
<summary>
Indicates that the marked parameter is a message template where placeholders are to be replaced by the following arguments
in the order in which they appear
</summary>
<example><code>
void LogInfo([StructuredMessageTemplate]string message, params object[] args) { /* do something */ }
void Foo() {
LogInfo("User created: {username}"); // Warning: Non-existing argument in format string
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.ValueProviderAttribute">
<summary>
Use this annotation to specify a type that contains static or const fields
with values for the annotated property/field/parameter.
The specified type will be used to improve completion suggestions.
</summary>
<example><code>
namespace TestNamespace
{
public class Constants
{
public static int INT_CONST = 1;
public const string STRING_CONST = "1";
}
public class Class1
{
[ValueProvider("TestNamespace.Constants")] public int myField;
public void Foo([ValueProvider("TestNamespace.Constants")] string str) { }
public void Test()
{
Foo(/*try completion here*/);//
myField = /*try completion here*/
}
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.ValueRangeAttribute">
<summary>
Indicates that the integral value falls into the specified interval.
It's allowed to specify multiple non-intersecting intervals.
Values of interval boundaries are inclusive.
</summary>
<example><code>
void Foo([ValueRange(0, 100)] int value) {
if (value == -1) { // Warning: Expression is always 'false'
...
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.NonNegativeValueAttribute">
<summary>
Indicates that the integral value never falls below zero.
</summary>
<example><code>
void Foo([NonNegativeValue] int value) {
if (value == -1) { // Warning: Expression is always 'false'
...
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.InvokerParameterNameAttribute">
<summary>
Indicates that the function argument should be a string literal and match one
of the parameters of the caller function. For example, ReSharper annotates
the parameter of <see cref="T:System.ArgumentNullException"/>.
</summary>
<example><code>
void Foo(string param) {
if (param == null)
throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.NotifyPropertyChangedInvocatorAttribute">
<summary>
Indicates that the method is contained in a type that implements
<c>System.ComponentModel.INotifyPropertyChanged</c> interface and this method
is used to notify that some property value changed.
</summary>
<remarks>
The method should be non-static and conform to one of the supported signatures:
<list>
<item><c>NotifyChanged(string)</c></item>
<item><c>NotifyChanged(params string[])</c></item>
<item><c>NotifyChanged{T}(Expression{Func{T}})</c></item>
<item><c>NotifyChanged{T,U}(Expression{Func{T,U}})</c></item>
<item><c>SetProperty{T}(ref T, T, string)</c></item>
</list>
</remarks>
<example><code>
public class Foo : INotifyPropertyChanged {
public event PropertyChangedEventHandler PropertyChanged;
[NotifyPropertyChangedInvocator]
protected virtual void NotifyChanged(string propertyName) { ... }
string _name;
public string Name {
get { return _name; }
set { _name = value; NotifyChanged("LastName"); /* Warning */ }
}
}
</code>
Examples of generated notifications:
<list>
<item><c>NotifyChanged("Property")</c></item>
<item><c>NotifyChanged(() =&gt; Property)</c></item>
<item><c>NotifyChanged((VM x) =&gt; x.Property)</c></item>
<item><c>SetProperty(ref myField, value, "Property")</c></item>
</list>
</example>
</member>
<member name="T:JetBrains.Annotations.ContractAnnotationAttribute">
<summary>
Describes dependency between method input and output.
</summary>
<syntax>
<p>Function Definition Table syntax:</p>
<list>
<item>FDT ::= FDTRow [;FDTRow]*</item>
<item>FDTRow ::= Input =&gt; Output | Output &lt;= Input</item>
<item>Input ::= ParameterName: Value [, Input]*</item>
<item>Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value}</item>
<item>Value ::= true | false | null | notnull | canbenull</item>
</list>
If the method has a single input parameter, its name could be omitted.<br/>
Using <c>halt</c> (or <c>void</c>/<c>nothing</c>, which is the same) for the method output
means that the method doesn't return normally (throws or terminates the process).<br/>
Value <c>canbenull</c> is only applicable for output parameters.<br/>
You can use multiple <c>[ContractAnnotation]</c> for each FDT row, or use single attribute
with rows separated by the semicolon. There is no notion of order rows, all rows are checked
for applicability and applied per each program state tracked by the analysis engine.<br/>
</syntax>
<examples><list>
<item><code>
[ContractAnnotation("=&gt; halt")]
public void TerminationMethod()
</code></item>
<item><code>
[ContractAnnotation("null &lt;= param:null")] // reverse condition syntax
public string GetName(string surname)
</code></item>
<item><code>
[ContractAnnotation("s:null =&gt; true")]
public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty()
</code></item>
<item><code>
// A method that returns null if the parameter is null,
// and not null if the parameter is not null
[ContractAnnotation("null =&gt; null; notnull =&gt; notnull")]
public object Transform(object data)
</code></item>
<item><code>
[ContractAnnotation("=&gt; true, result: notnull; =&gt; false, result: null")]
public bool TryParse(string s, out Person result)
</code></item>
</list></examples>
</member>
<member name="T:JetBrains.Annotations.LocalizationRequiredAttribute">
<summary>
Indicates whether the marked element should be localized.
</summary>
<example><code>
[LocalizationRequiredAttribute(true)]
class Foo {
string str = "my string"; // Warning: Localizable string
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.CannotApplyEqualityOperatorAttribute">
<summary>
Indicates that the value of the marked type (or its derivatives)
cannot be compared using '==' or '!=' operators and <c>Equals()</c>
should be used instead. However, using '==' or '!=' for comparison
with <c>null</c> is always permitted.
</summary>
<example><code>
[CannotApplyEqualityOperator]
class NoEquality { }
class UsesNoEquality {
void Test() {
var ca1 = new NoEquality();
var ca2 = new NoEquality();
if (ca1 != null) { // OK
bool condition = ca1 == ca2; // Warning
}
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.BaseTypeRequiredAttribute">
<summary>
When applied to a target attribute, specifies a requirement for any type marked
with the target attribute to implement or inherit specific type or types.
</summary>
<example><code>
[BaseTypeRequired(typeof(IComponent)] // Specify requirement
class ComponentAttribute : Attribute { }
[Component] // ComponentAttribute requires implementing IComponent interface
class MyComponent : IComponent { }
</code></example>
</member>
<member name="T:JetBrains.Annotations.UsedImplicitlyAttribute">
<summary>
Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library),
so this symbol will be ignored by usage-checking inspections. <br/>
You can use <see cref="T:JetBrains.Annotations.ImplicitUseKindFlags"/> and <see cref="T:JetBrains.Annotations.ImplicitUseTargetFlags"/>
to configure how this attribute is applied.
</summary>
<example><code>
[UsedImplicitly]
public class TypeConverter {}
public class SummaryData
{
[UsedImplicitly(ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature)]
public SummaryData() {}
}
[UsedImplicitly(ImplicitUseTargetFlags.WithInheritors | ImplicitUseTargetFlags.Default)]
public interface IService {}
</code></example>
</member>
<member name="T:JetBrains.Annotations.MeansImplicitUseAttribute">
<summary>
Can be applied to attributes, type parameters, and parameters of a type assignable from <see cref="T:System.Type"/> .
When applied to an attribute, the decorated attribute behaves the same as <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
When applied to a type parameter or to a parameter of type <see cref="T:System.Type"/>,
indicates that the corresponding type is used implicitly.
</summary>
</member>
<member name="T:JetBrains.Annotations.ImplicitUseKindFlags">
<summary>
Specifies the details of implicitly used symbol when it is marked
with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Access">
<summary>Only entity marked with attribute considered used.</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Assign">
<summary>Indicates implicit assignment to a member.</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature">
<summary>
Indicates implicit instantiation of a type with fixed constructor signature.
That means any unused constructor parameters won't be reported as such.
</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature">
<summary>Indicates implicit instantiation of a type.</summary>
</member>
<member name="T:JetBrains.Annotations.ImplicitUseTargetFlags">
<summary>
Specifies what is considered to be used implicitly when marked
with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.Members">
<summary>Members of the type marked with the attribute are considered used.</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.WithInheritors">
<summary> Inherited entities are considered used. </summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.WithMembers">
<summary>Entity marked with the attribute and all its members considered used.</summary>
</member>
<member name="T:JetBrains.Annotations.PublicAPIAttribute">
<summary>
This attribute is intended to mark publicly available API,
which should not be removed and so is treated as used.
</summary>
</member>
<member name="T:JetBrains.Annotations.InstantHandleAttribute">
<summary>
Tells the code analysis engine if the parameter is completely handled when the invoked method is on stack.
If the parameter is a delegate, indicates that delegate is executed while the method is executed.
If the parameter is an enumerable, indicates that it is enumerated while the method is executed.
</summary>
</member>
<member name="T:JetBrains.Annotations.PureAttribute">
<summary>
Indicates that a method does not make any observable state changes.
The same as <c>System.Diagnostics.Contracts.PureAttribute</c>.
</summary>
<example><code>
[Pure] int Multiply(int x, int y) => x * y;
void M() {
Multiply(123, 42); // Warning: Return value of pure method is not used
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.MustUseReturnValueAttribute">
<summary>
Indicates that the return value of the method invocation must be used.
</summary>
<remarks>
Methods decorated with this attribute (in contrast to pure methods) might change state,
but make no sense without using their return value. <br/>
Similarly to <see cref="T:JetBrains.Annotations.PureAttribute"/>, this attribute
will help to detect usages of the method when the return value is not used.
Optionally, you can specify a message to use when showing warnings, e.g.
<code>[MustUseReturnValue("Use the return value to...")]</code>.
</remarks>
</member>
<member name="T:JetBrains.Annotations.RequireStaticDelegateAttribute">
<summary>
This annotation allows to enforce allocation-less usage patterns of delegates for performance-critical APIs.
When this annotation is applied to the parameter of delegate type, IDE checks the input argument of this parameter:
* When lambda expression or anonymous method is passed as an argument, IDE verifies that the passed closure
has no captures of the containing local variables and the compiler is able to cache the delegate instance
to avoid heap allocations. Otherwise the warning is produced.
* IDE warns when method name or local function name is passed as an argument as this always results
in heap allocation of the delegate instance.
</summary>
<remarks>
In C# 9.0 code IDE would also suggest to annotate the anonymous function with 'static' modifier
to make use of the similar analysis provided by the language/compiler.
</remarks>
</member>
<member name="T:JetBrains.Annotations.ProvidesContextAttribute">
<summary>
Indicates the type member or parameter of some type, that should be used instead of all other ways
to get the value of that type. This annotation is useful when you have some "context" value evaluated
and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one.
</summary>
<example><code>
class Foo {
[ProvidesContext] IBarService _barService = ...;
void ProcessNode(INode node) {
DoSomething(node, node.GetGlobalServices().Bar);
// ^ Warning: use value of '_barService' field
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.PathReferenceAttribute">
<summary>
Indicates that a parameter is a path to a file or a folder within a web project.
Path can be relative or absolute, starting from web root (~).
</summary>
</member>
<member name="T:JetBrains.Annotations.SourceTemplateAttribute">
<summary>
An extension method marked with this attribute is processed by code completion
as a 'Source Template'. When the extension method is completed over some expression, its source code
is automatically expanded like a template at call site.
</summary>
<remarks>
Template method body can contain valid source code and/or special comments starting with '$'.
Text inside these comments is added as source code when the template is applied. Template parameters
can be used either as additional method parameters or as identifiers wrapped in two '$' signs.
Use the <see cref="T:JetBrains.Annotations.MacroAttribute"/> attribute to specify macros for parameters.
</remarks>
<example>
In this example, the 'forEach' method is a source template available over all values
of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block:
<code>
[SourceTemplate]
public static void forEach&lt;T&gt;(this IEnumerable&lt;T&gt; xs) {
foreach (var x in xs) {
//$ $END$
}
}
</code>
</example>
</member>
<member name="T:JetBrains.Annotations.MacroAttribute">
<summary>
Allows specifying a macro for a parameter of a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see>.
</summary>
<remarks>
You can apply the attribute on the whole method or on any of its additional parameters. The macro expression
is defined in the <see cref="P:JetBrains.Annotations.MacroAttribute.Expression"/> property. When applied on a method, the target
template parameter is defined in the <see cref="P:JetBrains.Annotations.MacroAttribute.Target"/> property. To apply the macro silently
for the parameter, set the <see cref="P:JetBrains.Annotations.MacroAttribute.Editable"/> property value = -1.
</remarks>
<example>
Applying the attribute on a source template method:
<code>
[SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")]
public static void forEach&lt;T&gt;(this IEnumerable&lt;T&gt; collection) {
foreach (var item in collection) {
//$ $END$
}
}
</code>
Applying the attribute on a template method parameter:
<code>
[SourceTemplate]
public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) {
/*$ var $x$Id = "$newguid$" + x.ToString();
x.DoSomething($x$Id); */
}
</code>
</example>
</member>
<member name="P:JetBrains.Annotations.MacroAttribute.Expression">
<summary>
Allows specifying a macro that will be executed for a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see>
parameter when the template is expanded.
</summary>
</member>
<member name="P:JetBrains.Annotations.MacroAttribute.Editable">
<summary>
Allows specifying which occurrence of the target parameter becomes editable when the template is deployed.
</summary>
<remarks>
If the target parameter is used several times in the template, only one occurrence becomes editable;
other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence,
use values >= 0. To make the parameter non-editable when the template is expanded, use -1.
</remarks>
</member>
<member name="P:JetBrains.Annotations.MacroAttribute.Target">
<summary>
Identifies the target parameter of a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see> if the
<see cref="T:JetBrains.Annotations.MacroAttribute"/> is applied on a template method.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcActionAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
is an MVC action. If applied to a method, the MVC action name is calculated
implicitly from the context. Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcAreaAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC area.
Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcControllerAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is
an MVC controller. If applied to a method, the MVC controller name is calculated
implicitly from the context. Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcMasterAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC Master. Use this attribute
for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcModelTypeAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC model type. Use this attribute
for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, Object)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcPartialViewAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC
partial view. If applied to a method, the MVC partial view name is calculated implicitly
from the context. Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcSuppressViewErrorAttribute">
<summary>
ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcDisplayTemplateAttribute">
<summary>
ASP.NET MVC attribute. Indicates that a parameter is an MVC display template.
Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcEditorTemplateAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC editor template.
Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcTemplateAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC template.
Use this attribute for custom wrappers similar to
<c>System.ComponentModel.DataAnnotations.UIHintAttribute(System.String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcViewAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
is an MVC view component. If applied to a method, the MVC view name is calculated implicitly
from the context. Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Controller.View(Object)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcViewComponentAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
is an MVC view component name.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcViewComponentViewAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
is an MVC view component view. If applied to a method, the MVC view component view name is default.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcActionSelectorAttribute">
<summary>
ASP.NET MVC attribute. When applied to a parameter of an attribute,
indicates that this parameter is an MVC action name.
</summary>
<example><code>
[ActionName("Foo")]
public ActionResult Login(string returnUrl) {
ViewBag.ReturnUrl = Url.Action("Foo"); // OK
return RedirectToAction("Bar"); // Error: Cannot resolve action
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.RazorSectionAttribute">
<summary>
Razor attribute. Indicates that the marked parameter or method is a Razor section.
Use this attribute for custom wrappers similar to
<c>System.Web.WebPages.WebPageBase.RenderSection(String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.CollectionAccessAttribute">
<summary>
Indicates how method, constructor invocation, or property access
over collection type affects the contents of the collection.
Use <see cref="P:JetBrains.Annotations.CollectionAccessAttribute.CollectionAccessType"/> to specify the access type.
</summary>
<remarks>
Using this attribute only makes sense if all collection methods are marked with this attribute.
</remarks>
<example><code>
public class MyStringCollection : List&lt;string&gt;
{
[CollectionAccess(CollectionAccessType.Read)]
public string GetFirstString()
{
return this.ElementAt(0);
}
}
class Test
{
public void Foo()
{
// Warning: Contents of the collection is never updated
var col = new MyStringCollection();
string x = col.GetFirstString();
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.CollectionAccessType">
<summary>
Provides a value for the <see cref="T:JetBrains.Annotations.CollectionAccessAttribute"/> to define
how the collection method invocation affects the contents of the collection.
</summary>
</member>
<member name="F:JetBrains.Annotations.CollectionAccessType.None">
<summary>Method does not use or modify content of the collection.</summary>
</member>
<member name="F:JetBrains.Annotations.CollectionAccessType.Read">
<summary>Method only reads content of the collection but does not modify it.</summary>
</member>
<member name="F:JetBrains.Annotations.CollectionAccessType.ModifyExistingContent">
<summary>Method can change content of the collection but does not add new elements.</summary>
</member>
<member name="F:JetBrains.Annotations.CollectionAccessType.UpdatedContent">
<summary>Method can add new elements to the collection.</summary>
</member>
<member name="T:JetBrains.Annotations.AssertionMethodAttribute">
<summary>
Indicates that the marked method is assertion method, i.e. it halts the control flow if
one of the conditions is satisfied. To set the condition, mark one of the parameters with
<see cref="T:JetBrains.Annotations.AssertionConditionAttribute"/> attribute.
</summary>
</member>
<member name="T:JetBrains.Annotations.AssertionConditionAttribute">
<summary>
Indicates the condition parameter of the assertion method. The method itself should be
marked by <see cref="T:JetBrains.Annotations.AssertionMethodAttribute"/> attribute. The mandatory argument of
the attribute is the assertion type.
</summary>
</member>
<member name="T:JetBrains.Annotations.AssertionConditionType">
<summary>
Specifies assertion type. If the assertion method argument satisfies the condition,
then the execution continues. Otherwise, execution is assumed to be halted.
</summary>
</member>
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_TRUE">
<summary>Marked parameter should be evaluated to true.</summary>
</member>
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_FALSE">
<summary>Marked parameter should be evaluated to false.</summary>
</member>
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_NULL">
<summary>Marked parameter should be evaluated to null value.</summary>
</member>
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_NOT_NULL">
<summary>Marked parameter should be evaluated to not null value.</summary>
</member>
<member name="T:JetBrains.Annotations.TerminatesProgramAttribute">
<summary>
Indicates that the marked method unconditionally terminates control flow execution.
For example, it could unconditionally throw exception.
</summary>
</member>
<member name="T:JetBrains.Annotations.LinqTunnelAttribute">
<summary>
Indicates that the method is a pure LINQ method, with postponed enumeration (like Enumerable.Select,
.Where). This annotation allows inference of [InstantHandle] annotation for parameters
of delegate type by analyzing LINQ method chains.
</summary>
</member>
<member name="T:JetBrains.Annotations.NoEnumerationAttribute">
<summary>
Indicates that IEnumerable passed as a parameter is not enumerated.
Use this annotation to suppress the 'Possible multiple enumeration of IEnumerable' inspection.
</summary>
<example><code>
static void ThrowIfNull&lt;T&gt;([NoEnumeration] T v, string n) where T : class
{
// custom check for null but no enumeration
}
void Foo(IEnumerable&lt;string&gt; values)
{
ThrowIfNull(values, nameof(values));
var x = values.ToList(); // No warnings about multiple enumeration
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.RegexPatternAttribute">
<summary>
Indicates that the marked parameter, field, or property is a regular expression pattern.
</summary>
</member>
<member name="T:JetBrains.Annotations.NoReorderAttribute">
<summary>
Prevents the Member Reordering feature from tossing members of the marked class.
</summary>
<remarks>
The attribute must be mentioned in your member reordering patterns.
</remarks>
</member>
<member name="T:JetBrains.Annotations.XamlItemsControlAttribute">
<summary>
XAML attribute. Indicates the type that has <c>ItemsSource</c> property and should be treated
as <c>ItemsControl</c>-derived type, to enable inner items <c>DataContext</c> type resolve.
</summary>
</member>
<member name="T:JetBrains.Annotations.XamlItemBindingOfItemsControlAttribute">
<summary>
XAML attribute. Indicates the property of some <c>BindingBase</c>-derived type, that
is used to bind some item of <c>ItemsControl</c>-derived type. This annotation will
enable the <c>DataContext</c> type resolve for XAML bindings for such properties.
</summary>
<remarks>
Property should have the tree ancestor of the <c>ItemsControl</c> type or
marked with the <see cref="T:JetBrains.Annotations.XamlItemsControlAttribute"/> attribute.
</remarks>
</member>
<member name="T:JetBrains.Annotations.XamlItemStyleOfItemsControlAttribute">
<summary>
XAML attribute. Indicates the property of some <c>Style</c>-derived type, that
is used to style items of <c>ItemsControl</c>-derived type. This annotation will
enable the <c>DataContext</c> type resolve for XAML bindings for such properties.
</summary>
<remarks>
Property should have the tree ancestor of the <c>ItemsControl</c> type or
marked with the <see cref="T:JetBrains.Annotations.XamlItemsControlAttribute"/> attribute.
</remarks>
</member>
<member name="T:JetBrains.Annotations.XamlOneWayBindingModeByDefaultAttribute">
<summary>
XAML attribute. Indicates that DependencyProperty has <c>OneWay</c> binding mode by default.
</summary>
<remarks>
This attribute must be applied to DependencyProperty's CLR accessor property if it is present, to DependencyProperty descriptor field otherwise.
</remarks>
</member>
<member name="T:JetBrains.Annotations.XamlTwoWayBindingModeByDefaultAttribute">
<summary>
XAML attribute. Indicates that DependencyProperty has <c>TwoWay</c> binding mode by default.
</summary>
<remarks>
This attribute must be applied to DependencyProperty's CLR accessor property if it is present, to DependencyProperty descriptor field otherwise.
</remarks>
</member>
<member name="T:JetBrains.Annotations.RouteTemplateAttribute">
<summary>
Indicates that the marked parameter, field, or property is a route template.
</summary>
<remarks>
This attribute allows IDE to recognize the use of web frameworks' route templates
to enable syntax highlighting, code completion, navigation, rename and other features in string literals.
</remarks>
</member>
<member name="T:JetBrains.Annotations.RouteParameterConstraintAttribute">
<summary>
Indicates that the marked type is custom route parameter constraint,
which is registered in application's Startup with name <c>ConstraintName</c>
</summary>
<remarks>
You can specify <c>ProposedType</c> if target constraint matches only route parameters of specific type,
it will allow IDE to create method's parameter from usage in route template
with specified type instead of default <c>System.String</c>
and check if constraint's proposed type conflicts with matched parameter's type
</remarks>
</member>
<member name="T:JetBrains.Annotations.UriStringAttribute">
<summary>
Indicates that the marked parameter, field, or property is an URI string.
</summary>
<remarks>
This attribute enables code completion, navigation, rename and other features
in URI string literals assigned to annotated parameter, field or property.
</remarks>
</member>
</members>
</doc>

View File

@@ -0,0 +1,823 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>JetBrains.Annotations</name>
</assembly>
<members>
<member name="T:JetBrains.Annotations.CanBeNullAttribute">
<summary>
Indicates that the value of the marked element could be <c>null</c> sometimes,
so checking for <c>null</c> is required before its usage.
</summary>
<example><code>
[CanBeNull] object Test() => null;
void UseTest() {
var p = Test();
var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.NotNullAttribute">
<summary>
Indicates that the value of the marked element can never be <c>null</c>.
</summary>
<example><code>
[NotNull] object Foo() {
return null; // Warning: Possible 'null' assignment
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.ItemNotNullAttribute">
<summary>
Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task
and Lazy classes to indicate that the value of a collection item, of the Task.Result property
or of the Lazy.Value property can never be null.
</summary>
<example><code>
public void Foo([ItemNotNull]List&lt;string&gt; books)
{
foreach (var book in books) {
if (book != null) // Warning: Expression is always true
Console.WriteLine(book.ToUpper());
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.ItemCanBeNullAttribute">
<summary>
Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task
and Lazy classes to indicate that the value of a collection item, of the Task.Result property
or of the Lazy.Value property can be null.
</summary>
<example><code>
public void Foo([ItemCanBeNull]List&lt;string&gt; books)
{
foreach (var book in books)
{
// Warning: Possible 'System.NullReferenceException'
Console.WriteLine(book.ToUpper());
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.StringFormatMethodAttribute">
<summary>
Indicates that the marked method builds string by the format pattern and (optional) arguments.
The parameter, which contains the format string, should be given in the constructor. The format string
should be in <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/>-like form.
</summary>
<example><code>
[StringFormatMethod("message")]
void ShowError(string message, params object[] args) { /* do something */ }
void Foo() {
ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
}
</code></example>
</member>
<member name="M:JetBrains.Annotations.StringFormatMethodAttribute.#ctor(System.String)">
<param name="formatParameterName">
Specifies which parameter of an annotated method should be treated as the format string
</param>
</member>
<member name="T:JetBrains.Annotations.StructuredMessageTemplateAttribute">
<summary>
Indicates that the marked parameter is a message template where placeholders are to be replaced by the following arguments
in the order in which they appear
</summary>
<example><code>
void LogInfo([StructuredMessageTemplate]string message, params object[] args) { /* do something */ }
void Foo() {
LogInfo("User created: {username}"); // Warning: Non-existing argument in format string
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.ValueProviderAttribute">
<summary>
Use this annotation to specify a type that contains static or const fields
with values for the annotated property/field/parameter.
The specified type will be used to improve completion suggestions.
</summary>
<example><code>
namespace TestNamespace
{
public class Constants
{
public static int INT_CONST = 1;
public const string STRING_CONST = "1";
}
public class Class1
{
[ValueProvider("TestNamespace.Constants")] public int myField;
public void Foo([ValueProvider("TestNamespace.Constants")] string str) { }
public void Test()
{
Foo(/*try completion here*/);//
myField = /*try completion here*/
}
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.ValueRangeAttribute">
<summary>
Indicates that the integral value falls into the specified interval.
It's allowed to specify multiple non-intersecting intervals.
Values of interval boundaries are inclusive.
</summary>
<example><code>
void Foo([ValueRange(0, 100)] int value) {
if (value == -1) { // Warning: Expression is always 'false'
...
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.NonNegativeValueAttribute">
<summary>
Indicates that the integral value never falls below zero.
</summary>
<example><code>
void Foo([NonNegativeValue] int value) {
if (value == -1) { // Warning: Expression is always 'false'
...
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.InvokerParameterNameAttribute">
<summary>
Indicates that the function argument should be a string literal and match one
of the parameters of the caller function. For example, ReSharper annotates
the parameter of <see cref="T:System.ArgumentNullException"/>.
</summary>
<example><code>
void Foo(string param) {
if (param == null)
throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.NotifyPropertyChangedInvocatorAttribute">
<summary>
Indicates that the method is contained in a type that implements
<c>System.ComponentModel.INotifyPropertyChanged</c> interface and this method
is used to notify that some property value changed.
</summary>
<remarks>
The method should be non-static and conform to one of the supported signatures:
<list>
<item><c>NotifyChanged(string)</c></item>
<item><c>NotifyChanged(params string[])</c></item>
<item><c>NotifyChanged{T}(Expression{Func{T}})</c></item>
<item><c>NotifyChanged{T,U}(Expression{Func{T,U}})</c></item>
<item><c>SetProperty{T}(ref T, T, string)</c></item>
</list>
</remarks>
<example><code>
public class Foo : INotifyPropertyChanged {
public event PropertyChangedEventHandler PropertyChanged;
[NotifyPropertyChangedInvocator]
protected virtual void NotifyChanged(string propertyName) { ... }
string _name;
public string Name {
get { return _name; }
set { _name = value; NotifyChanged("LastName"); /* Warning */ }
}
}
</code>
Examples of generated notifications:
<list>
<item><c>NotifyChanged("Property")</c></item>
<item><c>NotifyChanged(() =&gt; Property)</c></item>
<item><c>NotifyChanged((VM x) =&gt; x.Property)</c></item>
<item><c>SetProperty(ref myField, value, "Property")</c></item>
</list>
</example>
</member>
<member name="T:JetBrains.Annotations.ContractAnnotationAttribute">
<summary>
Describes dependency between method input and output.
</summary>
<syntax>
<p>Function Definition Table syntax:</p>
<list>
<item>FDT ::= FDTRow [;FDTRow]*</item>
<item>FDTRow ::= Input =&gt; Output | Output &lt;= Input</item>
<item>Input ::= ParameterName: Value [, Input]*</item>
<item>Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value}</item>
<item>Value ::= true | false | null | notnull | canbenull</item>
</list>
If the method has a single input parameter, its name could be omitted.<br/>
Using <c>halt</c> (or <c>void</c>/<c>nothing</c>, which is the same) for the method output
means that the method doesn't return normally (throws or terminates the process).<br/>
Value <c>canbenull</c> is only applicable for output parameters.<br/>
You can use multiple <c>[ContractAnnotation]</c> for each FDT row, or use single attribute
with rows separated by the semicolon. There is no notion of order rows, all rows are checked
for applicability and applied per each program state tracked by the analysis engine.<br/>
</syntax>
<examples><list>
<item><code>
[ContractAnnotation("=&gt; halt")]
public void TerminationMethod()
</code></item>
<item><code>
[ContractAnnotation("null &lt;= param:null")] // reverse condition syntax
public string GetName(string surname)
</code></item>
<item><code>
[ContractAnnotation("s:null =&gt; true")]
public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty()
</code></item>
<item><code>
// A method that returns null if the parameter is null,
// and not null if the parameter is not null
[ContractAnnotation("null =&gt; null; notnull =&gt; notnull")]
public object Transform(object data)
</code></item>
<item><code>
[ContractAnnotation("=&gt; true, result: notnull; =&gt; false, result: null")]
public bool TryParse(string s, out Person result)
</code></item>
</list></examples>
</member>
<member name="T:JetBrains.Annotations.LocalizationRequiredAttribute">
<summary>
Indicates whether the marked element should be localized.
</summary>
<example><code>
[LocalizationRequiredAttribute(true)]
class Foo {
string str = "my string"; // Warning: Localizable string
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.CannotApplyEqualityOperatorAttribute">
<summary>
Indicates that the value of the marked type (or its derivatives)
cannot be compared using '==' or '!=' operators and <c>Equals()</c>
should be used instead. However, using '==' or '!=' for comparison
with <c>null</c> is always permitted.
</summary>
<example><code>
[CannotApplyEqualityOperator]
class NoEquality { }
class UsesNoEquality {
void Test() {
var ca1 = new NoEquality();
var ca2 = new NoEquality();
if (ca1 != null) { // OK
bool condition = ca1 == ca2; // Warning
}
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.BaseTypeRequiredAttribute">
<summary>
When applied to a target attribute, specifies a requirement for any type marked
with the target attribute to implement or inherit specific type or types.
</summary>
<example><code>
[BaseTypeRequired(typeof(IComponent)] // Specify requirement
class ComponentAttribute : Attribute { }
[Component] // ComponentAttribute requires implementing IComponent interface
class MyComponent : IComponent { }
</code></example>
</member>
<member name="T:JetBrains.Annotations.UsedImplicitlyAttribute">
<summary>
Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library),
so this symbol will be ignored by usage-checking inspections. <br/>
You can use <see cref="T:JetBrains.Annotations.ImplicitUseKindFlags"/> and <see cref="T:JetBrains.Annotations.ImplicitUseTargetFlags"/>
to configure how this attribute is applied.
</summary>
<example><code>
[UsedImplicitly]
public class TypeConverter {}
public class SummaryData
{
[UsedImplicitly(ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature)]
public SummaryData() {}
}
[UsedImplicitly(ImplicitUseTargetFlags.WithInheritors | ImplicitUseTargetFlags.Default)]
public interface IService {}
</code></example>
</member>
<member name="T:JetBrains.Annotations.MeansImplicitUseAttribute">
<summary>
Can be applied to attributes, type parameters, and parameters of a type assignable from <see cref="T:System.Type"/> .
When applied to an attribute, the decorated attribute behaves the same as <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
When applied to a type parameter or to a parameter of type <see cref="T:System.Type"/>,
indicates that the corresponding type is used implicitly.
</summary>
</member>
<member name="T:JetBrains.Annotations.ImplicitUseKindFlags">
<summary>
Specifies the details of implicitly used symbol when it is marked
with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Access">
<summary>Only entity marked with attribute considered used.</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Assign">
<summary>Indicates implicit assignment to a member.</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature">
<summary>
Indicates implicit instantiation of a type with fixed constructor signature.
That means any unused constructor parameters won't be reported as such.
</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature">
<summary>Indicates implicit instantiation of a type.</summary>
</member>
<member name="T:JetBrains.Annotations.ImplicitUseTargetFlags">
<summary>
Specifies what is considered to be used implicitly when marked
with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.Members">
<summary>Members of the type marked with the attribute are considered used.</summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.WithInheritors">
<summary> Inherited entities are considered used. </summary>
</member>
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.WithMembers">
<summary>Entity marked with the attribute and all its members considered used.</summary>
</member>
<member name="T:JetBrains.Annotations.PublicAPIAttribute">
<summary>
This attribute is intended to mark publicly available API,
which should not be removed and so is treated as used.
</summary>
</member>
<member name="T:JetBrains.Annotations.InstantHandleAttribute">
<summary>
Tells the code analysis engine if the parameter is completely handled when the invoked method is on stack.
If the parameter is a delegate, indicates that delegate is executed while the method is executed.
If the parameter is an enumerable, indicates that it is enumerated while the method is executed.
</summary>
</member>
<member name="T:JetBrains.Annotations.PureAttribute">
<summary>
Indicates that a method does not make any observable state changes.
The same as <c>System.Diagnostics.Contracts.PureAttribute</c>.
</summary>
<example><code>
[Pure] int Multiply(int x, int y) => x * y;
void M() {
Multiply(123, 42); // Warning: Return value of pure method is not used
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.MustUseReturnValueAttribute">
<summary>
Indicates that the return value of the method invocation must be used.
</summary>
<remarks>
Methods decorated with this attribute (in contrast to pure methods) might change state,
but make no sense without using their return value. <br/>
Similarly to <see cref="T:JetBrains.Annotations.PureAttribute"/>, this attribute
will help to detect usages of the method when the return value is not used.
Optionally, you can specify a message to use when showing warnings, e.g.
<code>[MustUseReturnValue("Use the return value to...")]</code>.
</remarks>
</member>
<member name="T:JetBrains.Annotations.RequireStaticDelegateAttribute">
<summary>
This annotation allows to enforce allocation-less usage patterns of delegates for performance-critical APIs.
When this annotation is applied to the parameter of delegate type, IDE checks the input argument of this parameter:
* When lambda expression or anonymous method is passed as an argument, IDE verifies that the passed closure
has no captures of the containing local variables and the compiler is able to cache the delegate instance
to avoid heap allocations. Otherwise the warning is produced.
* IDE warns when method name or local function name is passed as an argument as this always results
in heap allocation of the delegate instance.
</summary>
<remarks>
In C# 9.0 code IDE would also suggest to annotate the anonymous function with 'static' modifier
to make use of the similar analysis provided by the language/compiler.
</remarks>
</member>
<member name="T:JetBrains.Annotations.ProvidesContextAttribute">
<summary>
Indicates the type member or parameter of some type, that should be used instead of all other ways
to get the value of that type. This annotation is useful when you have some "context" value evaluated
and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one.
</summary>
<example><code>
class Foo {
[ProvidesContext] IBarService _barService = ...;
void ProcessNode(INode node) {
DoSomething(node, node.GetGlobalServices().Bar);
// ^ Warning: use value of '_barService' field
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.PathReferenceAttribute">
<summary>
Indicates that a parameter is a path to a file or a folder within a web project.
Path can be relative or absolute, starting from web root (~).
</summary>
</member>
<member name="T:JetBrains.Annotations.SourceTemplateAttribute">
<summary>
An extension method marked with this attribute is processed by code completion
as a 'Source Template'. When the extension method is completed over some expression, its source code
is automatically expanded like a template at call site.
</summary>
<remarks>
Template method body can contain valid source code and/or special comments starting with '$'.
Text inside these comments is added as source code when the template is applied. Template parameters
can be used either as additional method parameters or as identifiers wrapped in two '$' signs.
Use the <see cref="T:JetBrains.Annotations.MacroAttribute"/> attribute to specify macros for parameters.
</remarks>
<example>
In this example, the 'forEach' method is a source template available over all values
of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block:
<code>
[SourceTemplate]
public static void forEach&lt;T&gt;(this IEnumerable&lt;T&gt; xs) {
foreach (var x in xs) {
//$ $END$
}
}
</code>
</example>
</member>
<member name="T:JetBrains.Annotations.MacroAttribute">
<summary>
Allows specifying a macro for a parameter of a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see>.
</summary>
<remarks>
You can apply the attribute on the whole method or on any of its additional parameters. The macro expression
is defined in the <see cref="P:JetBrains.Annotations.MacroAttribute.Expression"/> property. When applied on a method, the target
template parameter is defined in the <see cref="P:JetBrains.Annotations.MacroAttribute.Target"/> property. To apply the macro silently
for the parameter, set the <see cref="P:JetBrains.Annotations.MacroAttribute.Editable"/> property value = -1.
</remarks>
<example>
Applying the attribute on a source template method:
<code>
[SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")]
public static void forEach&lt;T&gt;(this IEnumerable&lt;T&gt; collection) {
foreach (var item in collection) {
//$ $END$
}
}
</code>
Applying the attribute on a template method parameter:
<code>
[SourceTemplate]
public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) {
/*$ var $x$Id = "$newguid$" + x.ToString();
x.DoSomething($x$Id); */
}
</code>
</example>
</member>
<member name="P:JetBrains.Annotations.MacroAttribute.Expression">
<summary>
Allows specifying a macro that will be executed for a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see>
parameter when the template is expanded.
</summary>
</member>
<member name="P:JetBrains.Annotations.MacroAttribute.Editable">
<summary>
Allows specifying which occurrence of the target parameter becomes editable when the template is deployed.
</summary>
<remarks>
If the target parameter is used several times in the template, only one occurrence becomes editable;
other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence,
use values >= 0. To make the parameter non-editable when the template is expanded, use -1.
</remarks>
</member>
<member name="P:JetBrains.Annotations.MacroAttribute.Target">
<summary>
Identifies the target parameter of a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see> if the
<see cref="T:JetBrains.Annotations.MacroAttribute"/> is applied on a template method.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcActionAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
is an MVC action. If applied to a method, the MVC action name is calculated
implicitly from the context. Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcAreaAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC area.
Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcControllerAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is
an MVC controller. If applied to a method, the MVC controller name is calculated
implicitly from the context. Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcMasterAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC Master. Use this attribute
for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcModelTypeAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC model type. Use this attribute
for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, Object)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcPartialViewAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC
partial view. If applied to a method, the MVC partial view name is calculated implicitly
from the context. Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcSuppressViewErrorAttribute">
<summary>
ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcDisplayTemplateAttribute">
<summary>
ASP.NET MVC attribute. Indicates that a parameter is an MVC display template.
Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcEditorTemplateAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC editor template.
Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcTemplateAttribute">
<summary>
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC template.
Use this attribute for custom wrappers similar to
<c>System.ComponentModel.DataAnnotations.UIHintAttribute(System.String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcViewAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
is an MVC view component. If applied to a method, the MVC view name is calculated implicitly
from the context. Use this attribute for custom wrappers similar to
<c>System.Web.Mvc.Controller.View(Object)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcViewComponentAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
is an MVC view component name.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcViewComponentViewAttribute">
<summary>
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
is an MVC view component view. If applied to a method, the MVC view component view name is default.
</summary>
</member>
<member name="T:JetBrains.Annotations.AspMvcActionSelectorAttribute">
<summary>
ASP.NET MVC attribute. When applied to a parameter of an attribute,
indicates that this parameter is an MVC action name.
</summary>
<example><code>
[ActionName("Foo")]
public ActionResult Login(string returnUrl) {
ViewBag.ReturnUrl = Url.Action("Foo"); // OK
return RedirectToAction("Bar"); // Error: Cannot resolve action
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.RazorSectionAttribute">
<summary>
Razor attribute. Indicates that the marked parameter or method is a Razor section.
Use this attribute for custom wrappers similar to
<c>System.Web.WebPages.WebPageBase.RenderSection(String)</c>.
</summary>
</member>
<member name="T:JetBrains.Annotations.CollectionAccessAttribute">
<summary>
Indicates how method, constructor invocation, or property access
over collection type affects the contents of the collection.
Use <see cref="P:JetBrains.Annotations.CollectionAccessAttribute.CollectionAccessType"/> to specify the access type.
</summary>
<remarks>
Using this attribute only makes sense if all collection methods are marked with this attribute.
</remarks>
<example><code>
public class MyStringCollection : List&lt;string&gt;
{
[CollectionAccess(CollectionAccessType.Read)]
public string GetFirstString()
{
return this.ElementAt(0);
}
}
class Test
{
public void Foo()
{
// Warning: Contents of the collection is never updated
var col = new MyStringCollection();
string x = col.GetFirstString();
}
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.CollectionAccessType">
<summary>
Provides a value for the <see cref="T:JetBrains.Annotations.CollectionAccessAttribute"/> to define
how the collection method invocation affects the contents of the collection.
</summary>
</member>
<member name="F:JetBrains.Annotations.CollectionAccessType.None">
<summary>Method does not use or modify content of the collection.</summary>
</member>
<member name="F:JetBrains.Annotations.CollectionAccessType.Read">
<summary>Method only reads content of the collection but does not modify it.</summary>
</member>
<member name="F:JetBrains.Annotations.CollectionAccessType.ModifyExistingContent">
<summary>Method can change content of the collection but does not add new elements.</summary>
</member>
<member name="F:JetBrains.Annotations.CollectionAccessType.UpdatedContent">
<summary>Method can add new elements to the collection.</summary>
</member>
<member name="T:JetBrains.Annotations.AssertionMethodAttribute">
<summary>
Indicates that the marked method is assertion method, i.e. it halts the control flow if
one of the conditions is satisfied. To set the condition, mark one of the parameters with
<see cref="T:JetBrains.Annotations.AssertionConditionAttribute"/> attribute.
</summary>
</member>
<member name="T:JetBrains.Annotations.AssertionConditionAttribute">
<summary>
Indicates the condition parameter of the assertion method. The method itself should be
marked by <see cref="T:JetBrains.Annotations.AssertionMethodAttribute"/> attribute. The mandatory argument of
the attribute is the assertion type.
</summary>
</member>
<member name="T:JetBrains.Annotations.AssertionConditionType">
<summary>
Specifies assertion type. If the assertion method argument satisfies the condition,
then the execution continues. Otherwise, execution is assumed to be halted.
</summary>
</member>
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_TRUE">
<summary>Marked parameter should be evaluated to true.</summary>
</member>
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_FALSE">
<summary>Marked parameter should be evaluated to false.</summary>
</member>
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_NULL">
<summary>Marked parameter should be evaluated to null value.</summary>
</member>
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_NOT_NULL">
<summary>Marked parameter should be evaluated to not null value.</summary>
</member>
<member name="T:JetBrains.Annotations.TerminatesProgramAttribute">
<summary>
Indicates that the marked method unconditionally terminates control flow execution.
For example, it could unconditionally throw exception.
</summary>
</member>
<member name="T:JetBrains.Annotations.LinqTunnelAttribute">
<summary>
Indicates that the method is a pure LINQ method, with postponed enumeration (like Enumerable.Select,
.Where). This annotation allows inference of [InstantHandle] annotation for parameters
of delegate type by analyzing LINQ method chains.
</summary>
</member>
<member name="T:JetBrains.Annotations.NoEnumerationAttribute">
<summary>
Indicates that IEnumerable passed as a parameter is not enumerated.
Use this annotation to suppress the 'Possible multiple enumeration of IEnumerable' inspection.
</summary>
<example><code>
static void ThrowIfNull&lt;T&gt;([NoEnumeration] T v, string n) where T : class
{
// custom check for null but no enumeration
}
void Foo(IEnumerable&lt;string&gt; values)
{
ThrowIfNull(values, nameof(values));
var x = values.ToList(); // No warnings about multiple enumeration
}
</code></example>
</member>
<member name="T:JetBrains.Annotations.RegexPatternAttribute">
<summary>
Indicates that the marked parameter, field, or property is a regular expression pattern.
</summary>
</member>
<member name="T:JetBrains.Annotations.NoReorderAttribute">
<summary>
Prevents the Member Reordering feature from tossing members of the marked class.
</summary>
<remarks>
The attribute must be mentioned in your member reordering patterns.
</remarks>
</member>
<member name="T:JetBrains.Annotations.XamlItemsControlAttribute">
<summary>
XAML attribute. Indicates the type that has <c>ItemsSource</c> property and should be treated
as <c>ItemsControl</c>-derived type, to enable inner items <c>DataContext</c> type resolve.
</summary>
</member>
<member name="T:JetBrains.Annotations.XamlItemBindingOfItemsControlAttribute">
<summary>
XAML attribute. Indicates the property of some <c>BindingBase</c>-derived type, that
is used to bind some item of <c>ItemsControl</c>-derived type. This annotation will
enable the <c>DataContext</c> type resolve for XAML bindings for such properties.
</summary>
<remarks>
Property should have the tree ancestor of the <c>ItemsControl</c> type or
marked with the <see cref="T:JetBrains.Annotations.XamlItemsControlAttribute"/> attribute.
</remarks>
</member>
<member name="T:JetBrains.Annotations.XamlItemStyleOfItemsControlAttribute">
<summary>
XAML attribute. Indicates the property of some <c>Style</c>-derived type, that
is used to style items of <c>ItemsControl</c>-derived type. This annotation will
enable the <c>DataContext</c> type resolve for XAML bindings for such properties.
</summary>
<remarks>
Property should have the tree ancestor of the <c>ItemsControl</c> type or
marked with the <see cref="T:JetBrains.Annotations.XamlItemsControlAttribute"/> attribute.
</remarks>
</member>
<member name="T:JetBrains.Annotations.XamlOneWayBindingModeByDefaultAttribute">
<summary>
XAML attribute. Indicates that DependencyProperty has <c>OneWay</c> binding mode by default.
</summary>
<remarks>
This attribute must be applied to DependencyProperty's CLR accessor property if it is present, to DependencyProperty descriptor field otherwise.
</remarks>
</member>
<member name="T:JetBrains.Annotations.XamlTwoWayBindingModeByDefaultAttribute">
<summary>
XAML attribute. Indicates that DependencyProperty has <c>TwoWay</c> binding mode by default.
</summary>
<remarks>
This attribute must be applied to DependencyProperty's CLR accessor property if it is present, to DependencyProperty descriptor field otherwise.
</remarks>
</member>
<member name="T:JetBrains.Annotations.RouteTemplateAttribute">
<summary>
Indicates that the marked parameter, field, or property is a route template.
</summary>
<remarks>
This attribute allows IDE to recognize the use of web frameworks' route templates
to enable syntax highlighting, code completion, navigation, rename and other features in string literals.
</remarks>
</member>
<member name="T:JetBrains.Annotations.RouteParameterConstraintAttribute">
<summary>
Indicates that the marked type is custom route parameter constraint,
which is registered in application's Startup with name <c>ConstraintName</c>
</summary>
<remarks>
You can specify <c>ProposedType</c> if target constraint matches only route parameters of specific type,
it will allow IDE to create method's parameter from usage in route template
with specified type instead of default <c>System.String</c>
and check if constraint's proposed type conflicts with matched parameter's type
</remarks>
</member>
<member name="T:JetBrains.Annotations.UriStringAttribute">
<summary>
Indicates that the marked parameter, field, or property is an URI string.
</summary>
<remarks>
This attribute enables code completion, navigation, rename and other features
in URI string literals assigned to annotated parameter, field or property.
</remarks>
</member>
</members>
</doc>

View File

@@ -0,0 +1,5 @@
{
"version": 2,
"contentHash": "JWxlYwCSYXZIWezmrvRgaxhI/vEEpQlZVm6/lskuS7p/uPrNJzQxbe2CPjzkF3UUz4RI8WkmObs6ycpxoE9T7w==",
"source": "https://api.nuget.org/v3/index.json"
}

Binary file not shown.

View File

@@ -0,0 +1,21 @@
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
<metadata>
<id>Json.More.Net</id>
<version>1.8.0</version>
<authors>Greg Dennis</authors>
<license type="file">LICENSE</license>
<licenseUrl>https://aka.ms/deprecateLicenseUrl</licenseUrl>
<icon>json-logo-256.png</icon>
<projectUrl>https://github.com/gregsdennis/json-everything</projectUrl>
<description>Provides extended functionality for the System.Text.Json namespace.</description>
<releaseNotes>Release notes can be found on [GitHub](https://github.com/gregsdennis/json-everything/blob/master/json-everything.net/wwwroot/md/release-notes/json-more.md) and https://json-everything.net/json-more</releaseNotes>
<tags>json system.text.json json.more</tags>
<repository type="git" url="https://github.com/gregsdennis/json-everything" commit="487b7398ff5cf47d894cd693645a9a61bc0359c8" />
<dependencies>
<group targetFramework=".NETStandard2.0">
<dependency id="System.Text.Json" version="6.0.2" exclude="Build,Analyzers" />
</group>
</dependencies>
</metadata>
</package>

View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2022 Greg Dennis
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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

View File

@@ -0,0 +1 @@
2mKdoLpi93pC7IYaoFxb//PopX3i+xrqtgbp0mfbMRl5WdjiPBoa8cY8irAI87NJNCjFOgbF2POSjTnILYRSYg==

View File

@@ -0,0 +1,495 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>Json.More</name>
</assembly>
<members>
<!-- Badly formed XML comment ignored for member "T:Json.More.EnumStringConverter`1" -->
<member name="M:Json.More.EnumStringConverter`1.Read(System.Text.Json.Utf8JsonReader@,System.Type,System.Text.Json.JsonSerializerOptions)">
<summary>Reads and converts the JSON to type <typeparamref name="T" />.</summary>
<param name="reader">The reader.</param>
<param name="typeToConvert">The type to convert.</param>
<param name="options">An object that specifies serialization options to use.</param>
<returns>The converted value.</returns>
<exception cref="T:System.Text.Json.JsonException">Element was not a string or could not identify the JSON value as a known enum value.</exception>
</member>
<member name="M:Json.More.EnumStringConverter`1.ReadAsPropertyName(System.Text.Json.Utf8JsonReader@,System.Type,System.Text.Json.JsonSerializerOptions)">
<summary>Reads a dictionary key from a JSON property name.</summary>
<param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read from.</param>
<param name="typeToConvert">The type to convert.</param>
<param name="options">The options to use when reading the value.</param>
<returns>The value that was converted.</returns>
</member>
<member name="M:Json.More.EnumStringConverter`1.Write(System.Text.Json.Utf8JsonWriter,`0,System.Text.Json.JsonSerializerOptions)">
<summary>Writes a specified value as JSON.</summary>
<param name="writer">The writer to write to.</param>
<param name="value">The value to convert to JSON.</param>
<param name="options">An object that specifies serialization options to use.</param>
</member>
<member name="M:Json.More.EnumStringConverter`1.WriteAsPropertyName(System.Text.Json.Utf8JsonWriter,`0,System.Text.Json.JsonSerializerOptions)">
<summary>Writes a dictionary key as a JSON property name.</summary>
<param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write to.</param>
<param name="value">The value to convert. The value of <see cref="P:System.Text.Json.Serialization.JsonConverter`1.HandleNull" /> determines if the converter handles <see langword="null" /> values.</param>
<param name="options">The options to use when writing the value.</param>
</member>
<member name="T:Json.More.JsonDocumentEqualityComparer">
<summary>
Calculates equality between two <see cref="T:System.Text.Json.JsonDocument"/>s.
</summary>
<remarks>
This comparison is compliant with the ideals expressed by JSON:
- Objects are unordered.
- Arrays are ordered.
</remarks>
</member>
<member name="P:Json.More.JsonDocumentEqualityComparer.Instance">
<summary>
A singleton instance for convenience.
</summary>
</member>
<member name="M:Json.More.JsonDocumentEqualityComparer.Equals(System.Text.Json.JsonDocument,System.Text.Json.JsonDocument)">
<summary>Determines whether the specified objects are equal.</summary>
<param name="x">The first object of type T to compare.</param>
<param name="y">The second object of type T to compare.</param>
<returns>true if the specified objects are equal; otherwise, false.</returns>
</member>
<member name="M:Json.More.JsonDocumentEqualityComparer.GetHashCode(System.Text.Json.JsonDocument)">
<summary>Returns a hash code for the specified object.</summary>
<param name="obj">The <see cref="T:System.Object"></see> for which a hash code is to be returned.</param>
<returns>A hash code for the specified object.</returns>
<exception cref="T:System.ArgumentNullException">The type of <paramref name="obj">obj</paramref> is a reference type and <paramref name="obj">obj</paramref> is null.</exception>
</member>
<member name="T:Json.More.JsonDocumentExtensions">
<summary>
Provides extension functionality for <see cref="T:System.Text.Json.JsonDocument"/>.
</summary>
</member>
<member name="M:Json.More.JsonDocumentExtensions.IsEquivalentTo(System.Text.Json.JsonDocument,System.Text.Json.JsonDocument)">
<summary>
Determines JSON-compatible equivalence.
</summary>
<param name="a">The first document.</param>
<param name="b">The second document.</param>
<returns>`true` if the documents are equivalent; `false` otherwise.</returns>
</member>
<member name="M:Json.More.JsonDocumentExtensions.ToJsonDocument``1(``0,System.Text.Json.JsonSerializerOptions)">
<summary>
Converts an object to a <see cref="T:System.Text.Json.JsonDocument"/>.
</summary>
<typeparam name="T">The type of the object.</typeparam>
<param name="value">The value to convert.</param>
<param name="options">(optional) JSON serialization options.</param>
<returns>A <see cref="T:System.Text.Json.JsonDocument"/> representing the vale.</returns>
</member>
<member name="T:Json.More.JsonElementEqualityComparer">
<summary>
Calculates equality between two <see cref="T:System.Text.Json.JsonElement"/>s.
</summary>
<remarks>
This comparison is compliant with the ideals expressed by JSON:
- Objects are unordered.
- Arrays are ordered.
</remarks>
</member>
<member name="P:Json.More.JsonElementEqualityComparer.Instance">
<summary>
A singleton instance for convenience.
</summary>
</member>
<member name="M:Json.More.JsonElementEqualityComparer.Equals(System.Text.Json.JsonElement,System.Text.Json.JsonElement)">
<summary>Determines whether the specified objects are equal.</summary>
<param name="x">The first object of type T to compare.</param>
<param name="y">The second object of type T to compare.</param>
<returns>true if the specified objects are equal; otherwise, false.</returns>
</member>
<member name="M:Json.More.JsonElementEqualityComparer.GetHashCode(System.Text.Json.JsonElement)">
<summary>Returns a hash code for the specified object.</summary>
<param name="obj">The <see cref="T:System.Object"></see> for which a hash code is to be returned.</param>
<returns>A hash code for the specified object.</returns>
<exception cref="T:System.ArgumentNullException">The type of <paramref name="obj">obj</paramref> is a reference type and <paramref name="obj">obj</paramref> is null.</exception>
</member>
<member name="T:Json.More.JsonElementExtensions">
<summary>
Provides extension functionality for <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
</member>
<member name="M:Json.More.JsonElementExtensions.IsEquivalentTo(System.Text.Json.JsonElement,System.Text.Json.JsonElement)">
<summary>
Determines JSON-compatible equivalence.
</summary>
<param name="a">The first element.</param>
<param name="b">The second element.</param>
<returns>`true` if the element are equivalent; `false` otherwise.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.Text.Json.JsonElement.ValueKind"/> is not valid.</exception>
</member>
<member name="M:Json.More.JsonElementExtensions.GetEquivalenceHashCode(System.Text.Json.JsonElement,System.Int32)">
<summary>
Generate a consistent JSON-value-based hash code for the element.
</summary>
<param name="element">The element.</param>
<param name="maxHashDepth">Maximum depth to calculate. Default is -1 which utilizes the entire structure without limitation.</param>
<returns>The hash code.</returns>
<remarks>
See the following for discussion on why the default implementation is insufficient:
- https://github.com/gregsdennis/json-everything/issues/76
- https://github.com/dotnet/runtime/issues/33388
</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.ToJsonString(System.Text.Json.JsonElement)">
<summary>
Just a shortcut for calling `JsonSerializer.Serialize()` because `.ToString()` doesn't do what you might expect.
</summary>
<param name="element">The value to convert.</param>
<returns>A JSON string.</returns>
<remarks>
See https://github.com/dotnet/runtime/issues/42502
</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Int64)">
<summary>
Converts a <see cref="T:System.Int64"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="value">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Int32)">
<summary>
Converts a <see cref="T:System.Int32"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="value">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Int16)">
<summary>
Converts a <see cref="T:System.Int16"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="value">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Boolean)">
<summary>
Converts a <see cref="T:System.Boolean"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="value">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Decimal)">
<summary>
Converts a <see cref="T:System.Int64"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="value">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Double)">
<summary>
Converts a <see cref="T:System.Double"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="value">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Single)">
<summary>
Converts a <see cref="T:System.Single"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="value">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.String)">
<summary>
Converts a <see cref="T:System.String"/> to a <see cref="T:System.Text.Json.JsonElement"/>. Can also be used to get a `null` element.
</summary>
<param name="value">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Collections.Generic.IEnumerable{System.Text.Json.JsonElement})">
<summary>
Converts a <see cref="T:System.Int64"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="values">The array of values to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Collections.Generic.IDictionary{System.String,System.Text.Json.JsonElement})">
<summary>
Converts a <see cref="T:System.Int64"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="values">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsNode(System.Text.Json.JsonElement)">
<summary>
Converts a <see cref="T:System.Text.Json.JsonElement"/> to a <see cref="T:System.Text.Json.Nodes.JsonNode"/>.
</summary>
<param name="element">The element.</param>
<returns>An equivalent node.</returns>
<remarks>
This provides a single point of conversion as one is not provided by .Net.
See https://github.com/dotnet/runtime/issues/70427 for more information.
</remarks>
</member>
<member name="T:Json.More.JsonElementProxy">
<summary>
Acts as an intermediary that allows an "implicit casting"-like behavior between
native JSON types and <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(System.Int32)~Json.More.JsonElementProxy">
<summary>
Converts an `int` to a <see cref="T:Json.More.JsonElementProxy"/>.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(System.Int64)~Json.More.JsonElementProxy">
<summary>
Converts an `long` to a <see cref="T:Json.More.JsonElementProxy"/>.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(System.Int16)~Json.More.JsonElementProxy">
<summary>
Converts an `short` to a <see cref="T:Json.More.JsonElementProxy"/>.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(System.Single)~Json.More.JsonElementProxy">
<summary>
Converts an `float` to a <see cref="T:Json.More.JsonElementProxy"/>.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(System.Double)~Json.More.JsonElementProxy">
<summary>
Converts an `double` to a <see cref="T:Json.More.JsonElementProxy"/>.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(System.Decimal)~Json.More.JsonElementProxy">
<summary>
Converts an `decimal` to a <see cref="T:Json.More.JsonElementProxy"/>.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(System.String)~Json.More.JsonElementProxy">
<summary>
Converts an `string` to a <see cref="T:Json.More.JsonElementProxy"/>.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(System.Boolean)~Json.More.JsonElementProxy">
<summary>
Converts an `bool` to a <see cref="T:Json.More.JsonElementProxy"/>.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(Json.More.JsonElementProxy)~System.Text.Json.JsonElement">
<summary>
Converts a <see cref="T:Json.More.JsonElementProxy"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="proxy">The proxy.</param>
</member>
<member name="T:Json.More.JsonNodeEqualityComparer">
<summary>
Calculates equality between two <see cref="T:System.Text.Json.JsonElement"/>s.
</summary>
<remarks>
This comparison is compliant with the ideals expressed by JSON:
- Objects are unordered.
- Arrays are ordered.
</remarks>
</member>
<member name="P:Json.More.JsonNodeEqualityComparer.Instance">
<summary>
A singleton instance for convenience.
</summary>
</member>
<member name="M:Json.More.JsonNodeEqualityComparer.Equals(System.Text.Json.Nodes.JsonNode,System.Text.Json.Nodes.JsonNode)">
<summary>Determines whether the specified objects are equal.</summary>
<param name="x">The first object of type T to compare.</param>
<param name="y">The second object of type T to compare.</param>
<returns>true if the specified objects are equal; otherwise, false.</returns>
</member>
<member name="M:Json.More.JsonNodeEqualityComparer.GetHashCode(System.Text.Json.Nodes.JsonNode)">
<summary>Returns a hash code for the specified object.</summary>
<param name="obj">The <see cref="T:System.Object"></see> for which a hash code is to be returned.</param>
<returns>A hash code for the specified object.</returns>
<exception cref="T:System.ArgumentNullException">The type of <paramref name="obj">obj</paramref> is a reference type and <paramref name="obj">obj</paramref> is null.</exception>
</member>
<member name="T:Json.More.JsonNodeExtensions">
<summary>
Provides extension functionality for <see cref="T:System.Text.Json.Nodes.JsonNode"/>.
</summary>
</member>
<member name="M:Json.More.JsonNodeExtensions.IsEquivalentTo(System.Text.Json.Nodes.JsonNode,System.Text.Json.Nodes.JsonNode)">
<summary>
Determines JSON-compatible equivalence.
</summary>
<param name="a">The first element.</param>
<param name="b">The second element.</param>
<returns>`true` if the element are equivalent; `false` otherwise.</returns>
</member>
<member name="M:Json.More.JsonNodeExtensions.GetEquivalenceHashCode(System.Text.Json.Nodes.JsonNode,System.Int32)">
<summary>
Generate a consistent JSON-value-based hash code for the element.
</summary>
<param name="node">The element.</param>
<param name="maxHashDepth">Maximum depth to calculate. Default is -1 which utilizes the entire structure without limitation.</param>
<returns>The hash code.</returns>
<remarks>
See the following for discussion on why the default implementation is insufficient:
- https://github.com/gregsdennis/json-everything/issues/76
- https://github.com/dotnet/runtime/issues/33388
</remarks>
</member>
<member name="M:Json.More.JsonNodeExtensions.AsJsonString(System.Text.Json.Nodes.JsonNode,System.Text.Json.JsonSerializerOptions)">
<summary>
Gets JSON string representation for <see cref="T:System.Text.Json.Nodes.JsonNode"/>, including null support.
</summary>
<param name="node">A node.</param>
<param name="options">Serializer options</param>
<returns>JSON string representation.</returns>
</member>
<member name="M:Json.More.JsonNodeExtensions.GetNumber(System.Text.Json.Nodes.JsonValue)">
<summary>
Gets a node's underlying numeric value.
</summary>
<param name="value">A JSON value.</param>
<returns>Gets the underlying numeric value, or null if the node represented a non-numeric value.</returns>
</member>
<member name="M:Json.More.JsonNodeExtensions.GetInteger(System.Text.Json.Nodes.JsonValue)">
<summary>
Gets a node's underlying numeric value if it's an integer.
</summary>
<param name="value">A JSON value.</param>
<returns>Gets the underlying numeric value if it's an integer, or null if the node represented a non-integer value.</returns>
</member>
<member name="M:Json.More.JsonNodeExtensions.Copy(System.Text.Json.Nodes.JsonNode)">
<summary>
Creates a copy of a node by passing it through the serializer.
</summary>
<param name="source">A node.</param>
<returns>A duplicate of the node.</returns>
<remarks>
`JsonNode` may only be part of a single JSON tree, i.e. have a single parent.
Copying a node allows its value to be saved to another JSON tree.
</remarks>
</member>
<member name="M:Json.More.JsonNodeExtensions.TryGetValue(System.Text.Json.Nodes.JsonObject,System.String,System.Text.Json.Nodes.JsonNode@,System.Exception@)">
<summary>
Convenience method that wraps <see cref="M:System.Text.Json.Nodes.JsonObject.TryGetPropertyValue(System.String,System.Text.Json.Nodes.JsonNode@)"/>
and catches argument exceptions.
</summary>
<param name="obj">The JSON object.</param>
<param name="propertyName">The property name</param>
<param name="node">The node under the property name if it exists and is singular; null otherwise.</param>
<param name="e">An exception if one was thrown during the access attempt.</param>
<returns>true if the property exists and is singular within the JSON data.</returns>
<remarks>
<see cref="M:System.Text.Json.Nodes.JsonObject.TryGetPropertyValue(System.String,System.Text.Json.Nodes.JsonNode@)"/> throws an
<see cref="T:System.ArgumentException"/> if the node was parsed from data that has duplicate
keys. Please see https://github.com/dotnet/runtime/issues/70604 for more information.
</remarks>
</member>
<member name="M:Json.More.JsonNodeExtensions.ToJsonArray(System.Collections.Generic.IEnumerable{System.Text.Json.Nodes.JsonNode})">
<summary>
Creates a new <see cref="T:System.Text.Json.Nodes.JsonArray"/> from an enumerable of nodes.
</summary>
<param name="nodes">The nodes.</param>
<returns>A JSON array.</returns>
</member>
<member name="M:Json.More.JsonNodeExtensions.GetPathFromRoot(System.Text.Json.Nodes.JsonNode,System.Boolean)">
<summary>
Gets a JSON Path string that indicates the node's location within
its JSON structure.
</summary>
<param name="node">The node to find.</param>
<param name="useShorthand">Determines whether shorthand syntax is used when possible, e.g. `$.foo`.</param>
<exception cref="T:System.ArgumentNullException">Null nodes cannot be located as the parent cannot be determined.</exception>
<returns>
A string containing a JSON Path.
</returns>
</member>
<member name="M:Json.More.JsonNodeExtensions.GetPointerFromRoot(System.Text.Json.Nodes.JsonNode)">
<summary>
Gets a JSON Pointer string that indicates the node's location within
its JSON structure.
</summary>
<param name="node">The node to find.</param>
<exception cref="T:System.ArgumentNullException">Null nodes cannot be located as the parent cannot be determined.</exception>
<returns>
A string containing a JSON Pointer.
</returns>
</member>
<member name="T:Json.More.JsonNull">
<summary>
Provides a <see cref="T:System.Text.Json.Nodes.JsonNode"/> instance to use as null.
</summary>
<remarks>
.Net has decided to unify JSON null with .Net null. This decision has a number
of consequences. This value is provided to get around some of these issues.
This class *should not be used as a property value*, but rather as a signal to indicate
that null was explicitly passed rather than a property missing.
See https://github.com/dotnet/runtime/issues/68128 for more information.
</remarks>
</member>
<member name="P:Json.More.JsonNull.SignalNode">
<summary>
Provides a static instance of this class wrapped in a <see cref="T:System.Text.Json.Nodes.JsonNode"/>.
</summary>
</member>
<member name="T:Json.More.TypeExtensions">
<summary>
Provides informative methods for types.
</summary>
</member>
<member name="M:Json.More.TypeExtensions.IsInteger(System.Type)">
<summary>
Determines whether the type is considered an integer.
</summary>
<param name="type">The type.</param>
<returns>true if it represents an integer; false otherwise.</returns>
</member>
<member name="M:Json.More.TypeExtensions.IsFloatingPoint(System.Type)">
<summary>
Determines whether the type is a non-integer floating point number.
</summary>
<param name="type">The type.</param>
<returns>true if it represents a floating-point number; false otherwise.</returns>
</member>
<member name="M:Json.More.TypeExtensions.IsNumber(System.Type)">
<summary>
Determines whether the type is a number.
</summary>
<param name="type">The type.</param>
<returns>true if it represents a number; false otherwise.</returns>
</member>
<member name="T:Json.More.Utf8JsonWriterExtensions">
<summary>
Provides extension functionality for <see cref="T:System.Text.Json.Utf8JsonWriter"/>.
</summary>
</member>
<member name="M:Json.More.Utf8JsonWriterExtensions.WriteValue(System.Text.Json.Utf8JsonWriter,System.Text.Json.JsonElement)">
<summary>
Writes a <see cref="T:System.Text.Json.JsonElement"/> to the stream.
</summary>
<param name="writer">The JSON stream writer.</param>
<param name="element">The element to write.</param>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.Text.Json.JsonElement.ValueKind"/> is not valid.</exception>
</member>
</members>
</doc>

View File

@@ -0,0 +1,5 @@
{
"version": 2,
"contentHash": "MMjd2dOh32hLbcZg9YyA+7aEH9gu2cMTEAWrQY17in4+aEsPg2NtYTcwgWHJS9Tt2WUx+4iN1mNegR2uiEwsVQ==",
"source": "https://api.nuget.org/v3/index.json"
}

Binary file not shown.

View File

@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
<metadata>
<id>Json.More.Net</id>
<version>1.9.0</version>
<authors>Greg Dennis</authors>
<license type="file">LICENSE</license>
<licenseUrl>https://aka.ms/deprecateLicenseUrl</licenseUrl>
<icon>json-logo-256.png</icon>
<projectUrl>https://github.com/gregsdennis/json-everything</projectUrl>
<description>Provides extended functionality for the System.Text.Json namespace.
Read the full documentation at https://docs.json-everything.net/more/json-more/.</description>
<releaseNotes>Release notes can be found at https://docs.json-everything.net/rn-json-more/</releaseNotes>
<tags>json system.text.json json.more</tags>
<repository type="git" url="https://github.com/gregsdennis/json-everything" commit="ff10b206fe99cdc03eadd00b7ce87871494576a5" />
<dependencies>
<group targetFramework=".NETStandard2.0">
<dependency id="System.Text.Json" version="6.0.2" exclude="Build,Analyzers" />
</group>
</dependencies>
</metadata>
</package>

View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2022 Greg Dennis
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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

View File

@@ -0,0 +1 @@
seto9EQl9vqHW5L6WavB5hSPUgVYyG6fCQiEAZyFJOrIY6lvIdl6WJu2E6FzyIjFg0kwG2QqzOO5oAZbO0Kn7Q==

View File

@@ -0,0 +1,513 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>Json.More</name>
</assembly>
<members>
<!-- Badly formed XML comment ignored for member "T:Json.More.EnumStringConverter`1" -->
<member name="M:Json.More.EnumStringConverter`1.Read(System.Text.Json.Utf8JsonReader@,System.Type,System.Text.Json.JsonSerializerOptions)">
<summary>Reads and converts the JSON to type <typeparamref name="T" />.</summary>
<param name="reader">The reader.</param>
<param name="typeToConvert">The type to convert.</param>
<param name="options">An object that specifies serialization options to use.</param>
<returns>The converted value.</returns>
<exception cref="T:System.Text.Json.JsonException">Element was not a string or could not identify the JSON value as a known enum value.</exception>
</member>
<member name="M:Json.More.EnumStringConverter`1.ReadAsPropertyName(System.Text.Json.Utf8JsonReader@,System.Type,System.Text.Json.JsonSerializerOptions)">
<summary>Reads a dictionary key from a JSON property name.</summary>
<param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read from.</param>
<param name="typeToConvert">The type to convert.</param>
<param name="options">The options to use when reading the value.</param>
<returns>The value that was converted.</returns>
</member>
<member name="M:Json.More.EnumStringConverter`1.Write(System.Text.Json.Utf8JsonWriter,`0,System.Text.Json.JsonSerializerOptions)">
<summary>Writes a specified value as JSON.</summary>
<param name="writer">The writer to write to.</param>
<param name="value">The value to convert to JSON.</param>
<param name="options">An object that specifies serialization options to use.</param>
</member>
<member name="M:Json.More.EnumStringConverter`1.WriteAsPropertyName(System.Text.Json.Utf8JsonWriter,`0,System.Text.Json.JsonSerializerOptions)">
<summary>Writes a dictionary key as a JSON property name.</summary>
<param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write to.</param>
<param name="value">The value to convert. The value of <see cref="P:System.Text.Json.Serialization.JsonConverter`1.HandleNull" /> determines if the converter handles <see langword="null" /> values.</param>
<param name="options">The options to use when writing the value.</param>
</member>
<member name="T:Json.More.JsonDocumentEqualityComparer">
<summary>
Calculates equality between two <see cref="T:System.Text.Json.JsonDocument"/>s.
</summary>
<remarks>
This comparison is compliant with the ideals expressed by JSON:
- Objects are unordered.
- Arrays are ordered.
</remarks>
</member>
<member name="P:Json.More.JsonDocumentEqualityComparer.Instance">
<summary>
A singleton instance for convenience.
</summary>
</member>
<member name="M:Json.More.JsonDocumentEqualityComparer.Equals(System.Text.Json.JsonDocument,System.Text.Json.JsonDocument)">
<summary>Determines whether the specified objects are equal.</summary>
<param name="x">The first object of type T to compare.</param>
<param name="y">The second object of type T to compare.</param>
<returns>true if the specified objects are equal; otherwise, false.</returns>
</member>
<member name="M:Json.More.JsonDocumentEqualityComparer.GetHashCode(System.Text.Json.JsonDocument)">
<summary>Returns a hash code for the specified object.</summary>
<param name="obj">The <see cref="T:System.Object"></see> for which a hash code is to be returned.</param>
<returns>A hash code for the specified object.</returns>
<exception cref="T:System.ArgumentNullException">The type of <paramref name="obj">obj</paramref> is a reference type and <paramref name="obj">obj</paramref> is null.</exception>
</member>
<member name="T:Json.More.JsonDocumentExtensions">
<summary>
Provides extension functionality for <see cref="T:System.Text.Json.JsonDocument"/>.
</summary>
</member>
<member name="M:Json.More.JsonDocumentExtensions.IsEquivalentTo(System.Text.Json.JsonDocument,System.Text.Json.JsonDocument)">
<summary>
Determines JSON-compatible equivalence.
</summary>
<param name="a">The first document.</param>
<param name="b">The second document.</param>
<returns>`true` if the documents are equivalent; `false` otherwise.</returns>
</member>
<member name="M:Json.More.JsonDocumentExtensions.ToJsonDocument``1(``0,System.Text.Json.JsonSerializerOptions)">
<summary>
Converts an object to a <see cref="T:System.Text.Json.JsonDocument"/>.
</summary>
<typeparam name="T">The type of the object.</typeparam>
<param name="value">The value to convert.</param>
<param name="options">(optional) JSON serialization options.</param>
<returns>A <see cref="T:System.Text.Json.JsonDocument"/> representing the vale.</returns>
</member>
<member name="T:Json.More.JsonElementEqualityComparer">
<summary>
Calculates equality between two <see cref="T:System.Text.Json.JsonElement"/>s.
</summary>
<remarks>
This comparison is compliant with the ideals expressed by JSON:
- Objects are unordered.
- Arrays are ordered.
</remarks>
</member>
<member name="P:Json.More.JsonElementEqualityComparer.Instance">
<summary>
A singleton instance for convenience.
</summary>
</member>
<member name="M:Json.More.JsonElementEqualityComparer.Equals(System.Text.Json.JsonElement,System.Text.Json.JsonElement)">
<summary>Determines whether the specified objects are equal.</summary>
<param name="x">The first object of type T to compare.</param>
<param name="y">The second object of type T to compare.</param>
<returns>true if the specified objects are equal; otherwise, false.</returns>
</member>
<member name="M:Json.More.JsonElementEqualityComparer.GetHashCode(System.Text.Json.JsonElement)">
<summary>Returns a hash code for the specified object.</summary>
<param name="obj">The <see cref="T:System.Object"></see> for which a hash code is to be returned.</param>
<returns>A hash code for the specified object.</returns>
<exception cref="T:System.ArgumentNullException">The type of <paramref name="obj">obj</paramref> is a reference type and <paramref name="obj">obj</paramref> is null.</exception>
</member>
<member name="T:Json.More.JsonElementExtensions">
<summary>
Provides extension functionality for <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
</member>
<member name="M:Json.More.JsonElementExtensions.IsEquivalentTo(System.Text.Json.JsonElement,System.Text.Json.JsonElement)">
<summary>
Determines JSON-compatible equivalence.
</summary>
<param name="a">The first element.</param>
<param name="b">The second element.</param>
<returns>`true` if the element are equivalent; `false` otherwise.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.Text.Json.JsonElement.ValueKind"/> is not valid.</exception>
</member>
<member name="M:Json.More.JsonElementExtensions.GetEquivalenceHashCode(System.Text.Json.JsonElement,System.Int32)">
<summary>
Generate a consistent JSON-value-based hash code for the element.
</summary>
<param name="element">The element.</param>
<param name="maxHashDepth">Maximum depth to calculate. Default is -1 which utilizes the entire structure without limitation.</param>
<returns>The hash code.</returns>
<remarks>
See the following for discussion on why the default implementation is insufficient:
- https://github.com/gregsdennis/json-everything/issues/76
- https://github.com/dotnet/runtime/issues/33388
</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.ToJsonString(System.Text.Json.JsonElement)">
<summary>
Just a shortcut for calling `JsonSerializer.Serialize()` because `.ToString()` doesn't do what you might expect.
</summary>
<param name="element">The value to convert.</param>
<returns>A JSON string.</returns>
<remarks>
See https://github.com/dotnet/runtime/issues/42502
</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Int64)">
<summary>
Converts a <see cref="T:System.Int64"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="value">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Int32)">
<summary>
Converts a <see cref="T:System.Int32"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="value">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Int16)">
<summary>
Converts a <see cref="T:System.Int16"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="value">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Boolean)">
<summary>
Converts a <see cref="T:System.Boolean"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="value">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Decimal)">
<summary>
Converts a <see cref="T:System.Int64"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="value">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Double)">
<summary>
Converts a <see cref="T:System.Double"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="value">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Single)">
<summary>
Converts a <see cref="T:System.Single"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="value">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.String)">
<summary>
Converts a <see cref="T:System.String"/> to a <see cref="T:System.Text.Json.JsonElement"/>. Can also be used to get a `null` element.
</summary>
<param name="value">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Collections.Generic.IEnumerable{System.Text.Json.JsonElement})">
<summary>
Converts a <see cref="T:System.Int64"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="values">The array of values to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsJsonElement(System.Collections.Generic.IDictionary{System.String,System.Text.Json.JsonElement})">
<summary>
Converts a <see cref="T:System.Int64"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="values">The value to convert.</param>
<returns>A <see cref="T:System.Text.Json.JsonElement"/> representing the value.</returns>
<remarks>This is a workaround for lack of native support in the System.Text.Json namespace.</remarks>
</member>
<member name="M:Json.More.JsonElementExtensions.AsNode(System.Text.Json.JsonElement)">
<summary>
Converts a <see cref="T:System.Text.Json.JsonElement"/> to a <see cref="T:System.Text.Json.Nodes.JsonNode"/>.
</summary>
<param name="element">The element.</param>
<returns>An equivalent node.</returns>
<remarks>
This provides a single point of conversion as one is not provided by .Net.
See https://github.com/dotnet/runtime/issues/70427 for more information.
</remarks>
</member>
<member name="T:Json.More.JsonElementProxy">
<summary>
Acts as an intermediary that allows an "implicit casting"-like behavior between
native JSON types and <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(System.Int32)~Json.More.JsonElementProxy">
<summary>
Converts an `int` to a <see cref="T:Json.More.JsonElementProxy"/>.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(System.Int64)~Json.More.JsonElementProxy">
<summary>
Converts an `long` to a <see cref="T:Json.More.JsonElementProxy"/>.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(System.Int16)~Json.More.JsonElementProxy">
<summary>
Converts an `short` to a <see cref="T:Json.More.JsonElementProxy"/>.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(System.Single)~Json.More.JsonElementProxy">
<summary>
Converts an `float` to a <see cref="T:Json.More.JsonElementProxy"/>.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(System.Double)~Json.More.JsonElementProxy">
<summary>
Converts an `double` to a <see cref="T:Json.More.JsonElementProxy"/>.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(System.Decimal)~Json.More.JsonElementProxy">
<summary>
Converts an `decimal` to a <see cref="T:Json.More.JsonElementProxy"/>.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(System.String)~Json.More.JsonElementProxy">
<summary>
Converts an `string` to a <see cref="T:Json.More.JsonElementProxy"/>.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(System.Boolean)~Json.More.JsonElementProxy">
<summary>
Converts an `bool` to a <see cref="T:Json.More.JsonElementProxy"/>.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Json.More.JsonElementProxy.op_Implicit(Json.More.JsonElementProxy)~System.Text.Json.JsonElement">
<summary>
Converts a <see cref="T:Json.More.JsonElementProxy"/> to a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="proxy">The proxy.</param>
</member>
<member name="T:Json.More.JsonNodeEqualityComparer">
<summary>
Calculates equality between two <see cref="T:System.Text.Json.JsonElement"/>s.
</summary>
<remarks>
This comparison is compliant with the ideals expressed by JSON:
- Objects are unordered.
- Arrays are ordered.
</remarks>
</member>
<member name="P:Json.More.JsonNodeEqualityComparer.Instance">
<summary>
A singleton instance for convenience.
</summary>
</member>
<member name="M:Json.More.JsonNodeEqualityComparer.Equals(System.Text.Json.Nodes.JsonNode,System.Text.Json.Nodes.JsonNode)">
<summary>Determines whether the specified objects are equal.</summary>
<param name="x">The first object of type T to compare.</param>
<param name="y">The second object of type T to compare.</param>
<returns>true if the specified objects are equal; otherwise, false.</returns>
</member>
<member name="M:Json.More.JsonNodeEqualityComparer.GetHashCode(System.Text.Json.Nodes.JsonNode)">
<summary>Returns a hash code for the specified object.</summary>
<param name="obj">The <see cref="T:System.Object"></see> for which a hash code is to be returned.</param>
<returns>A hash code for the specified object.</returns>
<exception cref="T:System.ArgumentNullException">The type of <paramref name="obj">obj</paramref> is a reference type and <paramref name="obj">obj</paramref> is null.</exception>
</member>
<member name="T:Json.More.JsonNodeExtensions">
<summary>
Provides extension functionality for <see cref="T:System.Text.Json.Nodes.JsonNode"/>.
</summary>
</member>
<member name="M:Json.More.JsonNodeExtensions.IsEquivalentTo(System.Text.Json.Nodes.JsonNode,System.Text.Json.Nodes.JsonNode)">
<summary>
Determines JSON-compatible equivalence.
</summary>
<param name="a">The first element.</param>
<param name="b">The second element.</param>
<returns>`true` if the element are equivalent; `false` otherwise.</returns>
</member>
<member name="M:Json.More.JsonNodeExtensions.GetEquivalenceHashCode(System.Text.Json.Nodes.JsonNode,System.Int32)">
<summary>
Generate a consistent JSON-value-based hash code for the element.
</summary>
<param name="node">The element.</param>
<param name="maxHashDepth">Maximum depth to calculate. Default is -1 which utilizes the entire structure without limitation.</param>
<returns>The hash code.</returns>
<remarks>
See the following for discussion on why the default implementation is insufficient:
- https://github.com/gregsdennis/json-everything/issues/76
- https://github.com/dotnet/runtime/issues/33388
</remarks>
</member>
<member name="M:Json.More.JsonNodeExtensions.AsJsonString(System.Text.Json.Nodes.JsonNode,System.Text.Json.JsonSerializerOptions)">
<summary>
Gets JSON string representation for <see cref="T:System.Text.Json.Nodes.JsonNode"/>, including null support.
</summary>
<param name="node">A node.</param>
<param name="options">Serializer options</param>
<returns>JSON string representation.</returns>
</member>
<member name="M:Json.More.JsonNodeExtensions.GetNumber(System.Text.Json.Nodes.JsonValue)">
<summary>
Gets a node's underlying numeric value.
</summary>
<param name="value">A JSON value.</param>
<returns>Gets the underlying numeric value, or null if the node represented a non-numeric value.</returns>
</member>
<member name="M:Json.More.JsonNodeExtensions.GetInteger(System.Text.Json.Nodes.JsonValue)">
<summary>
Gets a node's underlying numeric value if it's an integer.
</summary>
<param name="value">A JSON value.</param>
<returns>Gets the underlying numeric value if it's an integer, or null if the node represented a non-integer value.</returns>
</member>
<member name="M:Json.More.JsonNodeExtensions.Copy(System.Text.Json.Nodes.JsonNode)">
<summary>
Creates a copy of a node by passing it through the serializer.
</summary>
<param name="source">A node.</param>
<returns>A duplicate of the node.</returns>
<remarks>
`JsonNode` may only be part of a single JSON tree, i.e. have a single parent.
Copying a node allows its value to be saved to another JSON tree.
</remarks>
</member>
<member name="M:Json.More.JsonNodeExtensions.TryGetValue(System.Text.Json.Nodes.JsonObject,System.String,System.Text.Json.Nodes.JsonNode@,System.Exception@)">
<summary>
Convenience method that wraps <see cref="M:System.Text.Json.Nodes.JsonObject.TryGetPropertyValue(System.String,System.Text.Json.Nodes.JsonNode@)"/>
and catches argument exceptions.
</summary>
<param name="obj">The JSON object.</param>
<param name="propertyName">The property name</param>
<param name="node">The node under the property name if it exists and is singular; null otherwise.</param>
<param name="e">An exception if one was thrown during the access attempt.</param>
<returns>true if the property exists and is singular within the JSON data.</returns>
<remarks>
<see cref="M:System.Text.Json.Nodes.JsonObject.TryGetPropertyValue(System.String,System.Text.Json.Nodes.JsonNode@)"/> throws an
<see cref="T:System.ArgumentException"/> if the node was parsed from data that has duplicate
keys. Please see https://github.com/dotnet/runtime/issues/70604 for more information.
</remarks>
</member>
<member name="M:Json.More.JsonNodeExtensions.ToJsonArray(System.Collections.Generic.IEnumerable{System.Text.Json.Nodes.JsonNode})">
<summary>
Creates a new <see cref="T:System.Text.Json.Nodes.JsonArray"/> from an enumerable of nodes.
</summary>
<param name="nodes">The nodes.</param>
<returns>A JSON array.</returns>
</member>
<member name="M:Json.More.JsonNodeExtensions.GetPathFromRoot(System.Text.Json.Nodes.JsonNode,System.Boolean)">
<summary>
Gets a JSON Path string that indicates the node's location within
its JSON structure.
</summary>
<param name="node">The node to find.</param>
<param name="useShorthand">Determines whether shorthand syntax is used when possible, e.g. `$.foo`.</param>
<exception cref="T:System.ArgumentNullException">Null nodes cannot be located as the parent cannot be determined.</exception>
<returns>
A string containing a JSON Path.
</returns>
</member>
<member name="M:Json.More.JsonNodeExtensions.GetPointerFromRoot(System.Text.Json.Nodes.JsonNode)">
<summary>
Gets a JSON Pointer string that indicates the node's location within
its JSON structure.
</summary>
<param name="node">The node to find.</param>
<exception cref="T:System.ArgumentNullException">Null nodes cannot be located as the parent cannot be determined.</exception>
<returns>
A string containing a JSON Pointer.
</returns>
</member>
<member name="T:Json.More.JsonNull">
<summary>
Provides a <see cref="T:System.Text.Json.Nodes.JsonNode"/> instance to use as null.
</summary>
<remarks>
.Net has decided to unify JSON null with .Net null. This decision has a number
of consequences. This value is provided to get around some of these issues.
This class *should not be used as a property value*, but rather as a signal to indicate
that null was explicitly passed rather than a property missing.
See https://github.com/dotnet/runtime/issues/68128 for more information.
</remarks>
</member>
<member name="P:Json.More.JsonNull.SignalNode">
<summary>
Provides a static instance of this class wrapped in a <see cref="T:System.Text.Json.Nodes.JsonNode"/>.
</summary>
</member>
<member name="T:Json.More.JsonSerializerOptionsExtensions">
<summary>
Provides extension functionality for <see cref="T:System.Text.Json.JsonSerializerOptions"/>.
</summary>
</member>
<!-- Badly formed XML comment ignored for member "M:Json.More.JsonSerializerOptionsExtensions.GetConverter``1(System.Text.Json.JsonSerializerOptions)" -->
<member name="M:Json.More.JsonSerializerOptionsExtensions.Read``1(System.Text.Json.JsonSerializerOptions,System.Text.Json.Utf8JsonReader@)">
<summary>
Read and convert the JSON to T.
</summary>
<remarks>
A converter may throw any Exception, but should throw <cref>JsonException</cref> when the JSON is invalid.
</remarks>
<typeparam name="T">The <see cref="T:System.Type"/> to convert.</typeparam>
<param name="options">The <see cref="T:System.Text.Json.JsonSerializerOptions"/> being used.</param>
<param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader"/> to read from.</param>
<returns>The value that was converted.</returns>
</member>
<member name="T:Json.More.TypeExtensions">
<summary>
Provides informative methods for types.
</summary>
</member>
<member name="M:Json.More.TypeExtensions.IsInteger(System.Type)">
<summary>
Determines whether the type is considered an integer.
</summary>
<param name="type">The type.</param>
<returns>true if it represents an integer; false otherwise.</returns>
</member>
<member name="M:Json.More.TypeExtensions.IsFloatingPoint(System.Type)">
<summary>
Determines whether the type is a non-integer floating point number.
</summary>
<param name="type">The type.</param>
<returns>true if it represents a floating-point number; false otherwise.</returns>
</member>
<member name="M:Json.More.TypeExtensions.IsNumber(System.Type)">
<summary>
Determines whether the type is a number.
</summary>
<param name="type">The type.</param>
<returns>true if it represents a number; false otherwise.</returns>
</member>
<member name="T:Json.More.Utf8JsonWriterExtensions">
<summary>
Provides extension functionality for <see cref="T:System.Text.Json.Utf8JsonWriter"/>.
</summary>
</member>
<member name="M:Json.More.Utf8JsonWriterExtensions.WriteValue(System.Text.Json.Utf8JsonWriter,System.Text.Json.JsonElement)">
<summary>
Writes a <see cref="T:System.Text.Json.JsonElement"/> to the stream.
</summary>
<param name="writer">The JSON stream writer.</param>
<param name="element">The element to write.</param>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.Text.Json.JsonElement.ValueKind"/> is not valid.</exception>
</member>
</members>
</doc>

View File

@@ -0,0 +1,5 @@
{
"version": 2,
"contentHash": "mCGQc15lHLp1R2CVhWiipnZurHXm93+LbPPAT/vXQm5PdHt6WQuYLhaEF8VZ+aXL9P2I6bGND6pDTEfqFs6gig==",
"source": "https://api.nuget.org/v3/index.json"
}

Binary file not shown.

View File

@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
<metadata>
<id>JsonPointer.Net</id>
<version>3.0.3</version>
<authors>Greg Dennis</authors>
<license type="file">LICENSE</license>
<licenseUrl>https://aka.ms/deprecateLicenseUrl</licenseUrl>
<icon>json-logo-256.png</icon>
<projectUrl>https://github.com/gregsdennis/json-everything</projectUrl>
<description>[JSON Pointer](https://tools.ietf.org/html/rfc6901) built on the System.Text.Json namespace.
Read the full documentation at https://docs.json-everything.net/pointer/basics/.</description>
<releaseNotes>Release notes can be found at https://docs.json-everything.net/rn-json-pointer/</releaseNotes>
<tags>json-pointer json pointer</tags>
<repository type="git" url="https://github.com/gregsdennis/json-everything" commit="27e320a9fbd3119bd1046ab7063b0cad4c746045" />
<dependencies>
<group targetFramework=".NETStandard2.0">
<dependency id="Json.More.Net" version="1.8.0" exclude="Build,Analyzers" />
</group>
</dependencies>
</metadata>
</package>

View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2022 Greg Dennis
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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

View File

@@ -0,0 +1 @@
06iP664rFlvqSKFb14XWPbBixabRmldIsruIKqvFFdnSNiaVp1AE/vJBnUXc6If5mmj5gj42/ldCklkXGphXzA==

View File

@@ -0,0 +1,392 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>JsonPointer.Net</name>
</assembly>
<members>
<member name="T:Json.Pointer.CharExtensions">
<summary>
Extensions for <seealso cref="T:System.Char"/>.
</summary>
</member>
<member name="M:Json.Pointer.CharExtensions.IsHexadecimal(System.Char)">
<summary>
Determines if the char represents a hexadecimal value.
</summary>
<param name="c">A <see cref="T:System.Char"/>.</param>
<returns>`true` if the character is in the ranges `0-9`, `a-z`, or `A-Z`; `false` otherwise.</returns>
</member>
<member name="M:Json.Pointer.CharExtensions.GetHexadecimalValue(System.Char)">
<summary>
Translates the character to its hexadecimal numeric value.
</summary>
<param name="c">A <see cref="T:System.Char"/>.</param>
<returns>0-9 for `0-9`; 11-15 for `a-f` and `A-F`.</returns>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="c"/> is not a valid hexadecimal character.</exception>
</member>
<member name="T:Json.Pointer.EnumerableExtensions">
<summary>
More extensions on <see cref="T:System.Collections.Generic.IEnumerable`1"/>.
</summary>
</member>
<member name="M:Json.Pointer.EnumerableExtensions.GetCollectionHashCode``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Gets a collection-oriented hash code by combining the hash codes of its elements.
</summary>
<typeparam name="T">The type of element.</typeparam>
<param name="collection">The collection of elements.</param>
<returns>A singular integer value that represents the collection.</returns>
<remarks>This can be used to correctly compare the contents of collections.</remarks>
</member>
<member name="T:Json.Pointer.JsonPointer">
<summary>
Represents a JSON Pointer IAW RFC 6901.
</summary>
</member>
<member name="F:Json.Pointer.JsonPointer.Empty">
<summary>
The empty pointer.
</summary>
</member>
<member name="P:Json.Pointer.JsonPointer.Segments">
<summary>
Gets the collection of pointer segments.
</summary>
</member>
<member name="M:Json.Pointer.JsonPointer.Parse(System.String)">
<summary>
Parses a JSON Pointer from a string.
</summary>
<param name="source">The source string.</param>
<returns>A JSON Pointer.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="source"/> is null.</exception>
<exception cref="T:Json.Pointer.PointerParseException"><paramref name="source"/> does not contain a valid pointer or contains a pointer of the wrong kind.</exception>
</member>
<member name="M:Json.Pointer.JsonPointer.TryParse(System.String,Json.Pointer.JsonPointer@)">
<summary>
Parses a JSON Pointer from a string.
</summary>
<param name="source">The source string.</param>
<param name="pointer">The resulting pointer.</param>
<returns>`true` if the parse was successful; `false` otherwise.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="source"/> is null.</exception>
</member>
<member name="M:Json.Pointer.JsonPointer.Create(Json.Pointer.PointerSegment[])">
<summary>
Creates a new JSON Pointer from a collection of segments.
</summary>
<param name="segments">A collection of segments.</param>
<returns>The JSON Pointer.</returns>
<remarks>This method creates un-encoded pointers only.</remarks>
</member>
<member name="M:Json.Pointer.JsonPointer.Create(System.Collections.Generic.IEnumerable{Json.Pointer.PointerSegment})">
<summary>
Creates a new JSON Pointer from a collection of segments.
</summary>
<param name="segments">A collection of segments.</param>
<returns>The JSON Pointer.</returns>
</member>
<member name="M:Json.Pointer.JsonPointer.Create``1(System.Linq.Expressions.Expression{System.Func{``0,System.Object}})">
<summary>
Generates a JSON Pointer from a lambda expression.
</summary>
<typeparam name="T">The type of the object.</typeparam>
<param name="expression">The lambda expression which gives the pointer path.</param>
<returns>The JSON Pointer.</returns>
<exception cref="T:System.NotSupportedException">
Thrown when the lambda expression contains a node that is not a property access or
<see cref="T:System.Int32"/>-valued indexer.
</exception>
</member>
<member name="M:Json.Pointer.JsonPointer.Combine(Json.Pointer.JsonPointer)">
<summary>
Concatenates a pointer onto the current pointer.
</summary>
<param name="other">Another pointer.</param>
<returns>A new pointer.</returns>
</member>
<member name="M:Json.Pointer.JsonPointer.Combine(Json.Pointer.PointerSegment[])">
<summary>
Concatenates additional segments onto the current pointer.
</summary>
<param name="additionalSegments">The additional segments.</param>
<returns>A new pointer.</returns>
</member>
<member name="M:Json.Pointer.JsonPointer.Evaluate(System.Text.Json.JsonElement)">
<summary>
Evaluates the pointer over a <see cref="T:System.Text.Json.JsonElement"/>.
</summary>
<param name="root">The <see cref="T:System.Text.Json.JsonElement"/>.</param>
<returns>The sub-element at the pointer's location, or null if the path does not exist.</returns>
</member>
<member name="M:Json.Pointer.JsonPointer.TryEvaluate(System.Text.Json.Nodes.JsonNode,System.Text.Json.Nodes.JsonNode@)">
<summary>
Evaluates the pointer over a <see cref="T:System.Text.Json.Nodes.JsonNode"/>.
</summary>
<param name="root">The <see cref="T:System.Text.Json.Nodes.JsonNode"/>.</param>
<param name="result">The result, if return value is true; null otherwise</param>
<returns>true if a value exists at the indicate path; false otherwise.</returns>
</member>
<member name="M:Json.Pointer.JsonPointer.ToString(Json.Pointer.JsonPointerStyle)">
<summary>Returns the string representation of this instance.</summary>
<param name="pointerStyle">Indicates whether to URL-encode the pointer.</param>
<returns>The string representation.</returns>
</member>
<member name="M:Json.Pointer.JsonPointer.ToString">
<summary>Returns the string representation of this instance.</summary>
<returns>The string representation.</returns>
</member>
<member name="M:Json.Pointer.JsonPointer.Equals(Json.Pointer.JsonPointer)">
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
<param name="other">An object to compare with this object.</param>
<returns>true if the current object is equal to the <paramref name="other">other</paramref> parameter; otherwise, false.</returns>
</member>
<member name="M:Json.Pointer.JsonPointer.Equals(System.Object)">
<summary>Indicates whether this instance and a specified object are equal.</summary>
<param name="obj">The object to compare with the current instance.</param>
<returns>true if <paramref name="obj">obj</paramref> and this instance are the same type and represent the same value; otherwise, false.</returns>
</member>
<member name="M:Json.Pointer.JsonPointer.GetHashCode">
<summary>Returns the hash code for this instance.</summary>
<returns>A 32-bit signed integer that is the hash code for this instance.</returns>
</member>
<member name="M:Json.Pointer.JsonPointer.op_Equality(Json.Pointer.JsonPointer,Json.Pointer.JsonPointer)">
<summary>
Evaluates equality via <see cref="M:Json.Pointer.JsonPointer.Equals(Json.Pointer.JsonPointer)"/>.
</summary>
<param name="left">A JSON Pointer.</param>
<param name="right">A JSON Pointer.</param>
<returns>`true` if the pointers are equal; `false` otherwise.</returns>
</member>
<member name="M:Json.Pointer.JsonPointer.op_Inequality(Json.Pointer.JsonPointer,Json.Pointer.JsonPointer)">
<summary>
Evaluates inequality via <see cref="M:Json.Pointer.JsonPointer.Equals(Json.Pointer.JsonPointer)"/>.
</summary>
<param name="left">A JSON Pointer.</param>
<param name="right">A JSON Pointer.</param>
<returns>`false` if the pointers are equal; `true` otherwise.</returns>
</member>
<member name="T:Json.Pointer.JsonPointerStyle">
<summary>
Enumerates the different styles of JSON pointers.
</summary>
</member>
<member name="F:Json.Pointer.JsonPointerStyle.Unspecified">
<summary>
No format specified.
</summary>
</member>
<member name="F:Json.Pointer.JsonPointerStyle.Plain">
<summary>
Indicates only plain JSON pointers.
</summary>
</member>
<member name="F:Json.Pointer.JsonPointerStyle.UriEncoded">
<summary>
Indicates only URI-encoded JSON pointers.
</summary>
</member>
<member name="T:Json.Pointer.PointerParseException">
<summary>
Thrown during parsing when the source string contains invalid JSON Pointer data.
</summary>
</member>
<member name="M:Json.Pointer.PointerParseException.#ctor">
<summary>
Creates a <see cref="T:Json.Pointer.PointerParseException"/>.
</summary>
</member>
<member name="M:Json.Pointer.PointerParseException.#ctor(System.String)">
<summary>
Creates a <see cref="T:Json.Pointer.PointerParseException"/>.
</summary>
</member>
<member name="M:Json.Pointer.PointerParseException.#ctor(System.String,System.Exception)">
<summary>
Creates a <see cref="T:Json.Pointer.PointerParseException"/>.
</summary>
</member>
<member name="T:Json.Pointer.PointerSegment">
<summary>
Represents a single segment of a JSON Pointer.
</summary>
</member>
<member name="P:Json.Pointer.PointerSegment.Value">
<summary>
Gets the segment value.
</summary>
</member>
<member name="M:Json.Pointer.PointerSegment.Parse(System.String)">
<summary>
Parses a JSON Pointer segment from a string.
</summary>
<param name="source">The source string.</param>
<returns>A JSON Pointer segment.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="source"/> is null.</exception>
<exception cref="T:Json.Pointer.PointerParseException"><paramref name="source"/> contains an invalid escape sequence or an invalid URI-encoded sequence or ends with `~`.</exception>
</member>
<member name="M:Json.Pointer.PointerSegment.TryParse(System.String,Json.Pointer.PointerSegment@)">
<summary>
Parses a JSON Pointer segment from a string.
</summary>
<param name="source">The source string.</param>
<param name="segment">The resulting segments.</param>
<returns>`true` if the parse was successful; `false` otherwise.</returns>
</member>
<member name="M:Json.Pointer.PointerSegment.Create(System.String)">
<summary>
Creates a new <see cref="T:Json.Pointer.PointerSegment"/>.
</summary>
<param name="value">The value.</param>
<returns></returns>
</member>
<member name="M:Json.Pointer.PointerSegment.ToString(Json.Pointer.JsonPointerStyle)">
<summary>Returns the string representation of this instance.</summary>
<param name="pointerStyle">Indicates whether to URL-encode the pointer.</param>
<returns>The string representation.</returns>
</member>
<member name="M:Json.Pointer.PointerSegment.Equals(Json.Pointer.PointerSegment)">
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
<param name="other">An object to compare with this object.</param>
<returns>true if the current object is equal to the <paramref name="other">other</paramref> parameter; otherwise, false.</returns>
</member>
<member name="M:Json.Pointer.PointerSegment.Equals(System.Object)">
<summary>Indicates whether this instance and a specified object are equal.</summary>
<param name="obj">The object to compare with the current instance.</param>
<returns>true if <paramref name="obj">obj</paramref> and this instance are the same type and represent the same value; otherwise, false.</returns>
</member>
<member name="M:Json.Pointer.PointerSegment.GetHashCode">
<summary>Returns the hash code for this instance.</summary>
<returns>A 32-bit signed integer that is the hash code for this instance.</returns>
</member>
<member name="M:Json.Pointer.PointerSegment.op_Equality(Json.Pointer.PointerSegment,Json.Pointer.PointerSegment)">
<summary>
Evaluates equality via <see cref="M:Json.Pointer.PointerSegment.Equals(Json.Pointer.PointerSegment)"/>.
</summary>
<param name="left">A JSON Pointer.</param>
<param name="right">A JSON Pointer.</param>
<returns>`true` if the pointers are equal; `false` otherwise.</returns>
</member>
<member name="M:Json.Pointer.PointerSegment.op_Inequality(Json.Pointer.PointerSegment,Json.Pointer.PointerSegment)">
<summary>
Evaluates inequality via <see cref="M:Json.Pointer.PointerSegment.Equals(Json.Pointer.PointerSegment)"/>.
</summary>
<param name="left">A JSON Pointer.</param>
<param name="right">A JSON Pointer.</param>
<returns>`false` if the pointers are equal; `true` otherwise.</returns>
</member>
<member name="M:Json.Pointer.PointerSegment.op_Implicit(System.Int32)~Json.Pointer.PointerSegment">
<summary>
Implicitly casts an <see cref="T:System.UInt32"/> to a <see cref="T:Json.Pointer.PointerSegment"/>.
</summary>
<param name="value">A pointer segment that represents the value.</param>
<remarks>No URI encoding is performed for implicit casts.</remarks>
</member>
<member name="M:Json.Pointer.PointerSegment.op_Implicit(System.UInt32)~Json.Pointer.PointerSegment">
<summary>
Implicitly casts an <see cref="T:System.UInt32"/> to a <see cref="T:Json.Pointer.PointerSegment"/>.
</summary>
<param name="value">A pointer segment that represents the value.</param>
<remarks>No URI encoding is performed for implicit casts.</remarks>
</member>
<member name="M:Json.Pointer.PointerSegment.op_Implicit(System.String)~Json.Pointer.PointerSegment">
<summary>
Implicitly casts a <see cref="T:System.String"/> to a <see cref="T:Json.Pointer.PointerSegment"/>.
</summary>
<param name="value">A pointer segment that represents the value.</param>
<remarks>No URI encoding is performed for implicit casts.</remarks>
</member>
<member name="T:Json.Pointer.RelativeJsonPointer">
<summary>
Represents a Relative JSON Pointer IAW draft-handrews-relative-json-pointer-02
</summary>
</member>
<member name="F:Json.Pointer.RelativeJsonPointer.Null">
<summary>
The null pointer. Indicates no navigation should occur.
</summary>
</member>
<member name="P:Json.Pointer.RelativeJsonPointer.IsIndexQuery">
<summary>
Gets whether the pointer is an index query, which returns the index within the parent rather than the value.
</summary>
</member>
<member name="P:Json.Pointer.RelativeJsonPointer.ParentSteps">
<summary>
Gets the number of parent (root) steps to take.
</summary>
</member>
<member name="P:Json.Pointer.RelativeJsonPointer.ArrayIndexManipulator">
<summary>
Gets the number of lateral steps to take. Applicable only for arrays.
</summary>
</member>
<member name="P:Json.Pointer.RelativeJsonPointer.Pointer">
<summary>
Gets the pointer to follow after taking <see cref="P:Json.Pointer.RelativeJsonPointer.ParentSteps"/> steps upward.
</summary>
</member>
<member name="M:Json.Pointer.RelativeJsonPointer.IndexQuery(System.UInt32)">
<summary>
Creates an index query pointer.
</summary>
<param name="parentSteps"></param>
<returns>A Relative JSON Pointer.</returns>
</member>
<member name="M:Json.Pointer.RelativeJsonPointer.IndexQuery(System.UInt32,System.Int32)">
<summary>
Creates an index query pointer.
</summary>
<param name="parentSteps"></param>
<param name="arrayIndexManipulator">The index manipulator.</param>
<returns>A Relative JSON Pointer.</returns>
</member>
<member name="M:Json.Pointer.RelativeJsonPointer.FromPointer(System.UInt32,Json.Pointer.JsonPointer)">
<summary>
Creates a Relative JSON Pointer from a JSON Pointer and a number of parent steps.
</summary>
<param name="parentSteps">The number of parent steps.</param>
<param name="pointer">The JSON Pointer.</param>
<returns>A Relative JSON Pointer.</returns>
</member>
<member name="M:Json.Pointer.RelativeJsonPointer.FromPointer(System.UInt32,System.Int32,Json.Pointer.JsonPointer)">
<summary>
Creates a Relative JSON Pointer from a JSON Pointer and a number of parent steps.
</summary>
<param name="parentSteps">The number of parent steps.</param>
<param name="arrayIndexManipulator">The index manipulator.</param>
<param name="pointer">The JSON Pointer.</param>
<returns>A Relative JSON Pointer.</returns>
</member>
<member name="M:Json.Pointer.RelativeJsonPointer.Parse(System.String)">
<summary>
Parses a JSON Pointer segment from a string.
</summary>
<param name="source">The source string.</param>
<returns>A Relative JSON Pointer.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="source"/> is null.</exception>
<exception cref="T:Json.Pointer.PointerParseException"><paramref name="source"/> does not contain a valid relative pointer.</exception>
</member>
<member name="M:Json.Pointer.RelativeJsonPointer.TryParse(System.String,Json.Pointer.RelativeJsonPointer@)">
<summary>
Parses a JSON Pointer from a string.
</summary>
<param name="source">The source string.</param>
<param name="relativePointer">The resulting relative pointer.</param>
<returns>`true` if the parse was successful; `false` otherwise.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="source"/> is null.</exception>
</member>
<member name="M:Json.Pointer.RelativeJsonPointer.TryEvaluate(System.Text.Json.Nodes.JsonNode,System.Text.Json.Nodes.JsonNode@)">
<summary>
Evaluates the relative pointer over a <see cref="T:System.Text.Json.Nodes.JsonNode"/>.
</summary>
<param name="node">The <see cref="T:System.Text.Json.Nodes.JsonNode"/>.</param>
<param name="result">The result, if return value is true; null otherwise</param>
<returns>true if a value exists at the indicate path; false otherwise.</returns>
</member>
<member name="M:Json.Pointer.RelativeJsonPointer.ToString">
<summary>Returns the fully qualified type name of this instance.</summary>
<returns>The fully qualified type name.</returns>
</member>
</members>
</doc>

View File

@@ -0,0 +1,5 @@
{
"version": 2,
"contentHash": "XZy99hxNUl99TbV4PEqoCYDJZmgm1VNoFARISfZb9vmIAYbzrEdt8wWBEgDbCWi6A0/kTlf0nXT6YFXDFcx79w==",
"source": "https://api.nuget.org/v3/index.json"
}

Binary file not shown.

View File

@@ -0,0 +1,24 @@
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
<metadata minClientVersion="2.12">
<id>JsonSchema.Net</id>
<version>5.3.0</version>
<authors>Greg Dennis</authors>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<license type="expression">MIT</license>
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
<icon>json-logo-256.png</icon>
<projectUrl>https://github.com/gregsdennis/json-everything</projectUrl>
<description>JSON Schema built on the System.Text.Json namespace.</description>
<releaseNotes>Release notes can be found at https://json-everything.net/json-schema</releaseNotes>
<tags>json-schema validation schema json</tags>
<repository type="git" url="https://github.com/gregsdennis/json-everything" />
<dependencies>
<group targetFramework=".NETStandard2.0">
<dependency id="Json.More.Net" version="1.9.0" exclude="Build,Analyzers" />
<dependency id="JsonPointer.Net" version="3.0.3" exclude="Build,Analyzers" />
<dependency id="JetBrains.Annotations" version="2021.2.0" exclude="Build,Analyzers" />
</group>
</dependencies>
</metadata>
</package>

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

View File

@@ -0,0 +1 @@
pFJnvHzzDDFvhyDLLDGbKyn6uNLA1PhJ46Ufkwzr9uukmXWgLyiXIs81UUw/ZQ5pDfKUZmz/4LMUrg2/KjgbJw==

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,5 @@
{
"version": 2,
"contentHash": "T+OAGwzYYXftahpOxO7J4xA5K6urxwGnWQf3M+Jpi+76Azv/0T3M5SuN+h7/QvXuiqNw3ZEZ5QqVLI5ygDAylw==",
"source": "https://api.nuget.org/v3/index.json"
}

View File

@@ -0,0 +1,41 @@
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
<metadata>
<id>Konscious.Security.Cryptography.Argon2</id>
<version>1.3.1</version>
<authors>Keef Aragon</authors>
<license type="expression">MIT</license>
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
<projectUrl>https://github.com/kmaragon/Konscious.Security.Cryptography</projectUrl>
<description>An implementation of Argon2 winner of PHC
https://password-hashing.net/#argon2
Usage follows standard types found in System.Security.Cryptography in corefx. Specifically DeriveBytes.
C# Implementation of the Argon2 1.3 spec with variants for Argon2i, Argon2d, and Argon2id</description>
<copyright>(c) 2024 Keef Aragon</copyright>
<tags>crypto cryptography argon2 argon2i argon2d argon2id password</tags>
<repository type="git" url="https://github.com/kmaragon/Konscious.Security.Cryptography.git" commit="4ed95a5377e411506ca6868409b5c7d7ecaa859b" />
<dependencies>
<group targetFramework=".NETFramework4.6">
<dependency id="Konscious.Security.Cryptography.Blake2" version="1.1.1" exclude="Build,Analyzers" />
<dependency id="System.Memory" version="4.5.4" exclude="Build,Analyzers" />
</group>
<group targetFramework="net6.0">
<dependency id="Konscious.Security.Cryptography.Blake2" version="1.1.1" exclude="Build,Analyzers" />
<dependency id="System.Memory" version="4.5.4" exclude="Build,Analyzers" />
</group>
<group targetFramework="net8.0">
<dependency id="Konscious.Security.Cryptography.Blake2" version="1.1.1" exclude="Build,Analyzers" />
<dependency id="System.Memory" version="4.5.4" exclude="Build,Analyzers" />
</group>
<group targetFramework=".NETStandard1.3">
<dependency id="Konscious.Security.Cryptography.Blake2" version="1.1.1" exclude="Build,Analyzers" />
<dependency id="NETStandard.Library" version="1.6.1" exclude="Build,Analyzers" />
<dependency id="System.IO.UnmanagedMemoryStream" version="4.3.0" exclude="Build,Analyzers" />
<dependency id="System.Memory" version="4.5.4" exclude="Build,Analyzers" />
</group>
</dependencies>
</metadata>
</package>

View File

@@ -0,0 +1 @@
YwEXnb1WCz9O2LgazA5lhR0sYKbExVUu3QWKNskV0WFdLcaooeZdmH2gLY+shAmqWS105/8F5RDbESp5OsdOpw==

View File

@@ -0,0 +1,112 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>Konscious.Security.Cryptography.Argon2</name>
</assembly>
<members>
<member name="T:Konscious.Security.Cryptography.Argon2">
<summary>
An implementation of Argon2 https://github.com/P-H-C/phc-winner-argon2
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2.#ctor(System.Byte[])">
<summary>
Create an Argon2 for encrypting the given password
</summary>
<param name="password"></param>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2.Reset">
<summary>
Implementation of Reset
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2.GetBytes(System.Int32)">
<summary>
Implementation of GetBytes
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2.GetBytesAsync(System.Int32)">
<summary>
Implementation of GetBytes
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.Salt">
<summary>
The password hashing salt
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.KnownSecret">
<summary>
An optional secret to use while hashing the Password
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.AssociatedData">
<summary>
Any extra associated data to use while hashing the password
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.Iterations">
<summary>
The number of iterations to apply to the password hash
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.MemorySize">
<summary>
The number of 1kB memory blocks to use while proessing the hash
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.DegreeOfParallelism">
<summary>
The number of lanes to use while processing the hash
</summary>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2d">
<summary>
An implementation of Argon2 https://github.com/P-H-C/phc-winner-argon2
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2d.#ctor(System.Byte[])">
<summary>
Create an Argon2 for encrypting the given password using Argon2d
</summary>
<param name="password"></param>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2dCore">
<summary>
The implementation of Argon2d for use in the crypto library
</summary>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2i">
<summary>
An implementation of Argon2 https://github.com/P-H-C/phc-winner-argon2
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2i.#ctor(System.Byte[])">
<summary>
Create an Argon2 for encrypting the given password using Argon2i
</summary>
<param name="password"></param>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2iCore">
<summary>
The implementation of Argon2i for use in the crypto library
</summary>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2id">
<summary>
An implementation of Argon2 https://github.com/P-H-C/phc-winner-argon2
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2id.#ctor(System.Byte[])">
<summary>
Create an Argon2 for encrypting the given password using Argon2id
</summary>
<param name="password"></param>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2idCore">
<summary>
The implementation of Argon2d for use in the crypto library
</summary>
</member>
</members>
</doc>

View File

@@ -0,0 +1,112 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>Konscious.Security.Cryptography.Argon2</name>
</assembly>
<members>
<member name="T:Konscious.Security.Cryptography.Argon2">
<summary>
An implementation of Argon2 https://github.com/P-H-C/phc-winner-argon2
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2.#ctor(System.Byte[])">
<summary>
Create an Argon2 for encrypting the given password
</summary>
<param name="password"></param>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2.Reset">
<summary>
Implementation of Reset
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2.GetBytes(System.Int32)">
<summary>
Implementation of GetBytes
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2.GetBytesAsync(System.Int32)">
<summary>
Implementation of GetBytes
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.Salt">
<summary>
The password hashing salt
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.KnownSecret">
<summary>
An optional secret to use while hashing the Password
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.AssociatedData">
<summary>
Any extra associated data to use while hashing the password
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.Iterations">
<summary>
The number of iterations to apply to the password hash
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.MemorySize">
<summary>
The number of 1kB memory blocks to use while proessing the hash
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.DegreeOfParallelism">
<summary>
The number of lanes to use while processing the hash
</summary>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2d">
<summary>
An implementation of Argon2 https://github.com/P-H-C/phc-winner-argon2
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2d.#ctor(System.Byte[])">
<summary>
Create an Argon2 for encrypting the given password using Argon2d
</summary>
<param name="password"></param>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2dCore">
<summary>
The implementation of Argon2d for use in the crypto library
</summary>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2i">
<summary>
An implementation of Argon2 https://github.com/P-H-C/phc-winner-argon2
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2i.#ctor(System.Byte[])">
<summary>
Create an Argon2 for encrypting the given password using Argon2i
</summary>
<param name="password"></param>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2iCore">
<summary>
The implementation of Argon2i for use in the crypto library
</summary>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2id">
<summary>
An implementation of Argon2 https://github.com/P-H-C/phc-winner-argon2
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2id.#ctor(System.Byte[])">
<summary>
Create an Argon2 for encrypting the given password using Argon2id
</summary>
<param name="password"></param>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2idCore">
<summary>
The implementation of Argon2d for use in the crypto library
</summary>
</member>
</members>
</doc>

View File

@@ -0,0 +1,112 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>Konscious.Security.Cryptography.Argon2</name>
</assembly>
<members>
<member name="T:Konscious.Security.Cryptography.Argon2">
<summary>
An implementation of Argon2 https://github.com/P-H-C/phc-winner-argon2
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2.#ctor(System.Byte[])">
<summary>
Create an Argon2 for encrypting the given password
</summary>
<param name="password"></param>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2.Reset">
<summary>
Implementation of Reset
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2.GetBytes(System.Int32)">
<summary>
Implementation of GetBytes
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2.GetBytesAsync(System.Int32)">
<summary>
Implementation of GetBytes
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.Salt">
<summary>
The password hashing salt
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.KnownSecret">
<summary>
An optional secret to use while hashing the Password
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.AssociatedData">
<summary>
Any extra associated data to use while hashing the password
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.Iterations">
<summary>
The number of iterations to apply to the password hash
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.MemorySize">
<summary>
The number of 1kB memory blocks to use while proessing the hash
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.DegreeOfParallelism">
<summary>
The number of lanes to use while processing the hash
</summary>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2d">
<summary>
An implementation of Argon2 https://github.com/P-H-C/phc-winner-argon2
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2d.#ctor(System.Byte[])">
<summary>
Create an Argon2 for encrypting the given password using Argon2d
</summary>
<param name="password"></param>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2dCore">
<summary>
The implementation of Argon2d for use in the crypto library
</summary>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2i">
<summary>
An implementation of Argon2 https://github.com/P-H-C/phc-winner-argon2
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2i.#ctor(System.Byte[])">
<summary>
Create an Argon2 for encrypting the given password using Argon2i
</summary>
<param name="password"></param>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2iCore">
<summary>
The implementation of Argon2i for use in the crypto library
</summary>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2id">
<summary>
An implementation of Argon2 https://github.com/P-H-C/phc-winner-argon2
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2id.#ctor(System.Byte[])">
<summary>
Create an Argon2 for encrypting the given password using Argon2id
</summary>
<param name="password"></param>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2idCore">
<summary>
The implementation of Argon2d for use in the crypto library
</summary>
</member>
</members>
</doc>

View File

@@ -0,0 +1,112 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>Konscious.Security.Cryptography.Argon2</name>
</assembly>
<members>
<member name="T:Konscious.Security.Cryptography.Argon2">
<summary>
An implementation of Argon2 https://github.com/P-H-C/phc-winner-argon2
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2.#ctor(System.Byte[])">
<summary>
Create an Argon2 for encrypting the given password
</summary>
<param name="password"></param>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2.Reset">
<summary>
Implementation of Reset
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2.GetBytes(System.Int32)">
<summary>
Implementation of GetBytes
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2.GetBytesAsync(System.Int32)">
<summary>
Implementation of GetBytes
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.Salt">
<summary>
The password hashing salt
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.KnownSecret">
<summary>
An optional secret to use while hashing the Password
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.AssociatedData">
<summary>
Any extra associated data to use while hashing the password
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.Iterations">
<summary>
The number of iterations to apply to the password hash
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.MemorySize">
<summary>
The number of 1kB memory blocks to use while proessing the hash
</summary>
</member>
<member name="P:Konscious.Security.Cryptography.Argon2.DegreeOfParallelism">
<summary>
The number of lanes to use while processing the hash
</summary>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2d">
<summary>
An implementation of Argon2 https://github.com/P-H-C/phc-winner-argon2
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2d.#ctor(System.Byte[])">
<summary>
Create an Argon2 for encrypting the given password using Argon2d
</summary>
<param name="password"></param>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2dCore">
<summary>
The implementation of Argon2d for use in the crypto library
</summary>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2i">
<summary>
An implementation of Argon2 https://github.com/P-H-C/phc-winner-argon2
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2i.#ctor(System.Byte[])">
<summary>
Create an Argon2 for encrypting the given password using Argon2i
</summary>
<param name="password"></param>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2iCore">
<summary>
The implementation of Argon2i for use in the crypto library
</summary>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2id">
<summary>
An implementation of Argon2 https://github.com/P-H-C/phc-winner-argon2
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.Argon2id.#ctor(System.Byte[])">
<summary>
Create an Argon2 for encrypting the given password using Argon2id
</summary>
<param name="password"></param>
</member>
<member name="T:Konscious.Security.Cryptography.Argon2idCore">
<summary>
The implementation of Argon2d for use in the crypto library
</summary>
</member>
</members>
</doc>

View File

@@ -0,0 +1,5 @@
{
"version": 2,
"contentHash": "odwOyzj/J/lHJZNwFWJGU/LRecBShupAJ2S8TQqZfhUe9niHzu/voBYK5wuVKsvSpzbfupKQYZguVyIk1sgOkQ==",
"source": "https://api.nuget.org/v3/index.json"
}

View File

@@ -0,0 +1,31 @@
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
<metadata>
<id>Konscious.Security.Cryptography.Blake2</id>
<version>1.1.1</version>
<authors>Keef Aragon</authors>
<license type="expression">MIT</license>
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
<projectUrl>https://github.com/kmaragon/Konscious.Security.Cryptography</projectUrl>
<description>An implementation of Blake2 for .NET that integrates with the standard crypto libraries</description>
<copyright>(c) 2024 Keef Aragon</copyright>
<tags>crypto cryptography hash blake2 blake2b</tags>
<repository type="git" url="https://github.com/kmaragon/Konscious.Security.Cryptography.git" commit="4ed95a5377e411506ca6868409b5c7d7ecaa859b" />
<dependencies>
<group targetFramework=".NETFramework4.6">
<dependency id="System.Numerics.Vectors" version="4.5.0" exclude="Build,Analyzers" />
</group>
<group targetFramework="net6.0" />
<group targetFramework="net8.0" />
<group targetFramework=".NETStandard1.3">
<dependency id="NETStandard.Library" version="1.6.1" exclude="Build,Analyzers" />
<dependency id="System.Numerics.Vectors" version="4.5.0" exclude="Build,Analyzers" />
<dependency id="System.Security.Cryptography.Algorithms" version="4.3.1" exclude="Build,Analyzers" />
</group>
</dependencies>
<frameworkAssemblies>
<frameworkAssembly assemblyName="Microsoft.CSharp" targetFramework=".NETFramework4.6" />
<frameworkAssembly assemblyName="System" targetFramework=".NETFramework4.6" />
</frameworkAssemblies>
</metadata>
</package>

View File

@@ -0,0 +1 @@
sFrz0Yn0dIuwaA/EA/npTvG+Z4CFmVzf4SWY/X0H2COBvjAc5O969tdujmSPieQw/E5+BWOmnKqghwp9lE/Ylw==

View File

@@ -0,0 +1,56 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>Konscious.Security.Cryptography.Blake2</name>
</assembly>
<members>
<member name="T:Konscious.Security.Cryptography.HMACBlake2B">
<summary>
An implementation of Blake2b HMAC per RFC-7693
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.#ctor(System.Int32)">
<summary>
Construct an HMACBlake2B without a key
</summary>
<param name="hashSize">the hash size in bits</param>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.#ctor(System.Byte[],System.Int32)">
<summary>
Construct an HMACBlake2B
</summary>
<param name="keyData">The key for the HMAC</param>
<param name="hashSize">The hash size in bits</param>
</member>
<member name="P:Konscious.Security.Cryptography.HMACBlake2B.HashSize">
<summary>
Implementation of HashSize <seealso cref="T:System.Security.Cryptography.HashAlgorithm"/>
</summary>
<returns>The hash</returns>
</member>
<member name="P:Konscious.Security.Cryptography.HMACBlake2B.Key">
<summary>
Overridden key to enforce size
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.Initialize">
<summary>
Implementation of Initialize - initializes the HMAC buffer
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.HashCore(System.Byte[],System.Int32,System.Int32)">
<summary>
Implementation of HashCore
</summary>
<param name="data">The data to hash</param>
<param name="offset">The offset to start hashing from</param>
<param name="size">The amount of data in the hash to consume</param>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.HashFinal">
<summary>
Finish hashing and return the final hash
</summary>
<returns>The final hash from HashCore</returns>
</member>
</members>
</doc>

View File

@@ -0,0 +1,56 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>Konscious.Security.Cryptography.Blake2</name>
</assembly>
<members>
<member name="T:Konscious.Security.Cryptography.HMACBlake2B">
<summary>
An implementation of Blake2b HMAC per RFC-7693
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.#ctor(System.Int32)">
<summary>
Construct an HMACBlake2B without a key
</summary>
<param name="hashSize">the hash size in bits</param>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.#ctor(System.Byte[],System.Int32)">
<summary>
Construct an HMACBlake2B
</summary>
<param name="keyData">The key for the HMAC</param>
<param name="hashSize">The hash size in bits</param>
</member>
<member name="P:Konscious.Security.Cryptography.HMACBlake2B.HashSize">
<summary>
Implementation of HashSize <seealso cref="T:System.Security.Cryptography.HashAlgorithm"/>
</summary>
<returns>The hash</returns>
</member>
<member name="P:Konscious.Security.Cryptography.HMACBlake2B.Key">
<summary>
Overridden key to enforce size
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.Initialize">
<summary>
Implementation of Initialize - initializes the HMAC buffer
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.HashCore(System.Byte[],System.Int32,System.Int32)">
<summary>
Implementation of HashCore
</summary>
<param name="data">The data to hash</param>
<param name="offset">The offset to start hashing from</param>
<param name="size">The amount of data in the hash to consume</param>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.HashFinal">
<summary>
Finish hashing and return the final hash
</summary>
<returns>The final hash from HashCore</returns>
</member>
</members>
</doc>

View File

@@ -0,0 +1,56 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>Konscious.Security.Cryptography.Blake2</name>
</assembly>
<members>
<member name="T:Konscious.Security.Cryptography.HMACBlake2B">
<summary>
An implementation of Blake2b HMAC per RFC-7693
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.#ctor(System.Int32)">
<summary>
Construct an HMACBlake2B without a key
</summary>
<param name="hashSize">the hash size in bits</param>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.#ctor(System.Byte[],System.Int32)">
<summary>
Construct an HMACBlake2B
</summary>
<param name="keyData">The key for the HMAC</param>
<param name="hashSize">The hash size in bits</param>
</member>
<member name="P:Konscious.Security.Cryptography.HMACBlake2B.HashSize">
<summary>
Implementation of HashSize <seealso cref="T:System.Security.Cryptography.HashAlgorithm"/>
</summary>
<returns>The hash</returns>
</member>
<member name="P:Konscious.Security.Cryptography.HMACBlake2B.Key">
<summary>
Overridden key to enforce size
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.Initialize">
<summary>
Implementation of Initialize - initializes the HMAC buffer
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.HashCore(System.Byte[],System.Int32,System.Int32)">
<summary>
Implementation of HashCore
</summary>
<param name="data">The data to hash</param>
<param name="offset">The offset to start hashing from</param>
<param name="size">The amount of data in the hash to consume</param>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.HashFinal">
<summary>
Finish hashing and return the final hash
</summary>
<returns>The final hash from HashCore</returns>
</member>
</members>
</doc>

View File

@@ -0,0 +1,56 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>Konscious.Security.Cryptography.Blake2</name>
</assembly>
<members>
<member name="T:Konscious.Security.Cryptography.HMACBlake2B">
<summary>
An implementation of Blake2b HMAC per RFC-7693
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.#ctor(System.Int32)">
<summary>
Construct an HMACBlake2B without a key
</summary>
<param name="hashSize">the hash size in bits</param>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.#ctor(System.Byte[],System.Int32)">
<summary>
Construct an HMACBlake2B
</summary>
<param name="keyData">The key for the HMAC</param>
<param name="hashSize">The hash size in bits</param>
</member>
<member name="P:Konscious.Security.Cryptography.HMACBlake2B.HashSize">
<summary>
Implementation of HashSize <seealso cref="T:System.Security.Cryptography.HashAlgorithm"/>
</summary>
<returns>The hash</returns>
</member>
<member name="P:Konscious.Security.Cryptography.HMACBlake2B.Key">
<summary>
Overridden key to enforce size
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.Initialize">
<summary>
Implementation of Initialize - initializes the HMAC buffer
</summary>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.HashCore(System.Byte[],System.Int32,System.Int32)">
<summary>
Implementation of HashCore
</summary>
<param name="data">The data to hash</param>
<param name="offset">The offset to start hashing from</param>
<param name="size">The amount of data in the hash to consume</param>
</member>
<member name="M:Konscious.Security.Cryptography.HMACBlake2B.HashFinal">
<summary>
Finish hashing and return the final hash
</summary>
<returns>The final hash from HashCore</returns>
</member>
</members>
</doc>

View File

@@ -0,0 +1,5 @@
{
"version": 2,
"contentHash": "W8DPQjkMScOMTtJbPwmPyj9c3zYSFGawDW3jwlBOOsnY+EzZFLgNQ/UMkK35JmkNOVPdCyPr2Tw7Vv9N+KA3ZQ==",
"source": "https://api.nuget.org/v3/index.json"
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.8 KiB

View File

@@ -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.

View File

@@ -0,0 +1,41 @@
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
<metadata minClientVersion="2.12">
<id>Microsoft.Bcl.AsyncInterfaces</id>
<version>5.0.0</version>
<title>Microsoft.Bcl.AsyncInterfaces</title>
<authors>Microsoft</authors>
<owners>microsoft,dotnetframework</owners>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<license type="expression">MIT</license>
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
<icon>Icon.png</icon>
<projectUrl>https://github.com/dotnet/runtime</projectUrl>
<iconUrl>http://go.microsoft.com/fwlink/?LinkID=288859</iconUrl>
<description>Provides the IAsyncEnumerable&lt;T&gt; and IAsyncDisposable interfaces and helper types for .NET Standard 2.0. This package is not required starting with .NET Standard 2.1 and .NET Core 3.0.
Commonly Used Types:
System.IAsyncDisposable
System.Collections.Generic.IAsyncEnumerable
System.Collections.Generic.IAsyncEnumerator
When using NuGet 3.x this package requires at least version 3.4.</description>
<releaseNotes>https://go.microsoft.com/fwlink/?LinkID=799421</releaseNotes>
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
<serviceable>true</serviceable>
<repository type="git" url="git://github.com/dotnet/runtime" commit="cf258a14b70ad9069470a108f13765e0e5988f51" />
<dependencies>
<group targetFramework=".NETFramework4.6.1">
<dependency id="System.Threading.Tasks.Extensions" version="4.5.4" />
</group>
<group targetFramework=".NETCoreApp2.1" />
<group targetFramework=".NETStandard2.0">
<dependency id="System.Threading.Tasks.Extensions" version="4.5.4" />
</group>
<group targetFramework=".NETStandard2.1" />
</dependencies>
<frameworkAssemblies>
<frameworkAssembly assemblyName="mscorlib" targetFramework=".NETFramework4.6.1" />
</frameworkAssemblies>
</metadata>
</package>

View File

@@ -0,0 +1,884 @@
.NET Runtime uses third-party libraries or other resources that may be
distributed under licenses different than the .NET Runtime software.
In the event that we accidentally failed to list a required notice, please
bring it to our attention. Post an issue or email us:
dotnet@microsoft.com
The attached notices are provided for information only.
License notice for ASP.NET
-------------------------------
Copyright (c) .NET Foundation. All rights reserved.
Licensed under the Apache License, Version 2.0.
Available at
https://github.com/aspnet/AspNetCore/blob/master/LICENSE.txt
License notice for Slicing-by-8
-------------------------------
http://sourceforge.net/projects/slicing-by-8/
Copyright (c) 2004-2006 Intel Corporation - All Rights Reserved
This software program is licensed subject to the BSD License, available at
http://www.opensource.org/licenses/bsd-license.html.
License notice for Unicode data
-------------------------------
https://www.unicode.org/license.html
Copyright © 1991-2020 Unicode, Inc. All rights reserved.
Distributed under the Terms of Use in https://www.unicode.org/copyright.html.
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Unicode data files and any associated documentation
(the "Data Files") or Unicode software and any associated documentation
(the "Software") to deal in the Data Files or Software
without restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, and/or sell copies of
the Data Files or Software, and to permit persons to whom the Data Files
or Software are furnished to do so, provided that either
(a) this copyright and permission notice appear with all copies
of the Data Files or Software, or
(b) this copyright and permission notice appear in associated
Documentation.
THE DATA FILES AND SOFTWARE ARE 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 OF THIRD PARTY RIGHTS.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS
NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL
DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THE DATA FILES OR SOFTWARE.
Except as contained in this notice, the name of a copyright holder
shall not be used in advertising or otherwise to promote the sale,
use or other dealings in these Data Files or Software without prior
written authorization of the copyright holder.
License notice for Zlib
-----------------------
https://github.com/madler/zlib
http://zlib.net/zlib_license.html
/* zlib.h -- interface of the 'zlib' general purpose compression library
version 1.2.11, January 15th, 2017
Copyright (C) 1995-2017 Jean-loup Gailly and Mark Adler
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
Jean-loup Gailly Mark Adler
jloup@gzip.org madler@alumni.caltech.edu
*/
License notice for Mono
-------------------------------
http://www.mono-project.com/docs/about-mono/
Copyright (c) .NET Foundation Contributors
MIT License
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.
License notice for International Organization for Standardization
-----------------------------------------------------------------
Portions (C) International Organization for Standardization 1986:
Permission to copy in any form is granted for use with
conforming SGML systems and applications as defined in
ISO 8879, provided this notice is included in all copies.
License notice for Intel
------------------------
"Copyright (c) 2004-2006 Intel Corporation - All Rights Reserved
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License notice for Xamarin and Novell
-------------------------------------
Copyright (c) 2015 Xamarin, Inc (http://www.xamarin.com)
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.
Copyright (c) 2011 Novell, Inc (http://www.novell.com)
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.
Third party notice for W3C
--------------------------
"W3C SOFTWARE AND DOCUMENT NOTICE AND LICENSE
Status: This license takes effect 13 May, 2015.
This work is being provided by the copyright holders under the following license.
License
By obtaining and/or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions.
Permission to copy, modify, and distribute this work, with or without modification, for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the work or portions thereof, including modifications:
The full text of this NOTICE in a location viewable to users of the redistributed or derivative work.
Any pre-existing intellectual property disclaimers, notices, or terms and conditions. If none exist, the W3C Software and Document Short Notice should be included.
Notice of any changes or modifications, through a copyright statement on the new code or document such as "This software or document includes material copied from or derived from [title and URI of the W3C document]. Copyright © [YEAR] W3C® (MIT, ERCIM, Keio, Beihang)."
Disclaimers
THIS WORK IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENT WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENT.
The name and trademarks of copyright holders may NOT be used in advertising or publicity pertaining to the work without specific, written prior permission. Title to copyright in this work will at all times remain with copyright holders."
License notice for Bit Twiddling Hacks
--------------------------------------
Bit Twiddling Hacks
By Sean Eron Anderson
seander@cs.stanford.edu
Individually, the code snippets here are in the public domain (unless otherwise
noted) — feel free to use them however you please. The aggregate collection and
descriptions are © 1997-2005 Sean Eron Anderson. The code and descriptions are
distributed in the hope that they will be useful, but WITHOUT ANY WARRANTY and
without even the implied warranty of merchantability or fitness for a particular
purpose.
License notice for Brotli
--------------------------------------
Copyright (c) 2009, 2010, 2013-2016 by the Brotli Authors.
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.
compress_fragment.c:
Copyright (c) 2011, Google Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
""AS IS"" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
decode_fuzzer.c:
Copyright (c) 2015 The Chromium Authors. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
""AS IS"" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
License notice for Json.NET
-------------------------------
https://github.com/JamesNK/Newtonsoft.Json/blob/master/LICENSE.md
The MIT License (MIT)
Copyright (c) 2007 James Newton-King
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.
License notice for vectorized base64 encoding / decoding
--------------------------------------------------------
Copyright (c) 2005-2007, Nick Galbreath
Copyright (c) 2013-2017, Alfred Klomp
Copyright (c) 2015-2017, Wojciech Mula
Copyright (c) 2016-2017, Matthieu Darbois
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
- Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License notice for RFC 3492
---------------------------
The punycode implementation is based on the sample code in RFC 3492
Copyright (C) The Internet Society (2003). All Rights Reserved.
This document and translations of it may be copied and furnished to
others, and derivative works that comment on or otherwise explain it
or assist in its implementation may be prepared, copied, published
and distributed, in whole or in part, without restriction of any
kind, provided that the above copyright notice and this paragraph are
included on all such copies and derivative works. However, this
document itself may not be modified in any way, such as by removing
the copyright notice or references to the Internet Society or other
Internet organizations, except as needed for the purpose of
developing Internet standards in which case the procedures for
copyrights defined in the Internet Standards process must be
followed, or as required to translate it into languages other than
English.
The limited permissions granted above are perpetual and will not be
revoked by the Internet Society or its successors or assigns.
This document and the information contained herein is provided on an
"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
License notice for Algorithm from Internet Draft document "UUIDs and GUIDs"
---------------------------------------------------------------------------
Copyright (c) 1990- 1993, 1996 Open Software Foundation, Inc.
Copyright (c) 1989 by Hewlett-Packard Company, Palo Alto, Ca. &
Digital Equipment Corporation, Maynard, Mass.
To anyone who acknowledges that this file is provided "AS IS"
without any express or implied warranty: permission to use, copy,
modify, and distribute this file for any purpose is hereby
granted without fee, provided that the above copyright notices and
this notice appears in all source code copies, and that none of
the names of Open Software Foundation, Inc., Hewlett-Packard
Company, or Digital Equipment Corporation be used in advertising
or publicity pertaining to distribution of the software without
specific, written prior permission. Neither Open Software
Foundation, Inc., Hewlett-Packard Company, Microsoft, nor Digital Equipment
Corporation makes any representations about the suitability of
this software for any purpose.
Copyright(C) The Internet Society 1997. All Rights Reserved.
This document and translations of it may be copied and furnished to others,
and derivative works that comment on or otherwise explain it or assist in
its implementation may be prepared, copied, published and distributed, in
whole or in part, without restriction of any kind, provided that the above
copyright notice and this paragraph are included on all such copies and
derivative works.However, this document itself may not be modified in any
way, such as by removing the copyright notice or references to the Internet
Society or other Internet organizations, except as needed for the purpose of
developing Internet standards in which case the procedures for copyrights
defined in the Internet Standards process must be followed, or as required
to translate it into languages other than English.
The limited permissions granted above are perpetual and will not be revoked
by the Internet Society or its successors or assigns.
This document and the information contained herein is provided on an "AS IS"
basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE
DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY
RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A
PARTICULAR PURPOSE.
License notice for Algorithm from RFC 4122 -
A Universally Unique IDentifier (UUID) URN Namespace
----------------------------------------------------
Copyright (c) 1990- 1993, 1996 Open Software Foundation, Inc.
Copyright (c) 1989 by Hewlett-Packard Company, Palo Alto, Ca. &
Digital Equipment Corporation, Maynard, Mass.
Copyright (c) 1998 Microsoft.
To anyone who acknowledges that this file is provided "AS IS"
without any express or implied warranty: permission to use, copy,
modify, and distribute this file for any purpose is hereby
granted without fee, provided that the above copyright notices and
this notice appears in all source code copies, and that none of
the names of Open Software Foundation, Inc., Hewlett-Packard
Company, Microsoft, or Digital Equipment Corporation be used in
advertising or publicity pertaining to distribution of the software
without specific, written prior permission. Neither Open Software
Foundation, Inc., Hewlett-Packard Company, Microsoft, nor Digital
Equipment Corporation makes any representations about the
suitability of this software for any purpose."
License notice for The LLVM Compiler Infrastructure
---------------------------------------------------
Developed by:
LLVM Team
University of Illinois at Urbana-Champaign
http://llvm.org
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal with
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:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimers.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimers in the
documentation and/or other materials provided with the distribution.
* Neither the names of the LLVM Team, University of Illinois at
Urbana-Champaign, nor the names of its contributors may be used to
endorse or promote products derived from this Software without specific
prior written permission.
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
CONTRIBUTORS 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 WITH THE
SOFTWARE.
License notice for Bob Jenkins
------------------------------
By Bob Jenkins, 1996. bob_jenkins@burtleburtle.net. You may use this
code any way you wish, private, educational, or commercial. It's free.
License notice for Greg Parker
------------------------------
Greg Parker gparker@cs.stanford.edu December 2000
This code is in the public domain and may be copied or modified without
permission.
License notice for libunwind based code
----------------------------------------
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.
License notice for Printing Floating-Point Numbers (Dragon4)
------------------------------------------------------------
/******************************************************************************
Copyright (c) 2014 Ryan Juckett
http://www.ryanjuckett.com/
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source
distribution.
******************************************************************************/
License notice for Printing Floating-point Numbers (Grisu3)
-----------------------------------------------------------
Copyright 2012 the V8 project authors. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License notice for xxHash
-------------------------
xxHash Library
Copyright (c) 2012-2014, Yann Collet
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License notice for Berkeley SoftFloat Release 3e
------------------------------------------------
https://github.com/ucb-bar/berkeley-softfloat-3
https://github.com/ucb-bar/berkeley-softfloat-3/blob/master/COPYING.txt
License for Berkeley SoftFloat Release 3e
John R. Hauser
2018 January 20
The following applies to the whole of SoftFloat Release 3e as well as to
each source file individually.
Copyright 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018 The Regents of the
University of California. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions, and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions, and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS", AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ARE
DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License notice for Xorshift RNGs
--------------------------------
George Marsaglia
2003-07-04
Journal of Statistical Software
License: http://creativecommons.org/licenses/by/3.0/
https://www.jstatsoft.org/article/view/v008i14
https://www.jstatsoft.org/index.php/jss/article/view/v008i14/xorshift.pdf
License notice for Xorshift (Wikipedia)
---------------------------------------
https://en.wikipedia.org/wiki/Xorshift
License: https://en.wikipedia.org/wiki/Wikipedia:Text_of_Creative_Commons_Attribution-ShareAlike_3.0_Unported_License
License for fastmod (https://github.com/lemire/fastmod)
--------------------------------------
Copyright 2018 Daniel Lemire
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
License notice for The C++ REST SDK
-----------------------------------
C++ REST SDK
The MIT License (MIT)
Copyright (c) Microsoft Corporation
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.
License notice for MessagePack-CSharp
-------------------------------------
MessagePack for C#
MIT License
Copyright (c) 2017 Yoshifumi Kawai
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.
License notice for lz4net
-------------------------------------
lz4net
Copyright (c) 2013-2017, Milosz Krajewski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License notice for Nerdbank.Streams
-----------------------------------
The MIT License (MIT)
Copyright (c) Andrew Arnott
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.
License notice for RapidJSON
----------------------------
Tencent is pleased to support the open source community by making RapidJSON available.
Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip. All rights reserved.
Licensed under the MIT License (the "License"); you may not use this file except
in compliance with the License. You may obtain a copy of the License at
http://opensource.org/licenses/MIT
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
License notice for DirectX Math Library
---------------------------------------
https://github.com/microsoft/DirectXMath/blob/master/LICENSE
The MIT License (MIT)
Copyright (c) 2011-2020 Microsoft Corp
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.
License notice for ldap4net
---------------------------
The MIT License (MIT)
Copyright (c) 2018 Alexander Chermyanin
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.
License notice for vectorized sorting code
------------------------------------------
MIT License
Copyright (c) 2020 Dan Shechter
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.

View File

@@ -0,0 +1,223 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.Bcl.AsyncInterfaces</name>
</assembly>
<members>
<member name="T:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1">
<summary>Provides the core logic for implementing a manual-reset <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource"/> or <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource`1"/>.</summary>
<typeparam name="TResult"></typeparam>
</member>
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation">
<summary>
The callback to invoke when the operation completes if <see cref="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)"/> was called before the operation completed,
or <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCoreShared.s_sentinel"/> if the operation completed before a callback was supplied,
or null if a callback hasn't yet been provided and the operation hasn't yet completed.
</summary>
</member>
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuationState">
<summary>State to pass to <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation"/>.</summary>
</member>
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext">
<summary><see cref="T:System.Threading.ExecutionContext"/> to flow to the callback, or null if no flowing is required.</summary>
</member>
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._capturedContext">
<summary>
A "captured" <see cref="T:System.Threading.SynchronizationContext"/> or <see cref="T:System.Threading.Tasks.TaskScheduler"/> with which to invoke the callback,
or null if no special context is required.
</summary>
</member>
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._completed">
<summary>Whether the current operation has completed.</summary>
</member>
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._result">
<summary>The result with which the operation succeeded, or the default value if it hasn't yet completed or failed.</summary>
</member>
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._error">
<summary>The exception with which the operation failed, or null if it hasn't yet completed or completed successfully.</summary>
</member>
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._version">
<summary>The current version of this value, used to help prevent misuse.</summary>
</member>
<member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.RunContinuationsAsynchronously">
<summary>Gets or sets whether to force continuations to run asynchronously.</summary>
<remarks>Continuations may run asynchronously if this is false, but they'll never run synchronously if this is true.</remarks>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Reset">
<summary>Resets to prepare for the next operation.</summary>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetResult(`0)">
<summary>Completes with a successful result.</summary>
<param name="result">The result.</param>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetException(System.Exception)">
<summary>Complets with an error.</summary>
<param name="error"></param>
</member>
<member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Version">
<summary>Gets the operation version.</summary>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetStatus(System.Int16)">
<summary>Gets the status of the operation.</summary>
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetResult(System.Int16)">
<summary>Gets the result of the operation.</summary>
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)">
<summary>Schedules the continuation action for this operation.</summary>
<param name="continuation">The continuation to invoke when the operation has completed.</param>
<param name="state">The state object to pass to <paramref name="continuation"/> when it's invoked.</param>
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
<param name="flags">The flags describing the behavior of the continuation.</param>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.ValidateToken(System.Int16)">
<summary>Ensures that the specified token matches the current version.</summary>
<param name="token">The token supplied by <see cref="T:System.Threading.Tasks.ValueTask"/>.</param>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SignalCompletion">
<summary>Signals that the operation has completed. Invoked after the result or error has been set.</summary>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.InvokeContinuation">
<summary>
Invokes the continuation with the appropriate captured context / scheduler.
This assumes that if <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext"/> is not null we're already
running within that <see cref="T:System.Threading.ExecutionContext"/>.
</summary>
</member>
<member name="T:System.Threading.Tasks.TaskAsyncEnumerableExtensions">
<summary>Provides a set of static methods for configuring <see cref="T:System.Threading.Tasks.Task"/>-related behaviors on asynchronous enumerables and disposables.</summary>
</member>
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait(System.IAsyncDisposable,System.Boolean)">
<summary>Configures how awaits on the tasks returned from an async disposable will be performed.</summary>
<param name="source">The source async disposable.</param>
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
<returns>The configured async disposable.</returns>
</member>
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Boolean)">
<summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
<typeparam name="T">The type of the objects being iterated.</typeparam>
<param name="source">The source enumerable being iterated.</param>
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
<returns>The configured enumerable.</returns>
</member>
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.WithCancellation``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Threading.CancellationToken)">
<summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
<typeparam name="T">The type of the objects being iterated.</typeparam>
<param name="source">The source enumerable being iterated.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
<returns>The configured enumerable.</returns>
</member>
<member name="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder">
<summary>Represents a builder for asynchronous iterators.</summary>
</member>
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Create">
<summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder"/> struct.</summary>
<returns>The initialized instance.</returns>
</member>
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.MoveNext``1(``0@)">
<summary>Invokes <see cref="M:System.Runtime.CompilerServices.IAsyncStateMachine.MoveNext"/> on the state machine while guarding the <see cref="T:System.Threading.ExecutionContext"/>.</summary>
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
<param name="stateMachine">The state machine instance, passed by reference.</param>
</member>
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitOnCompleted``2(``0@,``1@)">
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
<param name="awaiter">The awaiter.</param>
<param name="stateMachine">The state machine.</param>
</member>
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitUnsafeOnCompleted``2(``0@,``1@)">
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
<param name="awaiter">The awaiter.</param>
<param name="stateMachine">The state machine.</param>
</member>
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Complete">
<summary>Marks iteration as being completed, whether successfully or otherwise.</summary>
</member>
<member name="P:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.ObjectIdForDebugger">
<summary>Gets an object that may be used to uniquely identify this builder to the debugger.</summary>
</member>
<member name="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute">
<summary>Indicates whether a method is an asynchronous iterator.</summary>
</member>
<member name="M:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute.#ctor(System.Type)">
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute"/> class.</summary>
<param name="stateMachineType">The type object for the underlying state machine type that's used to implement a state machine method.</param>
</member>
<member name="T:System.Runtime.CompilerServices.ConfiguredAsyncDisposable">
<summary>Provides a type that can be used to configure how awaits on an <see cref="T:System.IAsyncDisposable"/> are performed.</summary>
</member>
<member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1">
<summary>Provides an awaitable async enumerable that enables cancelable iteration and configured awaits.</summary>
</member>
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)">
<summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
<returns>The configured enumerable.</returns>
<remarks>This will replace any previous value set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)"/> for this iteration.</remarks>
</member>
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)">
<summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
<returns>The configured enumerable.</returns>
<remarks>This will replace any previous <see cref="T:System.Threading.CancellationToken"/> set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)"/> for this iteration.</remarks>
</member>
<member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator">
<summary>Provides an awaitable async enumerator that enables cancelable iteration and configured awaits.</summary>
</member>
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.MoveNextAsync">
<summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
<returns>
A <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1"/> that will complete with a result of <c>true</c>
if the enumerator was successfully advanced to the next element, or <c>false</c> if the enumerator has
passed the end of the collection.
</returns>
</member>
<member name="P:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.Current">
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
</member>
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.DisposeAsync">
<summary>
Performs application-defined tasks associated with freeing, releasing, or
resetting unmanaged resources asynchronously.
</summary>
</member>
<member name="T:System.Collections.Generic.IAsyncEnumerable`1">
<summary>Exposes an enumerator that provides asynchronous iteration over values of a specified type.</summary>
<typeparam name="T">The type of values to enumerate.</typeparam>
</member>
<member name="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)">
<summary>Returns an enumerator that iterates asynchronously through the collection.</summary>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that may be used to cancel the asynchronous iteration.</param>
<returns>An enumerator that can be used to iterate asynchronously through the collection.</returns>
</member>
<member name="T:System.Collections.Generic.IAsyncEnumerator`1">
<summary>Supports a simple asynchronous iteration over a generic collection.</summary>
<typeparam name="T">The type of objects to enumerate.</typeparam>
</member>
<member name="M:System.Collections.Generic.IAsyncEnumerator`1.MoveNextAsync">
<summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
<returns>
A <see cref="T:System.Threading.Tasks.ValueTask`1"/> that will complete with a result of <c>true</c> if the enumerator
was successfully advanced to the next element, or <c>false</c> if the enumerator has passed the end
of the collection.
</returns>
</member>
<member name="P:System.Collections.Generic.IAsyncEnumerator`1.Current">
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
</member>
<member name="T:System.IAsyncDisposable">
<summary>Provides a mechanism for releasing unmanaged resources asynchronously.</summary>
</member>
<member name="M:System.IAsyncDisposable.DisposeAsync">
<summary>
Performs application-defined tasks associated with freeing, releasing, or
resetting unmanaged resources asynchronously.
</summary>
</member>
</members>
</doc>

View File

@@ -0,0 +1,223 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.Bcl.AsyncInterfaces</name>
</assembly>
<members>
<member name="T:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1">
<summary>Provides the core logic for implementing a manual-reset <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource"/> or <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource`1"/>.</summary>
<typeparam name="TResult"></typeparam>
</member>
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation">
<summary>
The callback to invoke when the operation completes if <see cref="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)"/> was called before the operation completed,
or <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCoreShared.s_sentinel"/> if the operation completed before a callback was supplied,
or null if a callback hasn't yet been provided and the operation hasn't yet completed.
</summary>
</member>
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuationState">
<summary>State to pass to <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation"/>.</summary>
</member>
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext">
<summary><see cref="T:System.Threading.ExecutionContext"/> to flow to the callback, or null if no flowing is required.</summary>
</member>
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._capturedContext">
<summary>
A "captured" <see cref="T:System.Threading.SynchronizationContext"/> or <see cref="T:System.Threading.Tasks.TaskScheduler"/> with which to invoke the callback,
or null if no special context is required.
</summary>
</member>
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._completed">
<summary>Whether the current operation has completed.</summary>
</member>
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._result">
<summary>The result with which the operation succeeded, or the default value if it hasn't yet completed or failed.</summary>
</member>
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._error">
<summary>The exception with which the operation failed, or null if it hasn't yet completed or completed successfully.</summary>
</member>
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._version">
<summary>The current version of this value, used to help prevent misuse.</summary>
</member>
<member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.RunContinuationsAsynchronously">
<summary>Gets or sets whether to force continuations to run asynchronously.</summary>
<remarks>Continuations may run asynchronously if this is false, but they'll never run synchronously if this is true.</remarks>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Reset">
<summary>Resets to prepare for the next operation.</summary>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetResult(`0)">
<summary>Completes with a successful result.</summary>
<param name="result">The result.</param>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetException(System.Exception)">
<summary>Complets with an error.</summary>
<param name="error"></param>
</member>
<member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Version">
<summary>Gets the operation version.</summary>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetStatus(System.Int16)">
<summary>Gets the status of the operation.</summary>
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetResult(System.Int16)">
<summary>Gets the result of the operation.</summary>
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)">
<summary>Schedules the continuation action for this operation.</summary>
<param name="continuation">The continuation to invoke when the operation has completed.</param>
<param name="state">The state object to pass to <paramref name="continuation"/> when it's invoked.</param>
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
<param name="flags">The flags describing the behavior of the continuation.</param>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.ValidateToken(System.Int16)">
<summary>Ensures that the specified token matches the current version.</summary>
<param name="token">The token supplied by <see cref="T:System.Threading.Tasks.ValueTask"/>.</param>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SignalCompletion">
<summary>Signals that the operation has completed. Invoked after the result or error has been set.</summary>
</member>
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.InvokeContinuation">
<summary>
Invokes the continuation with the appropriate captured context / scheduler.
This assumes that if <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext"/> is not null we're already
running within that <see cref="T:System.Threading.ExecutionContext"/>.
</summary>
</member>
<member name="T:System.Threading.Tasks.TaskAsyncEnumerableExtensions">
<summary>Provides a set of static methods for configuring <see cref="T:System.Threading.Tasks.Task"/>-related behaviors on asynchronous enumerables and disposables.</summary>
</member>
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait(System.IAsyncDisposable,System.Boolean)">
<summary>Configures how awaits on the tasks returned from an async disposable will be performed.</summary>
<param name="source">The source async disposable.</param>
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
<returns>The configured async disposable.</returns>
</member>
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Boolean)">
<summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
<typeparam name="T">The type of the objects being iterated.</typeparam>
<param name="source">The source enumerable being iterated.</param>
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
<returns>The configured enumerable.</returns>
</member>
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.WithCancellation``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Threading.CancellationToken)">
<summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
<typeparam name="T">The type of the objects being iterated.</typeparam>
<param name="source">The source enumerable being iterated.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
<returns>The configured enumerable.</returns>
</member>
<member name="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder">
<summary>Represents a builder for asynchronous iterators.</summary>
</member>
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Create">
<summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder"/> struct.</summary>
<returns>The initialized instance.</returns>
</member>
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.MoveNext``1(``0@)">
<summary>Invokes <see cref="M:System.Runtime.CompilerServices.IAsyncStateMachine.MoveNext"/> on the state machine while guarding the <see cref="T:System.Threading.ExecutionContext"/>.</summary>
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
<param name="stateMachine">The state machine instance, passed by reference.</param>
</member>
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitOnCompleted``2(``0@,``1@)">
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
<param name="awaiter">The awaiter.</param>
<param name="stateMachine">The state machine.</param>
</member>
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitUnsafeOnCompleted``2(``0@,``1@)">
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
<param name="awaiter">The awaiter.</param>
<param name="stateMachine">The state machine.</param>
</member>
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Complete">
<summary>Marks iteration as being completed, whether successfully or otherwise.</summary>
</member>
<member name="P:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.ObjectIdForDebugger">
<summary>Gets an object that may be used to uniquely identify this builder to the debugger.</summary>
</member>
<member name="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute">
<summary>Indicates whether a method is an asynchronous iterator.</summary>
</member>
<member name="M:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute.#ctor(System.Type)">
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute"/> class.</summary>
<param name="stateMachineType">The type object for the underlying state machine type that's used to implement a state machine method.</param>
</member>
<member name="T:System.Runtime.CompilerServices.ConfiguredAsyncDisposable">
<summary>Provides a type that can be used to configure how awaits on an <see cref="T:System.IAsyncDisposable"/> are performed.</summary>
</member>
<member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1">
<summary>Provides an awaitable async enumerable that enables cancelable iteration and configured awaits.</summary>
</member>
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)">
<summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
<returns>The configured enumerable.</returns>
<remarks>This will replace any previous value set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)"/> for this iteration.</remarks>
</member>
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)">
<summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
<returns>The configured enumerable.</returns>
<remarks>This will replace any previous <see cref="T:System.Threading.CancellationToken"/> set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)"/> for this iteration.</remarks>
</member>
<member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator">
<summary>Provides an awaitable async enumerator that enables cancelable iteration and configured awaits.</summary>
</member>
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.MoveNextAsync">
<summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
<returns>
A <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1"/> that will complete with a result of <c>true</c>
if the enumerator was successfully advanced to the next element, or <c>false</c> if the enumerator has
passed the end of the collection.
</returns>
</member>
<member name="P:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.Current">
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
</member>
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.DisposeAsync">
<summary>
Performs application-defined tasks associated with freeing, releasing, or
resetting unmanaged resources asynchronously.
</summary>
</member>
<member name="T:System.Collections.Generic.IAsyncEnumerable`1">
<summary>Exposes an enumerator that provides asynchronous iteration over values of a specified type.</summary>
<typeparam name="T">The type of values to enumerate.</typeparam>
</member>
<member name="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)">
<summary>Returns an enumerator that iterates asynchronously through the collection.</summary>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that may be used to cancel the asynchronous iteration.</param>
<returns>An enumerator that can be used to iterate asynchronously through the collection.</returns>
</member>
<member name="T:System.Collections.Generic.IAsyncEnumerator`1">
<summary>Supports a simple asynchronous iteration over a generic collection.</summary>
<typeparam name="T">The type of objects to enumerate.</typeparam>
</member>
<member name="M:System.Collections.Generic.IAsyncEnumerator`1.MoveNextAsync">
<summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
<returns>
A <see cref="T:System.Threading.Tasks.ValueTask`1"/> that will complete with a result of <c>true</c> if the enumerator
was successfully advanced to the next element, or <c>false</c> if the enumerator has passed the end
of the collection.
</returns>
</member>
<member name="P:System.Collections.Generic.IAsyncEnumerator`1.Current">
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
</member>
<member name="T:System.IAsyncDisposable">
<summary>Provides a mechanism for releasing unmanaged resources asynchronously.</summary>
</member>
<member name="M:System.IAsyncDisposable.DisposeAsync">
<summary>
Performs application-defined tasks associated with freeing, releasing, or
resetting unmanaged resources asynchronously.
</summary>
</member>
</members>
</doc>

View File

@@ -0,0 +1,8 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.Bcl.AsyncInterfaces</name>
</assembly>
<members>
</members>
</doc>

View File

@@ -0,0 +1 @@
zqb+vAPj3db8itMevpL8P3E0+BzB/vj7B57DzXL4oxEg6DbIw5vxYQmr0iU5GTceJGK5Vwov1lJa2d/R+ZKaKA==

View File

@@ -0,0 +1 @@
cf258a14b70ad9069470a108f13765e0e5988f51

View File

@@ -0,0 +1,5 @@
{
"version": 2,
"contentHash": "bZKfSIKJRXLTuSzLudMFte/8CempWjVamNUR5eHJizsy+iuOuO/k2gnh7W0dHJmYY0tBf+gUErfluCv5mySAOQ==",
"source": "https://api.nuget.org/v3/index.json"
}

Some files were not shown because too many files have changed in this diff Show More