add offline packages
This commit is contained in:
master
5
offline/packages/anglesharp/1.1.1/.nupkg.metadata
vendored
Normal file
5
offline/packages/anglesharp/1.1.1/.nupkg.metadata
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "Mp/3KeMPbvqDoEEI+qf4gwaq4+QO1uehmYodPvtVO+tb6AGhTjPF8f7PNG73BJ79p4EryWa/pAH4urrafl9+lQ==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
offline/packages/anglesharp/1.1.1/.signature.p7s
vendored
Normal file
BIN
offline/packages/anglesharp/1.1.1/.signature.p7s
vendored
Normal file
Binary file not shown.
40
offline/packages/anglesharp/1.1.1/AngleSharp.nuspec
vendored
Normal file
40
offline/packages/anglesharp/1.1.1/AngleSharp.nuspec
vendored
Normal 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>
|
||||
162
offline/packages/anglesharp/1.1.1/README.md
vendored
Normal file
162
offline/packages/anglesharp/1.1.1/README.md
vendored
Normal file
@@ -0,0 +1,162 @@
|
||||
|
||||
|
||||
# AngleSharp
|
||||
|
||||
[](https://github.com/AngleSharp/AngleSharp/actions/workflows/ci.yml)
|
||||
[](https://github.com/AngleSharp/AngleSharp/releases)
|
||||
[](https://www.nuget.org/packages/AngleSharp/)
|
||||
[](https://github.com/AngleSharp/AngleSharp/issues)
|
||||
[](https://gitter.im/AngleSharp/AngleSharp)
|
||||
[](https://stackoverflow.com/tags/anglesharp)
|
||||
[](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).
|
||||
BIN
offline/packages/anglesharp/1.1.1/anglesharp.1.1.1.nupkg
vendored
Normal file
BIN
offline/packages/anglesharp/1.1.1/anglesharp.1.1.1.nupkg
vendored
Normal file
Binary file not shown.
1
offline/packages/anglesharp/1.1.1/anglesharp.1.1.1.nupkg.sha512
vendored
Normal file
1
offline/packages/anglesharp/1.1.1/anglesharp.1.1.1.nupkg.sha512
vendored
Normal file
@@ -0,0 +1 @@
|
||||
ziiduOsv2cM5Gip8AeXDAEp8EXmdHdsD8DsDSwsOaoNvvm8JDVCTvaJggh4mED+srpmlVdK+7wMl0TyJwdv8Cg==
|
||||
27991
offline/packages/anglesharp/1.1.1/lib/net461/AngleSharp.xml
vendored
Normal file
27991
offline/packages/anglesharp/1.1.1/lib/net461/AngleSharp.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
27991
offline/packages/anglesharp/1.1.1/lib/net472/AngleSharp.xml
vendored
Normal file
27991
offline/packages/anglesharp/1.1.1/lib/net472/AngleSharp.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
27991
offline/packages/anglesharp/1.1.1/lib/net6.0/AngleSharp.xml
vendored
Normal file
27991
offline/packages/anglesharp/1.1.1/lib/net6.0/AngleSharp.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
27991
offline/packages/anglesharp/1.1.1/lib/net7.0/AngleSharp.xml
vendored
Normal file
27991
offline/packages/anglesharp/1.1.1/lib/net7.0/AngleSharp.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
27991
offline/packages/anglesharp/1.1.1/lib/net8.0/AngleSharp.xml
vendored
Normal file
27991
offline/packages/anglesharp/1.1.1/lib/net8.0/AngleSharp.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
27991
offline/packages/anglesharp/1.1.1/lib/netstandard2.0/AngleSharp.xml
vendored
Normal file
27991
offline/packages/anglesharp/1.1.1/lib/netstandard2.0/AngleSharp.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
BIN
offline/packages/anglesharp/1.1.1/logo.png
vendored
Normal file
BIN
offline/packages/anglesharp/1.1.1/logo.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.4 KiB |
5
offline/packages/bouncycastle.cryptography/2.5.1/.nupkg.metadata
vendored
Normal file
5
offline/packages/bouncycastle.cryptography/2.5.1/.nupkg.metadata
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "zy8TMeTP+1FH2NrLaNZtdRbBdq7u5MI+NFZQOBSM69u5RFkciinwzV2eveY6Kjf5MzgsYvvl6kTStsj3JrXqkg==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
offline/packages/bouncycastle.cryptography/2.5.1/.signature.p7s
vendored
Normal file
BIN
offline/packages/bouncycastle.cryptography/2.5.1/.signature.p7s
vendored
Normal file
Binary file not shown.
25
offline/packages/bouncycastle.cryptography/2.5.1/BouncyCastle.Cryptography.nuspec
vendored
Normal file
25
offline/packages/bouncycastle.cryptography/2.5.1/BouncyCastle.Cryptography.nuspec
vendored
Normal 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>
|
||||
13
offline/packages/bouncycastle.cryptography/2.5.1/LICENSE.md
vendored
Normal file
13
offline/packages/bouncycastle.cryptography/2.5.1/LICENSE.md
vendored
Normal 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.**
|
||||
45
offline/packages/bouncycastle.cryptography/2.5.1/README.md
vendored
Normal file
45
offline/packages/bouncycastle.cryptography/2.5.1/README.md
vendored
Normal file
@@ -0,0 +1,45 @@
|
||||
# The Bouncy Castle Cryptography Library For .NET
|
||||
[](https://www.nuget.org/packages/BouncyCastle.Cryptography) [](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!
|
||||
BIN
offline/packages/bouncycastle.cryptography/2.5.1/bouncycastle.cryptography.2.5.1.nupkg
vendored
Normal file
BIN
offline/packages/bouncycastle.cryptography/2.5.1/bouncycastle.cryptography.2.5.1.nupkg
vendored
Normal file
Binary file not shown.
@@ -0,0 +1 @@
|
||||
zBLXFaejrNoOUbaASuEOHD6VQwCcEISFrmxOvodz3uV2Qvi+KR3CytzRSghqAjfZJSmJl97YoBpNWngce2erPQ==
|
||||
30259
offline/packages/bouncycastle.cryptography/2.5.1/lib/net461/BouncyCastle.Cryptography.xml
vendored
Normal file
30259
offline/packages/bouncycastle.cryptography/2.5.1/lib/net461/BouncyCastle.Cryptography.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
30381
offline/packages/bouncycastle.cryptography/2.5.1/lib/net6.0/BouncyCastle.Cryptography.xml
vendored
Normal file
30381
offline/packages/bouncycastle.cryptography/2.5.1/lib/net6.0/BouncyCastle.Cryptography.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
30259
offline/packages/bouncycastle.cryptography/2.5.1/lib/netstandard2.0/BouncyCastle.Cryptography.xml
vendored
Normal file
30259
offline/packages/bouncycastle.cryptography/2.5.1/lib/netstandard2.0/BouncyCastle.Cryptography.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
BIN
offline/packages/bouncycastle.cryptography/2.5.1/packageIcon.png
vendored
Normal file
BIN
offline/packages/bouncycastle.cryptography/2.5.1/packageIcon.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
5
offline/packages/cronos/0.10.0/.nupkg.metadata
vendored
Normal file
5
offline/packages/cronos/0.10.0/.nupkg.metadata
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "wHL4tr8mWTvrJt/4sI3raympCNVT4F3VJI4SJHA9A/wB+8Lsq84RFGQH9bHEtvNsN1lCBTKNk+uVoDotGcYJZA==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
offline/packages/cronos/0.10.0/.signature.p7s
vendored
Normal file
BIN
offline/packages/cronos/0.10.0/.signature.p7s
vendored
Normal file
Binary file not shown.
30
offline/packages/cronos/0.10.0/Cronos.nuspec
vendored
Normal file
30
offline/packages/cronos/0.10.0/Cronos.nuspec
vendored
Normal file
@@ -0,0 +1,30 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Cronos</id>
|
||||
<version>0.10.0</version>
|
||||
<title>Cronos</title>
|
||||
<authors>Andrey Dorokhov, Sergey Odinokov</authors>
|
||||
<owners>HangfireIO, odinserj</owners>
|
||||
<requireLicenseAcceptance>false</requireLicenseAcceptance>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>icon.png</icon>
|
||||
<readme>README.md</readme>
|
||||
<projectUrl>https://github.com/HangfireIO/Cronos</projectUrl>
|
||||
<description>A fully-featured .NET library for parsing cron expressions and calculating next occurrences that was designed with time zones in mind and correctly handles daylight saving time transitions.</description>
|
||||
<releaseNotes>https://github.com/HangfireIO/Cronos/releases</releaseNotes>
|
||||
<copyright>Copyright © 2016–2025 Hangfire OÜ.</copyright>
|
||||
<tags>Cronos Cron Recurring</tags>
|
||||
<repository type="git" url="https://github.com/HangfireIO/Cronos.git" commit="d63de9568d5809f1296a36540d1b6163ce480099" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.0" />
|
||||
<group targetFramework=".NETFramework4.5" />
|
||||
<group targetFramework=".NETStandard1.0">
|
||||
<dependency id="NETStandard.Library" version="1.6.1" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0" />
|
||||
<group targetFramework="net6.0" />
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
21
offline/packages/cronos/0.10.0/LICENSE
vendored
Normal file
21
offline/packages/cronos/0.10.0/LICENSE
vendored
Normal file
@@ -0,0 +1,21 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2017 Hangfire OÜ
|
||||
|
||||
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.
|
||||
292
offline/packages/cronos/0.10.0/README.md
vendored
Normal file
292
offline/packages/cronos/0.10.0/README.md
vendored
Normal file
@@ -0,0 +1,292 @@
|
||||
# Cronos
|
||||
[](https://www.nuget.org/packages/Cronos) [](https://ci.appveyor.com/project/hangfireio/cronos) [](https://sonarcloud.io/summary/new_code?id=HangfireIO_Cronos) [](https://sonarcloud.io/summary/new_code?id=HangfireIO_Cronos) [](https://sonarcloud.io/summary/new_code?id=HangfireIO_Cronos)
|
||||
|
||||
Cronos is a .NET library for parsing Cron expressions and calculating next occurrences. It was designed with time zones in mind, and intuitively handles [Daylight saving time](https://en.wikipedia.org/wiki/Daylight_saving_time) (also known as Summer time) transitions as in *nix Cron.
|
||||
|
||||
*Please note this library doesn't include any task/job scheduler, it only works with Cron expressions.*
|
||||
|
||||
* Supports standard Cron format with optional seconds.
|
||||
* Supports non-standard characters like `L`, `W`, `#` and their combinations.
|
||||
* Supports reversed ranges, like `23-01` (equivalent to `23,00,01`) or `DEC-FEB` (equivalent to `DEC,JAN,FEB`).
|
||||
* Supports time zones, and performs all the date/time conversions for you.
|
||||
* Does not skip occurrences, when the clock jumps forward to Daylight saving time (known as Summer time).
|
||||
* Does not skip interval-based occurrences, when the clock jumps backward from Summer time.
|
||||
* Does not retry non-interval based occurrences, when the clock jumps backward from Summer time.
|
||||
* Contains 1000+ unit tests to ensure everything is working correctly.
|
||||
|
||||
## Compatibility
|
||||
|
||||
This section explains how Cron expressions should be converted, when moving to Cronos.
|
||||
|
||||
Library | Comments
|
||||
--- | ---
|
||||
Vixie Cron | When both day-of-month and day-of-week are specified, Cronos uses AND operator for matching (Vixie Cron uses OR operator for backward compatibility).
|
||||
Quartz.NET | Cronos uses different, but more intuitive Daylight saving time handling logic (as in Vixie Cron). Full month names such as `september` aren't supported. Day-of-week field in Cronos has different values, `0` and `7` stand for Sunday, `1` for Monday, etc. (as in Vixie Cron). Year field is not supported.
|
||||
NCrontab | Compatible
|
||||
CronNET | Compatible
|
||||
|
||||
## Installation
|
||||
|
||||
Cronos is distributed as a [NuGet package](http://www.nuget.org/packages/Cronos/), you can install it from the official NuGet Gallery. Please use the following command to install it using the NuGet Package Manager Console window.
|
||||
|
||||
```
|
||||
PM> Install-Package Cronos
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
We've tried to do our best to make Cronos API as simple and predictable in corner cases as possible. So you can only use `DateTime` with `DateTimeKind.Utc` specified (for example, `DateTime.UtcNow`), or `DateTimeOffset` classes to calculate next occurrences. You **can not use** local `DateTime` objects (such as `DateTime.Now`), because this may lead to ambiguity during DST transitions, and an exception will be thrown if you attempt to use them.
|
||||
|
||||
To calculate the next occurrence, you need to create an instance of the `CronExpression` class, and call its `GetNextOccurrence` method. To learn about Cron format, please refer to the next section.
|
||||
|
||||
```csharp
|
||||
using Cronos;
|
||||
|
||||
CronExpression expression = CronExpression.Parse("* * * * *");
|
||||
|
||||
DateTime? nextUtc = expression.GetNextOccurrence(DateTime.UtcNow);
|
||||
```
|
||||
|
||||
The `nextUtc` will contain the next occurrence in UTC, *after the given time*, or `null` value when it is unreachable (for example, Feb 30). If an invalid Cron expression is given, the `CronFormatException` exception is thrown.
|
||||
|
||||
### Working with time zones
|
||||
|
||||
It is possible to specify a time zone directly, in this case you should pass `DateTime` with `DateTimeKind.Utc` flag, or use `DateTimeOffset` class, that's is smart enough to always point to an exact, non-ambiguous instant.
|
||||
|
||||
```csharp
|
||||
CronExpression expression = CronExpression.Parse("* * * * *");
|
||||
TimeZoneInfo easternTimeZone = TimeZoneInfo.FindSystemTimeZoneById("Eastern Standard Time");
|
||||
|
||||
DateTime? next = expression.GetNextOccurrence(DateTime.UtcNow, easternTimeZone);
|
||||
DateTimeOffset? next = expression.GetNextOccurrence(DateTimeOffset.UtcNow, easternTimeZone);
|
||||
```
|
||||
|
||||
If you passed a `DateTime` object, resulting time will be in UTC. If you used `DateTimeOffset`, resulting object will contain the **correct offset**, so don't forget to use it especially during DST transitions (see below).
|
||||
|
||||
### Working with local time
|
||||
|
||||
If you just want to make all the calculations using local time, you'll have to use the `DateTimeOffset` class, because as I've said earlier, `DateTime` objects may be ambiguous during Summer time transitions. You can get the resulting local time, using the `DateTimeOffset.DateTime` property.
|
||||
|
||||
```csharp
|
||||
CronExpression expression = CronExpression.Parse("* * * * *");
|
||||
DateTimeOffset? next = expression.GetNextOccurrence(DateTimeOffset.Now, TimeZoneInfo.Local);
|
||||
|
||||
var nextLocalTime = next?.DateTime;
|
||||
```
|
||||
|
||||
### Adding seconds to an expression
|
||||
|
||||
If you want to specify seconds, use another overload of the `Parse` method and specify the `CronFormat` argument as below:
|
||||
|
||||
```csharp
|
||||
CronExpression expression = CronExpression.Parse("*/30 * * * * *", CronFormat.IncludeSeconds);
|
||||
DateTime? next = expression.GetNextOccurrence(DateTime.UtcNow);
|
||||
```
|
||||
|
||||
### Getting occurrences within a range
|
||||
|
||||
You can also get occurrences within a fixed date/time range using the `GetOccurrences` method. By default, the `from` argument will be included when matched, and `to` argument will be excluded. However, you can configure that behavior.
|
||||
|
||||
```csharp
|
||||
CronExpression expression = CronExpression.Parse("* * * * *");
|
||||
IEnumerable<DateTime> occurrences = expression.GetOccurrences(
|
||||
DateTime.UtcNow,
|
||||
DateTime.UtcNow.AddYears(1),
|
||||
fromInclusive: true,
|
||||
toInclusive: false);
|
||||
```
|
||||
|
||||
There are different overloads for this method to support `DateTimeOffset` arguments or time zones.
|
||||
|
||||
## Cron format
|
||||
|
||||
Cron expression is a mask to define fixed times, dates and intervals. The mask consists of second (optional), minute, hour, day-of-month, month and day-of-week fields. All of the fields allow you to specify multiple values, and any given date/time will satisfy the specified Cron expression, if all the fields contain a matching value.
|
||||
|
||||
Allowed values Allowed special characters Comment
|
||||
|
||||
┌───────────── second (optional) 0-59 * , - /
|
||||
│ ┌───────────── minute 0-59 * , - /
|
||||
│ │ ┌───────────── hour 0-23 * , - /
|
||||
│ │ │ ┌───────────── day of month 1-31 * , - / L W ?
|
||||
│ │ │ │ ┌───────────── month 1-12 or JAN-DEC * , - /
|
||||
│ │ │ │ │ ┌───────────── day of week 0-6 or SUN-SAT * , - / # L ? Both 0 and 7 means SUN
|
||||
│ │ │ │ │ │
|
||||
* * * * * *
|
||||
|
||||
### Base characters
|
||||
|
||||
In all fields you can use number, `*` to mark field as *any value*, `-` to specify ranges of values. Reversed ranges like `22-1`(equivalent to `22,23,0,1,2`) are also supported.
|
||||
|
||||
It's possible to define **step** combining `/` with `*`, numbers and ranges. For example, `*/5` in minute field describes *every 5 minute* and `1-15/3` in day-of-month field – *every 3 days from the 1st to the 15th*. Pay attention that `*/24` is just equivalent to `0,24,48` and `*/24` in minute field doesn't literally mean *every 24 minutes* it means *every 0,24,48 minute*.
|
||||
|
||||
Concatinate values and ranges by `,`. Comma works like `OR` operator. So `3,5-11/3,12` is equivalent to `3,5,8,11,12`.
|
||||
|
||||
In month and day-of-week fields, you can use names of months or days of weeks abbreviated to first three letters (`Jan-Dec` or `Mon-Sun`) instead of their numeric values. Full names like `JANUARY` or `MONDAY` **aren't supported**.
|
||||
|
||||
For day of week field, both `0` and `7` stays for Sunday, 1 for Monday.
|
||||
|
||||
| Expression | Description |
|
||||
|----------------------|---------------------------------------------------------------------------------------|
|
||||
| `* * * * *` | Every minute |
|
||||
| `0 0 1 * *` | At midnight, on day 1 of every month |
|
||||
| `*/5 * * * *` | Every 5 minutes |
|
||||
| `30,45-15/2 1 * * *` | Every 2 minute from 1:00 AM to 01:15 AM and from 1:45 AM to 1:59 AM and at 1:30 AM |
|
||||
| `0 0 * * MON-FRI` | At 00:00, Monday through Friday |
|
||||
|
||||
### Special characters
|
||||
|
||||
Most expressions you can describe using base characters. If you want to deal with more complex cases like *the last day of month* or *the 2nd Saturday* use special characters:
|
||||
|
||||
**`L`** stands for "last". When used in the day-of-week field, it allows you to specify constructs such as *the last Friday* (`5L`or `FRIL`). In the day-of-month field, it specifies the last day of the month.
|
||||
|
||||
**`W`** in day-of-month field is the nearest weekday. Use `W` with single value (not ranges, steps or `*`) to define *the nearest weekday* to the given day. In this case there are two base rules to determine occurrence: we should shift to **the nearest weekday** and **can't shift to different month**. Thus if given day is Saturday we shift to Friday, if it is Sunday we shift to Monday. **But** if given day is **the 1st day of month** (e.g. `0 0 1W * *`) and it is Saturday we shift to the 3rd Monday, if given day is **last day of month** (`0 0 31W 0 0`) and it is Sunday we shift to that Friday. Mix `L` (optionaly with offset) and `W` characters to specify *last weekday of month* `LW` or more complex like `L-5W`.
|
||||
|
||||
**`#`** in day-of-week field allows to specify constructs such as *second Saturday* (`6#2` or `SAT#2`).
|
||||
|
||||
**`?`** is synonym of `*`. It's supported but not obligatory, so `0 0 5 * ?` is the same as `0 0 5 * *`.
|
||||
|
||||
| Expression | Description |
|
||||
|-------------------|----------------------------------------------------------|
|
||||
| `0 0 L * *` | At 00:00 AM on the last day of the month |
|
||||
| `0 0 L-1 * *` | At 00:00 AM the day before the last day of the month |
|
||||
| `0 0 3W * *` | At 00:00 AM, on the 3rd weekday of every month |
|
||||
| `0 0 LW * *` | At 00:00 AM, on the last weekday of the month |
|
||||
| `0 0 * * 2L` | At 00:00 AM on the last tuesday of the month |
|
||||
| `0 0 * * 6#3` | At 00:00 AM on the third Saturday of the month |
|
||||
| `0 0 ? 1 MON#1` | At 00:00 AM on the first Monday of the January |
|
||||
|
||||
### Specify Day of month and Day of week
|
||||
|
||||
You can set both **day-of-month** and **day-of-week**, it allows you to specify constructs such as **Friday the thirteenth**. Thus `0 0 13 * 5` means at 00:00, Friday the thirteenth.
|
||||
|
||||
It differs from Unix crontab and Quartz cron implementations. Crontab handles it like `OR` operator: occurrence can happen in given day of month or given day of week. So `0 0 13 * 5` means *at 00:00 AM, every friday or every the 13th of a month*. Quartz doesn't allow specify both day-of-month and day-of-week.
|
||||
|
||||
### Macro
|
||||
|
||||
A macro is a string starting with `@` and representing a shortcut for simple cases like *every day* or *every minute*.
|
||||
|
||||
Macro | Equivalent | Comment
|
||||
----------------|---------------| -------
|
||||
`@every_second` | `* * * * * *` | Run once a second
|
||||
`@every_minute` | `* * * * *` | Run once a minute at the beginning of the minute
|
||||
`@hourly` | `0 * * * *` | Run once an hour at the beginning of the hour
|
||||
`@daily` | `0 0 * * *` | Run once a day at midnight
|
||||
`@midnight` | `0 0 * * *` | Run once a day at midnight
|
||||
`@weekly` | `0 0 * * 0` | Run once a week at midnight on Sunday morning
|
||||
`@monthly` | `0 0 1 * *` | Run once a month at midnight of the first day of the month
|
||||
`@yearly` | `0 0 1 1 *` | Run once a year at midnight of 1 January
|
||||
`@annually` | `0 0 1 1 *` | Run once a year at midnight of 1 January
|
||||
|
||||
### Cron grammar
|
||||
|
||||
Cronos parser uses following case-insensitive grammar:
|
||||
|
||||
```
|
||||
cron ::= expression | macro
|
||||
expression ::= [second space] minute space hour space day-of-month space month space day-of-week
|
||||
second ::= field
|
||||
minute ::= field
|
||||
hour ::= field
|
||||
day-of-month ::= '*' [step] | '?' [step] | lastday | value [ 'W' | range [list] ]
|
||||
month ::= field
|
||||
day-of-week ::= '*' [step] | '?' [step] | value [ dowspec | range [list] ]
|
||||
macro ::= '@every_second' | '@every_minute' | '@hourly' | '@daily' | '@midnight' | '@weekly' | '@monthly'|
|
||||
'@yearly' | '@annually'
|
||||
field ::= '*' [step] | '?' [step] | value [range] [list]
|
||||
list ::= { ',' value [range] }
|
||||
range ::= '-' value [step] | [step]
|
||||
step ::= '/' number
|
||||
value ::= number | name
|
||||
name ::= month-name | dow-name
|
||||
month-name ::= 'JAN' | 'FEB' | 'MAR' | 'APR' | 'MAY' | 'JUN' | 'JUL' | 'AUG' | 'SEP' | 'OCT' | 'NOV' | 'DEC'
|
||||
dow-name ::= 'SUN' | 'MON' | 'TUE' | 'WED' | 'THU' | 'FRI' | 'SAT'
|
||||
dowspec ::= 'L' | '#' number
|
||||
lastday ::= 'L' ['-' number] ['W']
|
||||
number ::= digit | number digit
|
||||
space ::= ' ' | '\t'
|
||||
```
|
||||
|
||||
## Daylight Saving Time
|
||||
|
||||
Cronos is the only library to handle daylight saving time transitions in intuitive way with the same behavior as Vixie Cron (utility for *nix systems). During a spring transition, we don't skip occurrences scheduled to invalid time during. In an autumn transition we don't get duplicate occurrences for daily expressions, and don't skip interval expressions when the local time is ambiguous.
|
||||
|
||||
### Transition to Summer time (in spring)
|
||||
|
||||
During the transition to Summer time, the clock is moved forward, for example the next minute after `01:59 AM` is `03:00 AM`. So any daily Cron expression that should match `02:30 AM`, points to an invalid time. It doesn't exist, and can't be mapped to UTC.
|
||||
|
||||
Cronos adjusts the next occurrence to the next valid time in these cases. If you use Cron to schedule jobs, you may have shorter or longer intervals between runs when this happen, but you'll not lose your jobs:
|
||||
|
||||
```
|
||||
"30 02 * * *" (every day at 02:30 AM)
|
||||
|
||||
Mar 13, 02:30 +03:00 – run
|
||||
Mar 14, 03:00 +04:00 – run (adjusted)
|
||||
Mar 15, 02:30 +04:00 – run
|
||||
```
|
||||
|
||||
### Transition from Summer time (in autumn)
|
||||
|
||||
When Daylight Saving Time ends you set the clocks backward so there is duration which repeats twice. For example, after `01:59 AM` you get `01:00 AM` again, so the interval between `01:00 AM` to `02:00 AM` (excluding) is ambiguous, and can be mapped to multiple UTC offsets.
|
||||
|
||||
We don't want to have multiple occurrences of daily expressions during this transition, but at the same time we want to schedule interval expressions as usually, without skipping them. So we have different behavior for different Cron expressions.
|
||||
|
||||
#### Interval expression
|
||||
|
||||
Cron expression is **interval based** whose second, minute or hour field contains `*`, ranges or steps, e.g. `30 * * * *` (hour field), `* 1 * * *` (minute field), `0,5 0/10 1 * * *`. In this case there are expectations that occurrences should happen periodically during the day and this rule can't be broken by time transitions. Thus for **interval based** expressions occurrences will be before and after clock shifts.
|
||||
|
||||
Consider `*/30 * * * *` interval expression. It should occur every 30 minutes no matter what.
|
||||
|
||||
```
|
||||
Nov 08, 00:30 +04:00 – run
|
||||
Nov 08, 01:00 +04:00 – run
|
||||
Nov 08, 01:30 +04:00 – run
|
||||
Nov 08, 01:00 +03:00 – run
|
||||
Nov 08, 01:30 +03:00 – run
|
||||
Nov 08, 02:00 +03:00 – run
|
||||
```
|
||||
|
||||
#### Non-interval expression
|
||||
|
||||
Cron expression is **non-interval based** whose second, minute or hour field **does not contain** `*`, ranges or steps, e.g. `0 30 1 * * *` or `0 0,45 1,2 * * *`. We expect they occur given number of times per day. Thus for **non-interval** expressions occurrences will be just before clock shifts.
|
||||
|
||||
Consider `30 1 * * *` non-interval expression. It should occur once a day no matter what.
|
||||
|
||||
```
|
||||
Nov 07, 01:30 +04:00 – run
|
||||
Nov 08, 01:30 +04:00 – run
|
||||
Nov 08, 01:30 +03:00 – skip
|
||||
Nov 09, 01:30 +03:00 – run
|
||||
```
|
||||
|
||||
## Benchmarks
|
||||
|
||||
Since [BenchmarkDotNet](https://github.com/dotnet/BenchmarkDotNet) project appeared, it's hard to ignore the performance. We tried hard to make Cronos not only feature-rich, but also really fast when parsing expressions and calculating next occurrences. As a result, Cronos is faster more than in an order of magnitude than alternative libraries, here is a small comparison:
|
||||
|
||||
```
|
||||
Cronos Method | Mean | StdDev
|
||||
------------------------------------------- | -------------- | -------------
|
||||
CronExpression.Parse("* * * * *") | 30.8473 ns | 0.0515 ns
|
||||
CronExpression.Parse("*/10 12-20 ? DEC 3") | 81.5010 ns | 0.0924 ns
|
||||
Simple.GetNextOccurrence(DateTime.UtcNow) | 123.4712 ns | 0.5928 ns
|
||||
Complex.GetNextOccurrence(DateTime.UtcNow) | 212.0422 ns | 0.3997 ns
|
||||
|
||||
NCrontab Method | Mean | StdDev
|
||||
------------------------------------------- | -------------- | -------------
|
||||
CrontabSchedule.Parse("* * * * *") | 1,813.7313 ns | 3.3718 ns
|
||||
CrontabSchedule.Parse("*/10 12-20 * DEC 3") | 3,174.3625 ns | 6.8522 ns
|
||||
Simple.GetNextOccurrence(DateTime.UtcNow) | 147.7866 ns | 0.1689 ns
|
||||
Complex.GetNextOccurrence(DateTime.UtcNow) | 1,001.3253 ns | 1.6205 ns
|
||||
|
||||
Quartz Method | Mean | StdDev
|
||||
------------------------------------------- | -------------- | -------------
|
||||
new CronExpression("* * * * * ?") | 48,157.7744 ns | 1,417.3101 ns
|
||||
new CronExpression("* */10 12-20 ? DEC 3") | 33,731.9992 ns | 38.3192 ns
|
||||
Simple.GetTimeAfter(DateTimeOffset.Now) | 1,416.9867 ns | 1.2784 ns
|
||||
Complex.GetTimeAfter(DateTimeOffset.Now) | 6,573.0269 ns | 7.9192 ns
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Copyright © 2017 Hangfire OÜ. Cronos is licensed under [The MIT License (MIT)][LICENSE].
|
||||
|
||||
[LICENSE]:LICENSE
|
||||
BIN
offline/packages/cronos/0.10.0/cronos.0.10.0.nupkg
vendored
Normal file
BIN
offline/packages/cronos/0.10.0/cronos.0.10.0.nupkg
vendored
Normal file
Binary file not shown.
1
offline/packages/cronos/0.10.0/cronos.0.10.0.nupkg.sha512
vendored
Normal file
1
offline/packages/cronos/0.10.0/cronos.0.10.0.nupkg.sha512
vendored
Normal file
@@ -0,0 +1 @@
|
||||
64VD5LS+VkoELCZnpOPRbc/jtYbKFdNFIykE/Pm7O+XB0zbwZyDQmrwYeQN6BLmmmevW/zDhBsK91Yrh0vinjQ==
|
||||
BIN
offline/packages/cronos/0.10.0/icon.png
vendored
Normal file
BIN
offline/packages/cronos/0.10.0/icon.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.2 KiB |
211
offline/packages/cronos/0.10.0/lib/net40/Cronos.xml
vendored
Normal file
211
offline/packages/cronos/0.10.0/lib/net40/Cronos.xml
vendored
Normal file
@@ -0,0 +1,211 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Cronos</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Cronos.CronExpression">
|
||||
<summary>
|
||||
Provides a parser and scheduler for cron expressions.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Yearly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on Jan 1st every year at midnight.
|
||||
Equals to "0 0 1 1 *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Weekly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every Sunday at midnight.
|
||||
Equals to "0 0 * * 0".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Monthly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on 1st day of every month at midnight.
|
||||
Equals to "0 0 1 * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Daily">
|
||||
<summary>
|
||||
Represents a cron expression that fires every day at midnight.
|
||||
Equals to "0 0 * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Hourly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every hour at the beginning of the hour.
|
||||
Equals to "0 * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EveryMinute">
|
||||
<summary>
|
||||
Represents a cron expression that fires every minute.
|
||||
Equals to "* * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EverySecond">
|
||||
<summary>
|
||||
Represents a cron expression that fires every second.
|
||||
Equals to "* * * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 fields:
|
||||
minute, hour, day of month, month, day of week.
|
||||
If you want to parse non-standard cron expressions use <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/> with specified CronFields argument.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 or 6 fields:
|
||||
second (optional), minute, hour, day of month, month, day of week.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the
|
||||
<see cref="F:Cronos.CronFormat.Standard"/> format.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronFormat,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the specified
|
||||
<paramref name="format"/>.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in UTC time zone.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTimeOffset,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="from"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range,
|
||||
including <paramref name="fromUtc"/> and excluding <paramref name="toUtc"/>
|
||||
by default, and UTC time zone. When none of the occurrences found, an
|
||||
empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range, including
|
||||
<paramref name="fromUtc"/> and excluding <paramref name="toUtc"/> by default, and
|
||||
specified time zone. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTimeOffset,System.DateTimeOffset,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of occurrences within the given date/time offset range,
|
||||
including <paramref name="from"/> and excluding <paramref name="to"/> by
|
||||
default. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.ToString">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(Cronos.CronExpression)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
|
||||
</summary>
|
||||
<param name="other">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(System.Object)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object" /> is equal to this instance.
|
||||
</summary>
|
||||
<param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance;
|
||||
otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetHashCode">
|
||||
<summary>
|
||||
Returns a hash code for this instance.
|
||||
</summary>
|
||||
<returns>
|
||||
A hash code for this instance, suitable for use in hashing algorithms and data
|
||||
structures like a hash table.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Equality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator ==.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Inequality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator !=.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormat">
|
||||
<summary>
|
||||
Defines the cron format options that customize string parsing for <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.Standard">
|
||||
<summary>
|
||||
Parsing string must contain only 5 fields: minute, hour, day of month, month, day of week.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.IncludeSeconds">
|
||||
<summary>
|
||||
Second field must be specified in parsing string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormatException">
|
||||
<summary>
|
||||
Represents an exception that's thrown, when invalid Cron expression is given.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String,System.Exception)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message and a reference to the inner exception that is the
|
||||
cause of this exception.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
211
offline/packages/cronos/0.10.0/lib/net45/Cronos.xml
vendored
Normal file
211
offline/packages/cronos/0.10.0/lib/net45/Cronos.xml
vendored
Normal file
@@ -0,0 +1,211 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Cronos</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Cronos.CronExpression">
|
||||
<summary>
|
||||
Provides a parser and scheduler for cron expressions.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Yearly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on Jan 1st every year at midnight.
|
||||
Equals to "0 0 1 1 *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Weekly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every Sunday at midnight.
|
||||
Equals to "0 0 * * 0".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Monthly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on 1st day of every month at midnight.
|
||||
Equals to "0 0 1 * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Daily">
|
||||
<summary>
|
||||
Represents a cron expression that fires every day at midnight.
|
||||
Equals to "0 0 * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Hourly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every hour at the beginning of the hour.
|
||||
Equals to "0 * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EveryMinute">
|
||||
<summary>
|
||||
Represents a cron expression that fires every minute.
|
||||
Equals to "* * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EverySecond">
|
||||
<summary>
|
||||
Represents a cron expression that fires every second.
|
||||
Equals to "* * * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 fields:
|
||||
minute, hour, day of month, month, day of week.
|
||||
If you want to parse non-standard cron expressions use <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/> with specified CronFields argument.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 or 6 fields:
|
||||
second (optional), minute, hour, day of month, month, day of week.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the
|
||||
<see cref="F:Cronos.CronFormat.Standard"/> format.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronFormat,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the specified
|
||||
<paramref name="format"/>.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in UTC time zone.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTimeOffset,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="from"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range,
|
||||
including <paramref name="fromUtc"/> and excluding <paramref name="toUtc"/>
|
||||
by default, and UTC time zone. When none of the occurrences found, an
|
||||
empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range, including
|
||||
<paramref name="fromUtc"/> and excluding <paramref name="toUtc"/> by default, and
|
||||
specified time zone. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTimeOffset,System.DateTimeOffset,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of occurrences within the given date/time offset range,
|
||||
including <paramref name="from"/> and excluding <paramref name="to"/> by
|
||||
default. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.ToString">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(Cronos.CronExpression)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
|
||||
</summary>
|
||||
<param name="other">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(System.Object)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object" /> is equal to this instance.
|
||||
</summary>
|
||||
<param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance;
|
||||
otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetHashCode">
|
||||
<summary>
|
||||
Returns a hash code for this instance.
|
||||
</summary>
|
||||
<returns>
|
||||
A hash code for this instance, suitable for use in hashing algorithms and data
|
||||
structures like a hash table.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Equality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator ==.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Inequality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator !=.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormat">
|
||||
<summary>
|
||||
Defines the cron format options that customize string parsing for <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.Standard">
|
||||
<summary>
|
||||
Parsing string must contain only 5 fields: minute, hour, day of month, month, day of week.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.IncludeSeconds">
|
||||
<summary>
|
||||
Second field must be specified in parsing string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormatException">
|
||||
<summary>
|
||||
Represents an exception that's thrown, when invalid Cron expression is given.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String,System.Exception)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message and a reference to the inner exception that is the
|
||||
cause of this exception.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
211
offline/packages/cronos/0.10.0/lib/net6.0/Cronos.xml
vendored
Normal file
211
offline/packages/cronos/0.10.0/lib/net6.0/Cronos.xml
vendored
Normal file
@@ -0,0 +1,211 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Cronos</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Cronos.CronExpression">
|
||||
<summary>
|
||||
Provides a parser and scheduler for cron expressions.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Yearly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on Jan 1st every year at midnight.
|
||||
Equals to "0 0 1 1 *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Weekly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every Sunday at midnight.
|
||||
Equals to "0 0 * * 0".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Monthly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on 1st day of every month at midnight.
|
||||
Equals to "0 0 1 * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Daily">
|
||||
<summary>
|
||||
Represents a cron expression that fires every day at midnight.
|
||||
Equals to "0 0 * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Hourly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every hour at the beginning of the hour.
|
||||
Equals to "0 * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EveryMinute">
|
||||
<summary>
|
||||
Represents a cron expression that fires every minute.
|
||||
Equals to "* * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EverySecond">
|
||||
<summary>
|
||||
Represents a cron expression that fires every second.
|
||||
Equals to "* * * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 fields:
|
||||
minute, hour, day of month, month, day of week.
|
||||
If you want to parse non-standard cron expressions use <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/> with specified CronFields argument.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 or 6 fields:
|
||||
second (optional), minute, hour, day of month, month, day of week.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the
|
||||
<see cref="F:Cronos.CronFormat.Standard"/> format.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronFormat,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the specified
|
||||
<paramref name="format"/>.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in UTC time zone.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTimeOffset,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="from"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range,
|
||||
including <paramref name="fromUtc"/> and excluding <paramref name="toUtc"/>
|
||||
by default, and UTC time zone. When none of the occurrences found, an
|
||||
empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range, including
|
||||
<paramref name="fromUtc"/> and excluding <paramref name="toUtc"/> by default, and
|
||||
specified time zone. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTimeOffset,System.DateTimeOffset,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of occurrences within the given date/time offset range,
|
||||
including <paramref name="from"/> and excluding <paramref name="to"/> by
|
||||
default. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.ToString">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(Cronos.CronExpression)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
|
||||
</summary>
|
||||
<param name="other">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(System.Object)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object" /> is equal to this instance.
|
||||
</summary>
|
||||
<param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance;
|
||||
otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetHashCode">
|
||||
<summary>
|
||||
Returns a hash code for this instance.
|
||||
</summary>
|
||||
<returns>
|
||||
A hash code for this instance, suitable for use in hashing algorithms and data
|
||||
structures like a hash table.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Equality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator ==.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Inequality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator !=.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormat">
|
||||
<summary>
|
||||
Defines the cron format options that customize string parsing for <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.Standard">
|
||||
<summary>
|
||||
Parsing string must contain only 5 fields: minute, hour, day of month, month, day of week.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.IncludeSeconds">
|
||||
<summary>
|
||||
Second field must be specified in parsing string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormatException">
|
||||
<summary>
|
||||
Represents an exception that's thrown, when invalid Cron expression is given.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String,System.Exception)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message and a reference to the inner exception that is the
|
||||
cause of this exception.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
208
offline/packages/cronos/0.10.0/lib/netstandard1.0/Cronos.xml
vendored
Normal file
208
offline/packages/cronos/0.10.0/lib/netstandard1.0/Cronos.xml
vendored
Normal file
@@ -0,0 +1,208 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Cronos</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Cronos.CronExpression">
|
||||
<summary>
|
||||
Provides a parser and scheduler for cron expressions.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Yearly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on Jan 1st every year at midnight.
|
||||
Equals to "0 0 1 1 *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Weekly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every Sunday at midnight.
|
||||
Equals to "0 0 * * 0".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Monthly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on 1st day of every month at midnight.
|
||||
Equals to "0 0 1 * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Daily">
|
||||
<summary>
|
||||
Represents a cron expression that fires every day at midnight.
|
||||
Equals to "0 0 * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Hourly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every hour at the beginning of the hour.
|
||||
Equals to "0 * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EveryMinute">
|
||||
<summary>
|
||||
Represents a cron expression that fires every minute.
|
||||
Equals to "* * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EverySecond">
|
||||
<summary>
|
||||
Represents a cron expression that fires every second.
|
||||
Equals to "* * * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 fields:
|
||||
minute, hour, day of month, month, day of week.
|
||||
If you want to parse non-standard cron expressions use <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/> with specified CronFields argument.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 or 6 fields:
|
||||
second (optional), minute, hour, day of month, month, day of week.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the
|
||||
<see cref="F:Cronos.CronFormat.Standard"/> format.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronFormat,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the specified
|
||||
<paramref name="format"/>.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in UTC time zone.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTimeOffset,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="from"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range,
|
||||
including <paramref name="fromUtc"/> and excluding <paramref name="toUtc"/>
|
||||
by default, and UTC time zone. When none of the occurrences found, an
|
||||
empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range, including
|
||||
<paramref name="fromUtc"/> and excluding <paramref name="toUtc"/> by default, and
|
||||
specified time zone. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTimeOffset,System.DateTimeOffset,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of occurrences within the given date/time offset range,
|
||||
including <paramref name="from"/> and excluding <paramref name="to"/> by
|
||||
default. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.ToString">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(Cronos.CronExpression)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
|
||||
</summary>
|
||||
<param name="other">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(System.Object)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object" /> is equal to this instance.
|
||||
</summary>
|
||||
<param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance;
|
||||
otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetHashCode">
|
||||
<summary>
|
||||
Returns a hash code for this instance.
|
||||
</summary>
|
||||
<returns>
|
||||
A hash code for this instance, suitable for use in hashing algorithms and data
|
||||
structures like a hash table.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Equality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator ==.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Inequality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator !=.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormat">
|
||||
<summary>
|
||||
Defines the cron format options that customize string parsing for <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.Standard">
|
||||
<summary>
|
||||
Parsing string must contain only 5 fields: minute, hour, day of month, month, day of week.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.IncludeSeconds">
|
||||
<summary>
|
||||
Second field must be specified in parsing string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormatException">
|
||||
<summary>
|
||||
Represents an exception that's thrown, when invalid Cron expression is given.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String,System.Exception)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message and a reference to the inner exception that is the
|
||||
cause of this exception.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
211
offline/packages/cronos/0.10.0/lib/netstandard2.0/Cronos.xml
vendored
Normal file
211
offline/packages/cronos/0.10.0/lib/netstandard2.0/Cronos.xml
vendored
Normal file
@@ -0,0 +1,211 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Cronos</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Cronos.CronExpression">
|
||||
<summary>
|
||||
Provides a parser and scheduler for cron expressions.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Yearly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on Jan 1st every year at midnight.
|
||||
Equals to "0 0 1 1 *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Weekly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every Sunday at midnight.
|
||||
Equals to "0 0 * * 0".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Monthly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on 1st day of every month at midnight.
|
||||
Equals to "0 0 1 * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Daily">
|
||||
<summary>
|
||||
Represents a cron expression that fires every day at midnight.
|
||||
Equals to "0 0 * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Hourly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every hour at the beginning of the hour.
|
||||
Equals to "0 * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EveryMinute">
|
||||
<summary>
|
||||
Represents a cron expression that fires every minute.
|
||||
Equals to "* * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EverySecond">
|
||||
<summary>
|
||||
Represents a cron expression that fires every second.
|
||||
Equals to "* * * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 fields:
|
||||
minute, hour, day of month, month, day of week.
|
||||
If you want to parse non-standard cron expressions use <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/> with specified CronFields argument.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 or 6 fields:
|
||||
second (optional), minute, hour, day of month, month, day of week.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the
|
||||
<see cref="F:Cronos.CronFormat.Standard"/> format.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronFormat,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the specified
|
||||
<paramref name="format"/>.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in UTC time zone.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTimeOffset,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="from"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range,
|
||||
including <paramref name="fromUtc"/> and excluding <paramref name="toUtc"/>
|
||||
by default, and UTC time zone. When none of the occurrences found, an
|
||||
empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range, including
|
||||
<paramref name="fromUtc"/> and excluding <paramref name="toUtc"/> by default, and
|
||||
specified time zone. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTimeOffset,System.DateTimeOffset,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of occurrences within the given date/time offset range,
|
||||
including <paramref name="from"/> and excluding <paramref name="to"/> by
|
||||
default. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.ToString">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(Cronos.CronExpression)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
|
||||
</summary>
|
||||
<param name="other">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(System.Object)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object" /> is equal to this instance.
|
||||
</summary>
|
||||
<param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance;
|
||||
otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetHashCode">
|
||||
<summary>
|
||||
Returns a hash code for this instance.
|
||||
</summary>
|
||||
<returns>
|
||||
A hash code for this instance, suitable for use in hashing algorithms and data
|
||||
structures like a hash table.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Equality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator ==.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Inequality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator !=.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormat">
|
||||
<summary>
|
||||
Defines the cron format options that customize string parsing for <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.Standard">
|
||||
<summary>
|
||||
Parsing string must contain only 5 fields: minute, hour, day of month, month, day of week.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.IncludeSeconds">
|
||||
<summary>
|
||||
Second field must be specified in parsing string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormatException">
|
||||
<summary>
|
||||
Represents an exception that's thrown, when invalid Cron expression is given.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String,System.Exception)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message and a reference to the inner exception that is the
|
||||
cause of this exception.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
5
offline/packages/dnsclient/1.6.1/.nupkg.metadata
vendored
Normal file
5
offline/packages/dnsclient/1.6.1/.nupkg.metadata
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "4H/f2uYJOZ+YObZjpY9ABrKZI+JNw3uizp6oMzTXwDw6F+2qIPhpRl/1t68O/6e98+vqNiYGu+lswmwdYUy3gg==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
offline/packages/dnsclient/1.6.1/.signature.p7s
vendored
Normal file
BIN
offline/packages/dnsclient/1.6.1/.signature.p7s
vendored
Normal file
Binary file not shown.
45
offline/packages/dnsclient/1.6.1/DnsClient.nuspec
vendored
Normal file
45
offline/packages/dnsclient/1.6.1/DnsClient.nuspec
vendored
Normal file
@@ -0,0 +1,45 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>DnsClient</id>
|
||||
<version>1.6.1</version>
|
||||
<authors>MichaCo</authors>
|
||||
<license type="expression">Apache-2.0</license>
|
||||
<licenseUrl>https://licenses.nuget.org/Apache-2.0</licenseUrl>
|
||||
<icon>icon.png</icon>
|
||||
<projectUrl>http://dnsclient.michaco.net/</projectUrl>
|
||||
<description>DnsClient.NET is a simple yet very powerful and high performance open source library for the .NET Framework to do DNS lookups</description>
|
||||
<copyright>Copyright (c) 2021 Michael Conrad</copyright>
|
||||
<tags>dns client stub resolver name server core service discovery</tags>
|
||||
<repository type="git" url="https://github.com/MichaCo/DnsClient.NET" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.5">
|
||||
<dependency id="System.Buffers" version="4.5.1" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETFramework4.7.1">
|
||||
<dependency id="Microsoft.Win32.Registry" version="5.0.0" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Buffers" version="4.5.1" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard1.3">
|
||||
<dependency id="Microsoft.Win32.Primitives" version="4.3.0" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Win32.Registry" version="5.0.0" exclude="Build,Analyzers" />
|
||||
<dependency id="NETStandard.Library" version="1.6.1" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Buffers" version="4.5.1" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Diagnostics.TraceSource" version="4.3.0" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Globalization.Extensions" version="4.3.0" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Net.NameResolution" version="4.3.0" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Net.NetworkInformation" version="4.3.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net5.0">
|
||||
<dependency id="Microsoft.Win32.Registry" version="5.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Microsoft.Win32.Registry" version="5.0.0" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Buffers" version="4.5.1" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.1">
|
||||
<dependency id="Microsoft.Win32.Registry" version="5.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
BIN
offline/packages/dnsclient/1.6.1/dnsclient.1.6.1.nupkg
vendored
Normal file
BIN
offline/packages/dnsclient/1.6.1/dnsclient.1.6.1.nupkg
vendored
Normal file
Binary file not shown.
1
offline/packages/dnsclient/1.6.1/dnsclient.1.6.1.nupkg.sha512
vendored
Normal file
1
offline/packages/dnsclient/1.6.1/dnsclient.1.6.1.nupkg.sha512
vendored
Normal file
@@ -0,0 +1 @@
|
||||
zFRP0MFIwSEYYo6wcLc7bFJANsVY6tj08Vkq+8x6xbz0hvYqTmMM76Eg9mbzoWbDuJWWrWIDlmt/Ia7HwrPVXg==
|
||||
BIN
offline/packages/dnsclient/1.6.1/icon.png
vendored
Normal file
BIN
offline/packages/dnsclient/1.6.1/icon.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
5071
offline/packages/dnsclient/1.6.1/lib/net45/DnsClient.xml
vendored
Normal file
5071
offline/packages/dnsclient/1.6.1/lib/net45/DnsClient.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
5090
offline/packages/dnsclient/1.6.1/lib/net471/DnsClient.xml
vendored
Normal file
5090
offline/packages/dnsclient/1.6.1/lib/net471/DnsClient.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
5090
offline/packages/dnsclient/1.6.1/lib/net5.0/DnsClient.xml
vendored
Normal file
5090
offline/packages/dnsclient/1.6.1/lib/net5.0/DnsClient.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
5090
offline/packages/dnsclient/1.6.1/lib/netstandard1.3/DnsClient.xml
vendored
Normal file
5090
offline/packages/dnsclient/1.6.1/lib/netstandard1.3/DnsClient.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
5090
offline/packages/dnsclient/1.6.1/lib/netstandard2.0/DnsClient.xml
vendored
Normal file
5090
offline/packages/dnsclient/1.6.1/lib/netstandard2.0/DnsClient.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
5090
offline/packages/dnsclient/1.6.1/lib/netstandard2.1/DnsClient.xml
vendored
Normal file
5090
offline/packages/dnsclient/1.6.1/lib/netstandard2.1/DnsClient.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
5
offline/packages/jetbrains.annotations/2021.2.0/.nupkg.metadata
vendored
Normal file
5
offline/packages/jetbrains.annotations/2021.2.0/.nupkg.metadata
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "kKSyoVfndMriKHLfYGmr0uzQuI4jcc3TKGyww7buJFCYeHb/X0kodYBPL7n9454q7v6ASiRmDgpPGaDGerg/Hg==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
offline/packages/jetbrains.annotations/2021.2.0/.signature.p7s
vendored
Normal file
BIN
offline/packages/jetbrains.annotations/2021.2.0/.signature.p7s
vendored
Normal file
Binary file not shown.
31
offline/packages/jetbrains.annotations/2021.2.0/JetBrains.Annotations.nuspec
vendored
Normal file
31
offline/packages/jetbrains.annotations/2021.2.0/JetBrains.Annotations.nuspec
vendored
Normal 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>
|
||||
BIN
offline/packages/jetbrains.annotations/2021.2.0/icon.png
vendored
Normal file
BIN
offline/packages/jetbrains.annotations/2021.2.0/icon.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.4 KiB |
BIN
offline/packages/jetbrains.annotations/2021.2.0/jetbrains.annotations.2021.2.0.nupkg
vendored
Normal file
BIN
offline/packages/jetbrains.annotations/2021.2.0/jetbrains.annotations.2021.2.0.nupkg
vendored
Normal file
Binary file not shown.
1
offline/packages/jetbrains.annotations/2021.2.0/jetbrains.annotations.2021.2.0.nupkg.sha512
vendored
Normal file
1
offline/packages/jetbrains.annotations/2021.2.0/jetbrains.annotations.2021.2.0.nupkg.sha512
vendored
Normal file
@@ -0,0 +1 @@
|
||||
5PHop6aJCyEWoqW0SDNG4b3QrHsw1ntcAmuFlsUVCoaGi7LT6soi0OIugNvP7u2udV7BwpJYyIlaz8P5cQUXxQ==
|
||||
823
offline/packages/jetbrains.annotations/2021.2.0/lib/net20/JetBrains.Annotations.xml
vendored
Normal file
823
offline/packages/jetbrains.annotations/2021.2.0/lib/net20/JetBrains.Annotations.xml
vendored
Normal 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<string> 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<string> 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(() => Property)</c></item>
|
||||
<item><c>NotifyChanged((VM x) => 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 => Output | Output <= 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("=> halt")]
|
||||
public void TerminationMethod()
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("null <= param:null")] // reverse condition syntax
|
||||
public string GetName(string surname)
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("s:null => 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 => null; notnull => notnull")]
|
||||
public object Transform(object data)
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("=> true, result: notnull; => 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<T>(this IEnumerable<T> 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<T>(this IEnumerable<T> 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<string>
|
||||
{
|
||||
[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<T>([NoEnumeration] T v, string n) where T : class
|
||||
{
|
||||
// custom check for null but no enumeration
|
||||
}
|
||||
|
||||
void Foo(IEnumerable<string> 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>
|
||||
386
offline/packages/jetbrains.annotations/2021.2.0/lib/netstandard1.0/JetBrains.Annotations.deps.json
vendored
Normal file
386
offline/packages/jetbrains.annotations/2021.2.0/lib/netstandard1.0/JetBrains.Annotations.deps.json
vendored
Normal 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"
|
||||
}
|
||||
}
|
||||
}
|
||||
823
offline/packages/jetbrains.annotations/2021.2.0/lib/netstandard1.0/JetBrains.Annotations.xml
vendored
Normal file
823
offline/packages/jetbrains.annotations/2021.2.0/lib/netstandard1.0/JetBrains.Annotations.xml
vendored
Normal 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<string> 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<string> 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(() => Property)</c></item>
|
||||
<item><c>NotifyChanged((VM x) => 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 => Output | Output <= 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("=> halt")]
|
||||
public void TerminationMethod()
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("null <= param:null")] // reverse condition syntax
|
||||
public string GetName(string surname)
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("s:null => 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 => null; notnull => notnull")]
|
||||
public object Transform(object data)
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("=> true, result: notnull; => 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<T>(this IEnumerable<T> 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<T>(this IEnumerable<T> 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<string>
|
||||
{
|
||||
[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<T>([NoEnumeration] T v, string n) where T : class
|
||||
{
|
||||
// custom check for null but no enumeration
|
||||
}
|
||||
|
||||
void Foo(IEnumerable<string> 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>
|
||||
@@ -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"
|
||||
}
|
||||
}
|
||||
}
|
||||
823
offline/packages/jetbrains.annotations/2021.2.0/lib/netstandard2.0/JetBrains.Annotations.xml
vendored
Normal file
823
offline/packages/jetbrains.annotations/2021.2.0/lib/netstandard2.0/JetBrains.Annotations.xml
vendored
Normal 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<string> 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<string> 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(() => Property)</c></item>
|
||||
<item><c>NotifyChanged((VM x) => 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 => Output | Output <= 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("=> halt")]
|
||||
public void TerminationMethod()
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("null <= param:null")] // reverse condition syntax
|
||||
public string GetName(string surname)
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("s:null => 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 => null; notnull => notnull")]
|
||||
public object Transform(object data)
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("=> true, result: notnull; => 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<T>(this IEnumerable<T> 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<T>(this IEnumerable<T> 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<string>
|
||||
{
|
||||
[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<T>([NoEnumeration] T v, string n) where T : class
|
||||
{
|
||||
// custom check for null but no enumeration
|
||||
}
|
||||
|
||||
void Foo(IEnumerable<string> 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>
|
||||
@@ -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<string> 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<string> 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(() => Property)</c></item>
|
||||
<item><c>NotifyChanged((VM x) => 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 => Output | Output <= 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("=> halt")]
|
||||
public void TerminationMethod()
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("null <= param:null")] // reverse condition syntax
|
||||
public string GetName(string surname)
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("s:null => 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 => null; notnull => notnull")]
|
||||
public object Transform(object data)
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("=> true, result: notnull; => 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<T>(this IEnumerable<T> 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<T>(this IEnumerable<T> 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<string>
|
||||
{
|
||||
[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<T>([NoEnumeration] T v, string n) where T : class
|
||||
{
|
||||
// custom check for null but no enumeration
|
||||
}
|
||||
|
||||
void Foo(IEnumerable<string> 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>
|
||||
5
offline/packages/json.more.net/1.8.0/.nupkg.metadata
vendored
Normal file
5
offline/packages/json.more.net/1.8.0/.nupkg.metadata
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "JWxlYwCSYXZIWezmrvRgaxhI/vEEpQlZVm6/lskuS7p/uPrNJzQxbe2CPjzkF3UUz4RI8WkmObs6ycpxoE9T7w==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
offline/packages/json.more.net/1.8.0/.signature.p7s
vendored
Normal file
BIN
offline/packages/json.more.net/1.8.0/.signature.p7s
vendored
Normal file
Binary file not shown.
21
offline/packages/json.more.net/1.8.0/Json.More.Net.nuspec
vendored
Normal file
21
offline/packages/json.more.net/1.8.0/Json.More.Net.nuspec
vendored
Normal 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>
|
||||
21
offline/packages/json.more.net/1.8.0/LICENSE
vendored
Normal file
21
offline/packages/json.more.net/1.8.0/LICENSE
vendored
Normal 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.
|
||||
BIN
offline/packages/json.more.net/1.8.0/json-logo-256.png
vendored
Normal file
BIN
offline/packages/json.more.net/1.8.0/json-logo-256.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
offline/packages/json.more.net/1.8.0/json.more.net.1.8.0.nupkg
vendored
Normal file
BIN
offline/packages/json.more.net/1.8.0/json.more.net.1.8.0.nupkg
vendored
Normal file
Binary file not shown.
1
offline/packages/json.more.net/1.8.0/json.more.net.1.8.0.nupkg.sha512
vendored
Normal file
1
offline/packages/json.more.net/1.8.0/json.more.net.1.8.0.nupkg.sha512
vendored
Normal file
@@ -0,0 +1 @@
|
||||
2mKdoLpi93pC7IYaoFxb//PopX3i+xrqtgbp0mfbMRl5WdjiPBoa8cY8irAI87NJNCjFOgbF2POSjTnILYRSYg==
|
||||
495
offline/packages/json.more.net/1.8.0/lib/netstandard2.0/Json.More.xml
vendored
Normal file
495
offline/packages/json.more.net/1.8.0/lib/netstandard2.0/Json.More.xml
vendored
Normal 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>
|
||||
5
offline/packages/json.more.net/1.9.0/.nupkg.metadata
vendored
Normal file
5
offline/packages/json.more.net/1.9.0/.nupkg.metadata
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "MMjd2dOh32hLbcZg9YyA+7aEH9gu2cMTEAWrQY17in4+aEsPg2NtYTcwgWHJS9Tt2WUx+4iN1mNegR2uiEwsVQ==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
offline/packages/json.more.net/1.9.0/.signature.p7s
vendored
Normal file
BIN
offline/packages/json.more.net/1.9.0/.signature.p7s
vendored
Normal file
Binary file not shown.
23
offline/packages/json.more.net/1.9.0/Json.More.Net.nuspec
vendored
Normal file
23
offline/packages/json.more.net/1.9.0/Json.More.Net.nuspec
vendored
Normal 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>
|
||||
21
offline/packages/json.more.net/1.9.0/LICENSE
vendored
Normal file
21
offline/packages/json.more.net/1.9.0/LICENSE
vendored
Normal 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.
|
||||
BIN
offline/packages/json.more.net/1.9.0/json-logo-256.png
vendored
Normal file
BIN
offline/packages/json.more.net/1.9.0/json-logo-256.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
offline/packages/json.more.net/1.9.0/json.more.net.1.9.0.nupkg
vendored
Normal file
BIN
offline/packages/json.more.net/1.9.0/json.more.net.1.9.0.nupkg
vendored
Normal file
Binary file not shown.
1
offline/packages/json.more.net/1.9.0/json.more.net.1.9.0.nupkg.sha512
vendored
Normal file
1
offline/packages/json.more.net/1.9.0/json.more.net.1.9.0.nupkg.sha512
vendored
Normal file
@@ -0,0 +1 @@
|
||||
seto9EQl9vqHW5L6WavB5hSPUgVYyG6fCQiEAZyFJOrIY6lvIdl6WJu2E6FzyIjFg0kwG2QqzOO5oAZbO0Kn7Q==
|
||||
513
offline/packages/json.more.net/1.9.0/lib/netstandard2.0/Json.More.xml
vendored
Normal file
513
offline/packages/json.more.net/1.9.0/lib/netstandard2.0/Json.More.xml
vendored
Normal 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>
|
||||
5
offline/packages/jsonpointer.net/3.0.3/.nupkg.metadata
vendored
Normal file
5
offline/packages/jsonpointer.net/3.0.3/.nupkg.metadata
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "mCGQc15lHLp1R2CVhWiipnZurHXm93+LbPPAT/vXQm5PdHt6WQuYLhaEF8VZ+aXL9P2I6bGND6pDTEfqFs6gig==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
offline/packages/jsonpointer.net/3.0.3/.signature.p7s
vendored
Normal file
BIN
offline/packages/jsonpointer.net/3.0.3/.signature.p7s
vendored
Normal file
Binary file not shown.
23
offline/packages/jsonpointer.net/3.0.3/JsonPointer.Net.nuspec
vendored
Normal file
23
offline/packages/jsonpointer.net/3.0.3/JsonPointer.Net.nuspec
vendored
Normal 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>
|
||||
21
offline/packages/jsonpointer.net/3.0.3/LICENSE
vendored
Normal file
21
offline/packages/jsonpointer.net/3.0.3/LICENSE
vendored
Normal 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.
|
||||
BIN
offline/packages/jsonpointer.net/3.0.3/json-logo-256.png
vendored
Normal file
BIN
offline/packages/jsonpointer.net/3.0.3/json-logo-256.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
offline/packages/jsonpointer.net/3.0.3/jsonpointer.net.3.0.3.nupkg
vendored
Normal file
BIN
offline/packages/jsonpointer.net/3.0.3/jsonpointer.net.3.0.3.nupkg
vendored
Normal file
Binary file not shown.
1
offline/packages/jsonpointer.net/3.0.3/jsonpointer.net.3.0.3.nupkg.sha512
vendored
Normal file
1
offline/packages/jsonpointer.net/3.0.3/jsonpointer.net.3.0.3.nupkg.sha512
vendored
Normal file
@@ -0,0 +1 @@
|
||||
06iP664rFlvqSKFb14XWPbBixabRmldIsruIKqvFFdnSNiaVp1AE/vJBnUXc6If5mmj5gj42/ldCklkXGphXzA==
|
||||
392
offline/packages/jsonpointer.net/3.0.3/lib/netstandard2.0/JsonPointer.Net.xml
vendored
Normal file
392
offline/packages/jsonpointer.net/3.0.3/lib/netstandard2.0/JsonPointer.Net.xml
vendored
Normal 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>
|
||||
5
offline/packages/jsonschema.net/5.3.0/.nupkg.metadata
vendored
Normal file
5
offline/packages/jsonschema.net/5.3.0/.nupkg.metadata
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "XZy99hxNUl99TbV4PEqoCYDJZmgm1VNoFARISfZb9vmIAYbzrEdt8wWBEgDbCWi6A0/kTlf0nXT6YFXDFcx79w==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
offline/packages/jsonschema.net/5.3.0/.signature.p7s
vendored
Normal file
BIN
offline/packages/jsonschema.net/5.3.0/.signature.p7s
vendored
Normal file
Binary file not shown.
24
offline/packages/jsonschema.net/5.3.0/JsonSchema.Net.nuspec
vendored
Normal file
24
offline/packages/jsonschema.net/5.3.0/JsonSchema.Net.nuspec
vendored
Normal 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>
|
||||
BIN
offline/packages/jsonschema.net/5.3.0/json-logo-256.png
vendored
Normal file
BIN
offline/packages/jsonschema.net/5.3.0/json-logo-256.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
offline/packages/jsonschema.net/5.3.0/jsonschema.net.5.3.0.nupkg
vendored
Normal file
BIN
offline/packages/jsonschema.net/5.3.0/jsonschema.net.5.3.0.nupkg
vendored
Normal file
Binary file not shown.
1
offline/packages/jsonschema.net/5.3.0/jsonschema.net.5.3.0.nupkg.sha512
vendored
Normal file
1
offline/packages/jsonschema.net/5.3.0/jsonschema.net.5.3.0.nupkg.sha512
vendored
Normal file
@@ -0,0 +1 @@
|
||||
pFJnvHzzDDFvhyDLLDGbKyn6uNLA1PhJ46Ufkwzr9uukmXWgLyiXIs81UUw/ZQ5pDfKUZmz/4LMUrg2/KjgbJw==
|
||||
6310
offline/packages/jsonschema.net/5.3.0/lib/netstandard2.0/JsonSchema.Net.xml
vendored
Normal file
6310
offline/packages/jsonschema.net/5.3.0/lib/netstandard2.0/JsonSchema.Net.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
5
offline/packages/konscious.security.cryptography.argon2/1.3.1/.nupkg.metadata
vendored
Normal file
5
offline/packages/konscious.security.cryptography.argon2/1.3.1/.nupkg.metadata
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "T+OAGwzYYXftahpOxO7J4xA5K6urxwGnWQf3M+Jpi+76Azv/0T3M5SuN+h7/QvXuiqNw3ZEZ5QqVLI5ygDAylw==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
offline/packages/konscious.security.cryptography.argon2/1.3.1/.signature.p7s
vendored
Normal file
BIN
offline/packages/konscious.security.cryptography.argon2/1.3.1/.signature.p7s
vendored
Normal file
Binary file not shown.
@@ -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>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
YwEXnb1WCz9O2LgazA5lhR0sYKbExVUu3QWKNskV0WFdLcaooeZdmH2gLY+shAmqWS105/8F5RDbESp5OsdOpw==
|
||||
@@ -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>
|
||||
@@ -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>
|
||||
@@ -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>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user