Refactor code structure for improved readability and maintainability; removed redundant code blocks and optimized function calls.
This commit is contained in:
BIN
local-nugets/StellaOps.Policy.AuthSignals.0.1.0-alpha.nupkg
Normal file
BIN
local-nugets/StellaOps.Policy.AuthSignals.0.1.0-alpha.nupkg
Normal file
Binary file not shown.
5
local-nugets/cronos/0.10.0/.nupkg.metadata
Normal file
5
local-nugets/cronos/0.10.0/.nupkg.metadata
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "wHL4tr8mWTvrJt/4sI3raympCNVT4F3VJI4SJHA9A/wB+8Lsq84RFGQH9bHEtvNsN1lCBTKNk+uVoDotGcYJZA==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
local-nugets/cronos/0.10.0/.signature.p7s
Normal file
BIN
local-nugets/cronos/0.10.0/.signature.p7s
Normal file
Binary file not shown.
30
local-nugets/cronos/0.10.0/Cronos.nuspec
Normal file
30
local-nugets/cronos/0.10.0/Cronos.nuspec
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
local-nugets/cronos/0.10.0/LICENSE
Normal file
21
local-nugets/cronos/0.10.0/LICENSE
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
local-nugets/cronos/0.10.0/README.md
Normal file
292
local-nugets/cronos/0.10.0/README.md
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
local-nugets/cronos/0.10.0/cronos.0.10.0.nupkg
Normal file
BIN
local-nugets/cronos/0.10.0/cronos.0.10.0.nupkg
Normal file
Binary file not shown.
1
local-nugets/cronos/0.10.0/cronos.0.10.0.nupkg.sha512
Normal file
1
local-nugets/cronos/0.10.0/cronos.0.10.0.nupkg.sha512
Normal file
@@ -0,0 +1 @@
|
||||
64VD5LS+VkoELCZnpOPRbc/jtYbKFdNFIykE/Pm7O+XB0zbwZyDQmrwYeQN6BLmmmevW/zDhBsK91Yrh0vinjQ==
|
||||
BIN
local-nugets/cronos/0.10.0/icon.png
Normal file
BIN
local-nugets/cronos/0.10.0/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.2 KiB |
211
local-nugets/cronos/0.10.0/lib/net40/Cronos.xml
Normal file
211
local-nugets/cronos/0.10.0/lib/net40/Cronos.xml
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
local-nugets/cronos/0.10.0/lib/net45/Cronos.xml
Normal file
211
local-nugets/cronos/0.10.0/lib/net45/Cronos.xml
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
local-nugets/cronos/0.10.0/lib/net6.0/Cronos.xml
Normal file
211
local-nugets/cronos/0.10.0/lib/net6.0/Cronos.xml
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
local-nugets/cronos/0.10.0/lib/netstandard1.0/Cronos.xml
Normal file
208
local-nugets/cronos/0.10.0/lib/netstandard1.0/Cronos.xml
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
local-nugets/cronos/0.10.0/lib/netstandard2.0/Cronos.xml
Normal file
211
local-nugets/cronos/0.10.0/lib/netstandard2.0/Cronos.xml
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
local-nugets/dnsclient/1.6.1/.nupkg.metadata
Normal file
5
local-nugets/dnsclient/1.6.1/.nupkg.metadata
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
local-nugets/dnsclient/1.6.1/.signature.p7s
Normal file
BIN
local-nugets/dnsclient/1.6.1/.signature.p7s
Normal file
Binary file not shown.
45
local-nugets/dnsclient/1.6.1/DnsClient.nuspec
Normal file
45
local-nugets/dnsclient/1.6.1/DnsClient.nuspec
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
local-nugets/dnsclient/1.6.1/dnsclient.1.6.1.nupkg
Normal file
BIN
local-nugets/dnsclient/1.6.1/dnsclient.1.6.1.nupkg
Normal file
Binary file not shown.
@@ -0,0 +1 @@
|
||||
zFRP0MFIwSEYYo6wcLc7bFJANsVY6tj08Vkq+8x6xbz0hvYqTmMM76Eg9mbzoWbDuJWWrWIDlmt/Ia7HwrPVXg==
|
||||
BIN
local-nugets/dnsclient/1.6.1/icon.png
Normal file
BIN
local-nugets/dnsclient/1.6.1/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
5071
local-nugets/dnsclient/1.6.1/lib/net45/DnsClient.xml
Normal file
5071
local-nugets/dnsclient/1.6.1/lib/net45/DnsClient.xml
Normal file
File diff suppressed because it is too large
Load Diff
5090
local-nugets/dnsclient/1.6.1/lib/net471/DnsClient.xml
Normal file
5090
local-nugets/dnsclient/1.6.1/lib/net471/DnsClient.xml
Normal file
File diff suppressed because it is too large
Load Diff
5090
local-nugets/dnsclient/1.6.1/lib/net5.0/DnsClient.xml
Normal file
5090
local-nugets/dnsclient/1.6.1/lib/net5.0/DnsClient.xml
Normal file
File diff suppressed because it is too large
Load Diff
5090
local-nugets/dnsclient/1.6.1/lib/netstandard1.3/DnsClient.xml
Normal file
5090
local-nugets/dnsclient/1.6.1/lib/netstandard1.3/DnsClient.xml
Normal file
File diff suppressed because it is too large
Load Diff
5090
local-nugets/dnsclient/1.6.1/lib/netstandard2.0/DnsClient.xml
Normal file
5090
local-nugets/dnsclient/1.6.1/lib/netstandard2.0/DnsClient.xml
Normal file
File diff suppressed because it is too large
Load Diff
5090
local-nugets/dnsclient/1.6.1/lib/netstandard2.1/DnsClient.xml
Normal file
5090
local-nugets/dnsclient/1.6.1/lib/netstandard2.1/DnsClient.xml
Normal file
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "H+i/Qy30Rg/K9BcW2Z6DCHPCzwMH3bCwNOjEz31shWTUDK8GeeeMnrKVusprTcRA2Y6yPST+hg2zc3whPEs14Q==",
|
||||
"source": "/mnt/e/dev/git.stella-ops.org/local-nugets"
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@@ -0,0 +1,36 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Configuration.Abstractions</id>
|
||||
<version>10.0.0-rc.2.25502.107</version>
|
||||
<authors>Microsoft</authors>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>Icon.png</icon>
|
||||
<readme>PACKAGE.md</readme>
|
||||
<projectUrl>https://dot.net/</projectUrl>
|
||||
<description>Provides abstractions of key-value pair based configuration. Interfaces defined in this package are implemented by classes in Microsoft.Extensions.Configuration and other configuration packages.</description>
|
||||
<releaseNotes>https://go.microsoft.com/fwlink/?LinkID=799421</releaseNotes>
|
||||
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
|
||||
<serviceable>true</serviceable>
|
||||
<repository type="git" url="https://github.com/dotnet/dotnet" commit="89c8f6a112d37d2ea8b77821e56d170a1bccdc5a" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.6.2">
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="System.ValueTuple" version="4.6.1" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net8.0">
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net9.0">
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net10.0">
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
@@ -0,0 +1,82 @@
|
||||
## About
|
||||
|
||||
<!-- A description of the package and where one can find more documentation -->
|
||||
|
||||
Provides abstractions of key-value pair based configuration. Interfaces defined in this package are implemented by classes in [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/) and other configuration packages.
|
||||
|
||||
## Key Features
|
||||
|
||||
<!-- The key features of this package -->
|
||||
|
||||
* Abstractions for string key-value pair configuration sources and sections
|
||||
* Path conventions of keys establishing a heirachy of values
|
||||
* Support for multiple configuration sources, aggregating and defining precdence for values
|
||||
* Support for reload on change
|
||||
|
||||
## How to Use
|
||||
|
||||
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
|
||||
|
||||
The example below shows a small code sample using this library and trying out the `ConfigurationKeyName` attribute available since .NET 6:
|
||||
|
||||
```cs
|
||||
public class MyClass
|
||||
{
|
||||
[ConfigurationKeyName("named_property")]
|
||||
public string NamedProperty { get; set; }
|
||||
}
|
||||
```
|
||||
|
||||
Given the simple class above, we can create a dictionary to hold the configuration data and use it as the memory source to build a configuration section:
|
||||
|
||||
```cs
|
||||
var dic = new Dictionary<string, string>
|
||||
{
|
||||
{"named_property", "value for named property"},
|
||||
};
|
||||
|
||||
var config = new ConfigurationBuilder()
|
||||
.AddInMemoryCollection(dic)
|
||||
.Build();
|
||||
|
||||
var options = config.Get<MyClass>();
|
||||
Console.WriteLine(options.NamedProperty); // returns "value for named property"
|
||||
```
|
||||
|
||||
## Main Types
|
||||
|
||||
<!-- The main types provided in this library -->
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `Microsoft.Extensions.Configuration.IConfiguration`
|
||||
* `Microsoft.Extensions.Configuration.IConfigurationBuilder`
|
||||
* `Microsoft.Extensions.Configuration.IConfigurationProvider`
|
||||
* `Microsoft.Extensions.Configuration.IConfigurationRoot`
|
||||
* `Microsoft.Extensions.Configuration.IConfigurationSection`
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
<!-- Links to further documentation -->
|
||||
|
||||
* [Configuration in .NET](https://learn.microsoft.com/dotnet/core/extensions/configuration)
|
||||
* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration)
|
||||
|
||||
## Related Packages
|
||||
|
||||
<!-- The related packages associated with this package -->
|
||||
* [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration)
|
||||
* [Microsoft.Extensions.Configuration.Binder](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.Binder)
|
||||
* [Microsoft.Extensions.Configuration.CommandLine](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.CommandLine)
|
||||
* [Microsoft.Extensions.Configuration.EnvironmentVariables](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.EnvironmentVariables)
|
||||
* [Microsoft.Extensions.Configuration.FileExtensions](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.FileExtensions)
|
||||
* [Microsoft.Extensions.Configuration.Ini](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.Ini)
|
||||
* [Microsoft.Extensions.Configuration.Json](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.Json)
|
||||
* [Microsoft.Extensions.Configuration.UserSecrets](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.UserSecrets)
|
||||
* [Microsoft.Extensions.Configuration.Xml](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.Xml)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
<!-- How to provide feedback on this package and contribute to it -->
|
||||
|
||||
Microsoft.Extensions.Caching.Abstractions is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Configuration_Abstractions_net462">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Configuration_Abstractions_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Configuration.Abstractions 10.0.0-rc.2.25502.107 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net462 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Configuration_Abstractions_net8_0">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Configuration_Abstractions_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Configuration.Abstractions 10.0.0-rc.2.25502.107 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net8.0 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,341 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext">
|
||||
<summary>
|
||||
Provides data about the current item of the configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.#ctor(System.String,System.String,System.String,Microsoft.Extensions.Configuration.IConfigurationProvider)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext"/>.
|
||||
</summary>
|
||||
<param name="path">The path of the current item of the configuration.</param>
|
||||
<param name="key">The key of the current item of the configuration.</param>
|
||||
<param name="value">The value of the current item of the configuration.</param>
|
||||
<param name="configurationProvider">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> to use to get the value of the current item.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Path">
|
||||
<summary>
|
||||
Gets the path of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Key">
|
||||
<summary>
|
||||
Gets the key of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Value">
|
||||
<summary>
|
||||
Gets the value of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.ConfigurationProvider">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> that was used to get the value of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationExtensions">
|
||||
<summary>
|
||||
Provides extension methods for configuration classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Add``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{``0})">
|
||||
<summary>
|
||||
Adds a new configuration source.
|
||||
</summary>
|
||||
<param name="builder">The builder to add to.</param>
|
||||
<param name="configureSource">Configures the source secrets.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetConnectionString(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Gets the specified connection string from the specified configuration.
|
||||
Shorthand for <c>GetSection("ConnectionStrings")[name]</c>.
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<param name="name">The connection string key.</param>
|
||||
<returns>The connection string.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<returns>An enumeration of key value pairs.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration,System.Boolean)">
|
||||
<summary>
|
||||
Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<param name="makePathsRelative"><see langword="true" /> to trim the current configuration's path from the front of the returned child keys.</param>
|
||||
<returns>An enumeration of key value pairs.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Exists(Microsoft.Extensions.Configuration.IConfigurationSection)">
|
||||
<summary>
|
||||
Determines whether the section has a <see cref="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value"/> or has children.
|
||||
</summary>
|
||||
<param name="section">The section to enumerate.</param>
|
||||
<returns><see langword="true" /> if the section has values or children; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetRequiredSection(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Gets a configuration subsection with the specified key.
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<param name="key">The key of the configuration section.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
|
||||
<remarks>
|
||||
If no matching sub-section is found with the specified key, an exception is raised.
|
||||
</remarks>
|
||||
<exception cref="T:System.InvalidOperationException">There is no section with key <paramref name="key"/>.</exception>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute">
|
||||
<summary>
|
||||
Specifies the key name for a configuration property.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute"/>.
|
||||
</summary>
|
||||
<param name="name">The key name.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute.Name">
|
||||
<summary>
|
||||
Gets the key name for a configuration property.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationPath">
|
||||
<summary>
|
||||
Provides utility methods and constants for manipulating Configuration paths.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Configuration.ConfigurationPath.KeyDelimiter">
|
||||
<summary>
|
||||
The delimiter ":" used to separate individual keys in a path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.String[])">
|
||||
<summary>
|
||||
Combines path segments into one path.
|
||||
</summary>
|
||||
<param name="pathSegments">The path segments to combine.</param>
|
||||
<returns>The combined path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.Collections.Generic.IEnumerable{System.String})">
|
||||
<summary>
|
||||
Combines path segments into one path.
|
||||
</summary>
|
||||
<param name="pathSegments">The path segments to combine.</param>
|
||||
<returns>The combined path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetSectionKey(System.String)">
|
||||
<summary>
|
||||
Extracts the last path segment from the path.
|
||||
</summary>
|
||||
<param name="path">The path.</param>
|
||||
<returns>The last path segment of the path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetParentPath(System.String)">
|
||||
<summary>
|
||||
Extracts the path corresponding to the parent node for a given path.
|
||||
</summary>
|
||||
<param name="path">The path.</param>
|
||||
<returns>The original path minus the last individual segment found in it. Null if the original path corresponds to a top level node.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationRootExtensions">
|
||||
<summary>
|
||||
Provides extension methods for <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot)">
|
||||
<summary>
|
||||
Generates a human-readable view of the configuration showing where each value came from.
|
||||
</summary>
|
||||
<returns>The debug view.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot,System.Func{Microsoft.Extensions.Configuration.ConfigurationDebugViewContext,System.String})">
|
||||
<summary>
|
||||
Generates a human-readable view of the configuration showing where each value came from.
|
||||
</summary>
|
||||
<param name="root">The configuration root.</param>
|
||||
<param name="processValue">
|
||||
The function for processing the value, for example, hiding secrets.
|
||||
Parameters:
|
||||
ConfigurationDebugViewContext: Context of the current configuration item.
|
||||
returns: A string value is used to assign as the Value of the configuration section.
|
||||
</param>
|
||||
<returns>The debug view.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfiguration">
|
||||
<summary>
|
||||
Represents a set of key/value application configuration properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfiguration.Item(System.String)">
|
||||
<summary>
|
||||
Gets or sets a configuration value.
|
||||
</summary>
|
||||
<param name="key">The configuration key.</param>
|
||||
<returns>The configuration value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetSection(System.String)">
|
||||
<summary>
|
||||
Gets a configuration sub-section with the specified key.
|
||||
</summary>
|
||||
<param name="key">The key of the configuration section.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
|
||||
<remarks>
|
||||
This method will never return <c>null</c>. If no matching sub-section is found with the specified key,
|
||||
an empty <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/> will be returned.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetChildren">
|
||||
<summary>
|
||||
Gets the immediate descendant configuration sub-sections.
|
||||
</summary>
|
||||
<returns>The configuration sub-sections.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetReloadToken">
|
||||
<summary>
|
||||
Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that can be used to observe when this configuration is reloaded.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> token if this provider supports change tracking; otherwise, <see langword="null" />.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationBuilder">
|
||||
<summary>
|
||||
Represents a type used to build application configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties">
|
||||
<summary>
|
||||
Gets a key/value collection that can be used to share data between the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>
|
||||
and the registered <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>s.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources">
|
||||
<summary>
|
||||
Gets the sources used to obtain configuration values
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Add(Microsoft.Extensions.Configuration.IConfigurationSource)">
|
||||
<summary>
|
||||
Adds a new configuration source.
|
||||
</summary>
|
||||
<param name="source">The configuration source to add.</param>
|
||||
<returns>The same <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Build">
|
||||
<summary>
|
||||
Builds an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> with keys and values from the set of sources registered in
|
||||
<see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources"/>.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/> with keys and values from the registered sources.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationManager">
|
||||
<summary>
|
||||
Represents a mutable configuration object.
|
||||
</summary>
|
||||
<remarks>
|
||||
It is both an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> and an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
|
||||
As sources are added, it updates its current view of configuration.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationProvider">
|
||||
<summary>
|
||||
Provides configuration key/values for an application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.TryGet(System.String,System.String@)">
|
||||
<summary>
|
||||
Tries to get a configuration value for the specified key.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<param name="value">When this method returns, contains the value for the specified key.</param>
|
||||
<returns><see langword="true" /> if a value for the specified key was found, otherwise <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Set(System.String,System.String)">
|
||||
<summary>
|
||||
Sets a configuration value for the specified key.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<param name="value">The value.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetReloadToken">
|
||||
<summary>
|
||||
Attempts to get an <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> for change tracking.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> token if this provider supports change tracking, <see langword="null"/> otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads configuration values from the source represented by this <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetChildKeys(System.Collections.Generic.IEnumerable{System.String},System.String)">
|
||||
<summary>
|
||||
Returns the immediate descendant configuration keys for a given parent path based on the data of this
|
||||
<see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> and the set of keys returned by all the preceding
|
||||
<see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> providers.
|
||||
</summary>
|
||||
<param name="earlierKeys">The child keys returned by the preceding providers for the same parent path.</param>
|
||||
<param name="parentPath">The parent path.</param>
|
||||
<returns>The child keys.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationRoot">
|
||||
<summary>
|
||||
Represents the root of an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> hierarchy.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationRoot.Reload">
|
||||
<summary>
|
||||
Forces the configuration values to be reloaded from the underlying <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> providers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationRoot.Providers">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> providers for this configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationSection">
|
||||
<summary>
|
||||
Represents a section of application configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Key">
|
||||
<summary>
|
||||
Gets the key this section occupies in its parent.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Path">
|
||||
<summary>
|
||||
Gets the full path to this section within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value">
|
||||
<summary>
|
||||
Gets or sets the section value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationSource">
|
||||
<summary>
|
||||
Represents a source of configuration key/values for an application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>
|
||||
</member>
|
||||
<member name="P:System.SR.InvalidSectionName">
|
||||
<summary>Section '{0}' not found in configuration.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,524 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext">
|
||||
<summary>
|
||||
Provides data about the current item of the configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.#ctor(System.String,System.String,System.String,Microsoft.Extensions.Configuration.IConfigurationProvider)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext"/>.
|
||||
</summary>
|
||||
<param name="path">The path of the current item of the configuration.</param>
|
||||
<param name="key">The key of the current item of the configuration.</param>
|
||||
<param name="value">The value of the current item of the configuration.</param>
|
||||
<param name="configurationProvider">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> to use to get the value of the current item.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Path">
|
||||
<summary>
|
||||
Gets the path of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Key">
|
||||
<summary>
|
||||
Gets the key of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Value">
|
||||
<summary>
|
||||
Gets the value of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.ConfigurationProvider">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> that was used to get the value of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationExtensions">
|
||||
<summary>
|
||||
Provides extension methods for configuration classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Add``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{``0})">
|
||||
<summary>
|
||||
Adds a new configuration source.
|
||||
</summary>
|
||||
<param name="builder">The builder to add to.</param>
|
||||
<param name="configureSource">Configures the source secrets.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetConnectionString(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Gets the specified connection string from the specified configuration.
|
||||
Shorthand for <c>GetSection("ConnectionStrings")[name]</c>.
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<param name="name">The connection string key.</param>
|
||||
<returns>The connection string.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<returns>An enumeration of key value pairs.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration,System.Boolean)">
|
||||
<summary>
|
||||
Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<param name="makePathsRelative"><see langword="true" /> to trim the current configuration's path from the front of the returned child keys.</param>
|
||||
<returns>An enumeration of key value pairs.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Exists(Microsoft.Extensions.Configuration.IConfigurationSection)">
|
||||
<summary>
|
||||
Determines whether the section has a <see cref="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value"/> or has children.
|
||||
</summary>
|
||||
<param name="section">The section to enumerate.</param>
|
||||
<returns><see langword="true" /> if the section has values or children; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetRequiredSection(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Gets a configuration subsection with the specified key.
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<param name="key">The key of the configuration section.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
|
||||
<remarks>
|
||||
If no matching sub-section is found with the specified key, an exception is raised.
|
||||
</remarks>
|
||||
<exception cref="T:System.InvalidOperationException">There is no section with key <paramref name="key"/>.</exception>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute">
|
||||
<summary>
|
||||
Specifies the key name for a configuration property.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute"/>.
|
||||
</summary>
|
||||
<param name="name">The key name.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute.Name">
|
||||
<summary>
|
||||
Gets the key name for a configuration property.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationPath">
|
||||
<summary>
|
||||
Provides utility methods and constants for manipulating Configuration paths.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Configuration.ConfigurationPath.KeyDelimiter">
|
||||
<summary>
|
||||
The delimiter ":" used to separate individual keys in a path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.String[])">
|
||||
<summary>
|
||||
Combines path segments into one path.
|
||||
</summary>
|
||||
<param name="pathSegments">The path segments to combine.</param>
|
||||
<returns>The combined path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.Collections.Generic.IEnumerable{System.String})">
|
||||
<summary>
|
||||
Combines path segments into one path.
|
||||
</summary>
|
||||
<param name="pathSegments">The path segments to combine.</param>
|
||||
<returns>The combined path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetSectionKey(System.String)">
|
||||
<summary>
|
||||
Extracts the last path segment from the path.
|
||||
</summary>
|
||||
<param name="path">The path.</param>
|
||||
<returns>The last path segment of the path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetParentPath(System.String)">
|
||||
<summary>
|
||||
Extracts the path corresponding to the parent node for a given path.
|
||||
</summary>
|
||||
<param name="path">The path.</param>
|
||||
<returns>The original path minus the last individual segment found in it. Null if the original path corresponds to a top level node.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationRootExtensions">
|
||||
<summary>
|
||||
Provides extension methods for <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot)">
|
||||
<summary>
|
||||
Generates a human-readable view of the configuration showing where each value came from.
|
||||
</summary>
|
||||
<returns>The debug view.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot,System.Func{Microsoft.Extensions.Configuration.ConfigurationDebugViewContext,System.String})">
|
||||
<summary>
|
||||
Generates a human-readable view of the configuration showing where each value came from.
|
||||
</summary>
|
||||
<param name="root">The configuration root.</param>
|
||||
<param name="processValue">
|
||||
The function for processing the value, for example, hiding secrets.
|
||||
Parameters:
|
||||
ConfigurationDebugViewContext: Context of the current configuration item.
|
||||
returns: A string value is used to assign as the Value of the configuration section.
|
||||
</param>
|
||||
<returns>The debug view.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfiguration">
|
||||
<summary>
|
||||
Represents a set of key/value application configuration properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfiguration.Item(System.String)">
|
||||
<summary>
|
||||
Gets or sets a configuration value.
|
||||
</summary>
|
||||
<param name="key">The configuration key.</param>
|
||||
<returns>The configuration value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetSection(System.String)">
|
||||
<summary>
|
||||
Gets a configuration sub-section with the specified key.
|
||||
</summary>
|
||||
<param name="key">The key of the configuration section.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
|
||||
<remarks>
|
||||
This method will never return <c>null</c>. If no matching sub-section is found with the specified key,
|
||||
an empty <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/> will be returned.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetChildren">
|
||||
<summary>
|
||||
Gets the immediate descendant configuration sub-sections.
|
||||
</summary>
|
||||
<returns>The configuration sub-sections.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetReloadToken">
|
||||
<summary>
|
||||
Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that can be used to observe when this configuration is reloaded.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> token if this provider supports change tracking; otherwise, <see langword="null" />.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationBuilder">
|
||||
<summary>
|
||||
Represents a type used to build application configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties">
|
||||
<summary>
|
||||
Gets a key/value collection that can be used to share data between the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>
|
||||
and the registered <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>s.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources">
|
||||
<summary>
|
||||
Gets the sources used to obtain configuration values
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Add(Microsoft.Extensions.Configuration.IConfigurationSource)">
|
||||
<summary>
|
||||
Adds a new configuration source.
|
||||
</summary>
|
||||
<param name="source">The configuration source to add.</param>
|
||||
<returns>The same <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Build">
|
||||
<summary>
|
||||
Builds an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> with keys and values from the set of sources registered in
|
||||
<see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources"/>.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/> with keys and values from the registered sources.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationManager">
|
||||
<summary>
|
||||
Represents a mutable configuration object.
|
||||
</summary>
|
||||
<remarks>
|
||||
It is both an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> and an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
|
||||
As sources are added, it updates its current view of configuration.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationProvider">
|
||||
<summary>
|
||||
Provides configuration key/values for an application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.TryGet(System.String,System.String@)">
|
||||
<summary>
|
||||
Tries to get a configuration value for the specified key.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<param name="value">When this method returns, contains the value for the specified key.</param>
|
||||
<returns><see langword="true" /> if a value for the specified key was found, otherwise <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Set(System.String,System.String)">
|
||||
<summary>
|
||||
Sets a configuration value for the specified key.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<param name="value">The value.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetReloadToken">
|
||||
<summary>
|
||||
Attempts to get an <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> for change tracking.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> token if this provider supports change tracking, <see langword="null"/> otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads configuration values from the source represented by this <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetChildKeys(System.Collections.Generic.IEnumerable{System.String},System.String)">
|
||||
<summary>
|
||||
Returns the immediate descendant configuration keys for a given parent path based on the data of this
|
||||
<see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> and the set of keys returned by all the preceding
|
||||
<see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> providers.
|
||||
</summary>
|
||||
<param name="earlierKeys">The child keys returned by the preceding providers for the same parent path.</param>
|
||||
<param name="parentPath">The parent path.</param>
|
||||
<returns>The child keys.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationRoot">
|
||||
<summary>
|
||||
Represents the root of an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> hierarchy.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationRoot.Reload">
|
||||
<summary>
|
||||
Forces the configuration values to be reloaded from the underlying <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> providers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationRoot.Providers">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> providers for this configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationSection">
|
||||
<summary>
|
||||
Represents a section of application configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Key">
|
||||
<summary>
|
||||
Gets the key this section occupies in its parent.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Path">
|
||||
<summary>
|
||||
Gets the full path to this section within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value">
|
||||
<summary>
|
||||
Gets or sets the section value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationSource">
|
||||
<summary>
|
||||
Represents a source of configuration key/values for an application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>
|
||||
</member>
|
||||
<member name="P:System.SR.InvalidSectionName">
|
||||
<summary>Section '{0}' not found in configuration.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field or property member will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field and property members will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.ExceptionPolyfills">
|
||||
<summary>Provides downlevel polyfills for static methods on Exception-derived types.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,341 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext">
|
||||
<summary>
|
||||
Provides data about the current item of the configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.#ctor(System.String,System.String,System.String,Microsoft.Extensions.Configuration.IConfigurationProvider)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext"/>.
|
||||
</summary>
|
||||
<param name="path">The path of the current item of the configuration.</param>
|
||||
<param name="key">The key of the current item of the configuration.</param>
|
||||
<param name="value">The value of the current item of the configuration.</param>
|
||||
<param name="configurationProvider">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> to use to get the value of the current item.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Path">
|
||||
<summary>
|
||||
Gets the path of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Key">
|
||||
<summary>
|
||||
Gets the key of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Value">
|
||||
<summary>
|
||||
Gets the value of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.ConfigurationProvider">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> that was used to get the value of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationExtensions">
|
||||
<summary>
|
||||
Provides extension methods for configuration classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Add``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{``0})">
|
||||
<summary>
|
||||
Adds a new configuration source.
|
||||
</summary>
|
||||
<param name="builder">The builder to add to.</param>
|
||||
<param name="configureSource">Configures the source secrets.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetConnectionString(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Gets the specified connection string from the specified configuration.
|
||||
Shorthand for <c>GetSection("ConnectionStrings")[name]</c>.
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<param name="name">The connection string key.</param>
|
||||
<returns>The connection string.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<returns>An enumeration of key value pairs.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration,System.Boolean)">
|
||||
<summary>
|
||||
Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<param name="makePathsRelative"><see langword="true" /> to trim the current configuration's path from the front of the returned child keys.</param>
|
||||
<returns>An enumeration of key value pairs.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Exists(Microsoft.Extensions.Configuration.IConfigurationSection)">
|
||||
<summary>
|
||||
Determines whether the section has a <see cref="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value"/> or has children.
|
||||
</summary>
|
||||
<param name="section">The section to enumerate.</param>
|
||||
<returns><see langword="true" /> if the section has values or children; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetRequiredSection(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Gets a configuration subsection with the specified key.
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<param name="key">The key of the configuration section.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
|
||||
<remarks>
|
||||
If no matching sub-section is found with the specified key, an exception is raised.
|
||||
</remarks>
|
||||
<exception cref="T:System.InvalidOperationException">There is no section with key <paramref name="key"/>.</exception>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute">
|
||||
<summary>
|
||||
Specifies the key name for a configuration property.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute"/>.
|
||||
</summary>
|
||||
<param name="name">The key name.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute.Name">
|
||||
<summary>
|
||||
Gets the key name for a configuration property.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationPath">
|
||||
<summary>
|
||||
Provides utility methods and constants for manipulating Configuration paths.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Configuration.ConfigurationPath.KeyDelimiter">
|
||||
<summary>
|
||||
The delimiter ":" used to separate individual keys in a path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.String[])">
|
||||
<summary>
|
||||
Combines path segments into one path.
|
||||
</summary>
|
||||
<param name="pathSegments">The path segments to combine.</param>
|
||||
<returns>The combined path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.Collections.Generic.IEnumerable{System.String})">
|
||||
<summary>
|
||||
Combines path segments into one path.
|
||||
</summary>
|
||||
<param name="pathSegments">The path segments to combine.</param>
|
||||
<returns>The combined path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetSectionKey(System.String)">
|
||||
<summary>
|
||||
Extracts the last path segment from the path.
|
||||
</summary>
|
||||
<param name="path">The path.</param>
|
||||
<returns>The last path segment of the path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetParentPath(System.String)">
|
||||
<summary>
|
||||
Extracts the path corresponding to the parent node for a given path.
|
||||
</summary>
|
||||
<param name="path">The path.</param>
|
||||
<returns>The original path minus the last individual segment found in it. Null if the original path corresponds to a top level node.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationRootExtensions">
|
||||
<summary>
|
||||
Provides extension methods for <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot)">
|
||||
<summary>
|
||||
Generates a human-readable view of the configuration showing where each value came from.
|
||||
</summary>
|
||||
<returns>The debug view.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot,System.Func{Microsoft.Extensions.Configuration.ConfigurationDebugViewContext,System.String})">
|
||||
<summary>
|
||||
Generates a human-readable view of the configuration showing where each value came from.
|
||||
</summary>
|
||||
<param name="root">The configuration root.</param>
|
||||
<param name="processValue">
|
||||
The function for processing the value, for example, hiding secrets.
|
||||
Parameters:
|
||||
ConfigurationDebugViewContext: Context of the current configuration item.
|
||||
returns: A string value is used to assign as the Value of the configuration section.
|
||||
</param>
|
||||
<returns>The debug view.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfiguration">
|
||||
<summary>
|
||||
Represents a set of key/value application configuration properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfiguration.Item(System.String)">
|
||||
<summary>
|
||||
Gets or sets a configuration value.
|
||||
</summary>
|
||||
<param name="key">The configuration key.</param>
|
||||
<returns>The configuration value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetSection(System.String)">
|
||||
<summary>
|
||||
Gets a configuration sub-section with the specified key.
|
||||
</summary>
|
||||
<param name="key">The key of the configuration section.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
|
||||
<remarks>
|
||||
This method will never return <c>null</c>. If no matching sub-section is found with the specified key,
|
||||
an empty <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/> will be returned.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetChildren">
|
||||
<summary>
|
||||
Gets the immediate descendant configuration sub-sections.
|
||||
</summary>
|
||||
<returns>The configuration sub-sections.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetReloadToken">
|
||||
<summary>
|
||||
Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that can be used to observe when this configuration is reloaded.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> token if this provider supports change tracking; otherwise, <see langword="null" />.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationBuilder">
|
||||
<summary>
|
||||
Represents a type used to build application configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties">
|
||||
<summary>
|
||||
Gets a key/value collection that can be used to share data between the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>
|
||||
and the registered <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>s.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources">
|
||||
<summary>
|
||||
Gets the sources used to obtain configuration values
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Add(Microsoft.Extensions.Configuration.IConfigurationSource)">
|
||||
<summary>
|
||||
Adds a new configuration source.
|
||||
</summary>
|
||||
<param name="source">The configuration source to add.</param>
|
||||
<returns>The same <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Build">
|
||||
<summary>
|
||||
Builds an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> with keys and values from the set of sources registered in
|
||||
<see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources"/>.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/> with keys and values from the registered sources.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationManager">
|
||||
<summary>
|
||||
Represents a mutable configuration object.
|
||||
</summary>
|
||||
<remarks>
|
||||
It is both an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> and an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
|
||||
As sources are added, it updates its current view of configuration.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationProvider">
|
||||
<summary>
|
||||
Provides configuration key/values for an application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.TryGet(System.String,System.String@)">
|
||||
<summary>
|
||||
Tries to get a configuration value for the specified key.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<param name="value">When this method returns, contains the value for the specified key.</param>
|
||||
<returns><see langword="true" /> if a value for the specified key was found, otherwise <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Set(System.String,System.String)">
|
||||
<summary>
|
||||
Sets a configuration value for the specified key.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<param name="value">The value.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetReloadToken">
|
||||
<summary>
|
||||
Attempts to get an <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> for change tracking.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> token if this provider supports change tracking, <see langword="null"/> otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads configuration values from the source represented by this <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetChildKeys(System.Collections.Generic.IEnumerable{System.String},System.String)">
|
||||
<summary>
|
||||
Returns the immediate descendant configuration keys for a given parent path based on the data of this
|
||||
<see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> and the set of keys returned by all the preceding
|
||||
<see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> providers.
|
||||
</summary>
|
||||
<param name="earlierKeys">The child keys returned by the preceding providers for the same parent path.</param>
|
||||
<param name="parentPath">The parent path.</param>
|
||||
<returns>The child keys.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationRoot">
|
||||
<summary>
|
||||
Represents the root of an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> hierarchy.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationRoot.Reload">
|
||||
<summary>
|
||||
Forces the configuration values to be reloaded from the underlying <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> providers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationRoot.Providers">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> providers for this configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationSection">
|
||||
<summary>
|
||||
Represents a section of application configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Key">
|
||||
<summary>
|
||||
Gets the key this section occupies in its parent.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Path">
|
||||
<summary>
|
||||
Gets the full path to this section within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value">
|
||||
<summary>
|
||||
Gets or sets the section value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationSource">
|
||||
<summary>
|
||||
Represents a source of configuration key/values for an application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>
|
||||
</member>
|
||||
<member name="P:System.SR.InvalidSectionName">
|
||||
<summary>Section '{0}' not found in configuration.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,341 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext">
|
||||
<summary>
|
||||
Provides data about the current item of the configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.#ctor(System.String,System.String,System.String,Microsoft.Extensions.Configuration.IConfigurationProvider)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext"/>.
|
||||
</summary>
|
||||
<param name="path">The path of the current item of the configuration.</param>
|
||||
<param name="key">The key of the current item of the configuration.</param>
|
||||
<param name="value">The value of the current item of the configuration.</param>
|
||||
<param name="configurationProvider">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> to use to get the value of the current item.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Path">
|
||||
<summary>
|
||||
Gets the path of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Key">
|
||||
<summary>
|
||||
Gets the key of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Value">
|
||||
<summary>
|
||||
Gets the value of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.ConfigurationProvider">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> that was used to get the value of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationExtensions">
|
||||
<summary>
|
||||
Provides extension methods for configuration classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Add``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{``0})">
|
||||
<summary>
|
||||
Adds a new configuration source.
|
||||
</summary>
|
||||
<param name="builder">The builder to add to.</param>
|
||||
<param name="configureSource">Configures the source secrets.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetConnectionString(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Gets the specified connection string from the specified configuration.
|
||||
Shorthand for <c>GetSection("ConnectionStrings")[name]</c>.
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<param name="name">The connection string key.</param>
|
||||
<returns>The connection string.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<returns>An enumeration of key value pairs.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration,System.Boolean)">
|
||||
<summary>
|
||||
Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<param name="makePathsRelative"><see langword="true" /> to trim the current configuration's path from the front of the returned child keys.</param>
|
||||
<returns>An enumeration of key value pairs.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Exists(Microsoft.Extensions.Configuration.IConfigurationSection)">
|
||||
<summary>
|
||||
Determines whether the section has a <see cref="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value"/> or has children.
|
||||
</summary>
|
||||
<param name="section">The section to enumerate.</param>
|
||||
<returns><see langword="true" /> if the section has values or children; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetRequiredSection(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Gets a configuration subsection with the specified key.
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<param name="key">The key of the configuration section.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
|
||||
<remarks>
|
||||
If no matching sub-section is found with the specified key, an exception is raised.
|
||||
</remarks>
|
||||
<exception cref="T:System.InvalidOperationException">There is no section with key <paramref name="key"/>.</exception>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute">
|
||||
<summary>
|
||||
Specifies the key name for a configuration property.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute"/>.
|
||||
</summary>
|
||||
<param name="name">The key name.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute.Name">
|
||||
<summary>
|
||||
Gets the key name for a configuration property.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationPath">
|
||||
<summary>
|
||||
Provides utility methods and constants for manipulating Configuration paths.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Configuration.ConfigurationPath.KeyDelimiter">
|
||||
<summary>
|
||||
The delimiter ":" used to separate individual keys in a path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.String[])">
|
||||
<summary>
|
||||
Combines path segments into one path.
|
||||
</summary>
|
||||
<param name="pathSegments">The path segments to combine.</param>
|
||||
<returns>The combined path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.Collections.Generic.IEnumerable{System.String})">
|
||||
<summary>
|
||||
Combines path segments into one path.
|
||||
</summary>
|
||||
<param name="pathSegments">The path segments to combine.</param>
|
||||
<returns>The combined path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetSectionKey(System.String)">
|
||||
<summary>
|
||||
Extracts the last path segment from the path.
|
||||
</summary>
|
||||
<param name="path">The path.</param>
|
||||
<returns>The last path segment of the path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetParentPath(System.String)">
|
||||
<summary>
|
||||
Extracts the path corresponding to the parent node for a given path.
|
||||
</summary>
|
||||
<param name="path">The path.</param>
|
||||
<returns>The original path minus the last individual segment found in it. Null if the original path corresponds to a top level node.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationRootExtensions">
|
||||
<summary>
|
||||
Provides extension methods for <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot)">
|
||||
<summary>
|
||||
Generates a human-readable view of the configuration showing where each value came from.
|
||||
</summary>
|
||||
<returns>The debug view.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot,System.Func{Microsoft.Extensions.Configuration.ConfigurationDebugViewContext,System.String})">
|
||||
<summary>
|
||||
Generates a human-readable view of the configuration showing where each value came from.
|
||||
</summary>
|
||||
<param name="root">The configuration root.</param>
|
||||
<param name="processValue">
|
||||
The function for processing the value, for example, hiding secrets.
|
||||
Parameters:
|
||||
ConfigurationDebugViewContext: Context of the current configuration item.
|
||||
returns: A string value is used to assign as the Value of the configuration section.
|
||||
</param>
|
||||
<returns>The debug view.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfiguration">
|
||||
<summary>
|
||||
Represents a set of key/value application configuration properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfiguration.Item(System.String)">
|
||||
<summary>
|
||||
Gets or sets a configuration value.
|
||||
</summary>
|
||||
<param name="key">The configuration key.</param>
|
||||
<returns>The configuration value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetSection(System.String)">
|
||||
<summary>
|
||||
Gets a configuration sub-section with the specified key.
|
||||
</summary>
|
||||
<param name="key">The key of the configuration section.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
|
||||
<remarks>
|
||||
This method will never return <c>null</c>. If no matching sub-section is found with the specified key,
|
||||
an empty <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/> will be returned.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetChildren">
|
||||
<summary>
|
||||
Gets the immediate descendant configuration sub-sections.
|
||||
</summary>
|
||||
<returns>The configuration sub-sections.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetReloadToken">
|
||||
<summary>
|
||||
Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that can be used to observe when this configuration is reloaded.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> token if this provider supports change tracking; otherwise, <see langword="null" />.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationBuilder">
|
||||
<summary>
|
||||
Represents a type used to build application configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties">
|
||||
<summary>
|
||||
Gets a key/value collection that can be used to share data between the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>
|
||||
and the registered <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>s.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources">
|
||||
<summary>
|
||||
Gets the sources used to obtain configuration values
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Add(Microsoft.Extensions.Configuration.IConfigurationSource)">
|
||||
<summary>
|
||||
Adds a new configuration source.
|
||||
</summary>
|
||||
<param name="source">The configuration source to add.</param>
|
||||
<returns>The same <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Build">
|
||||
<summary>
|
||||
Builds an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> with keys and values from the set of sources registered in
|
||||
<see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources"/>.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/> with keys and values from the registered sources.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationManager">
|
||||
<summary>
|
||||
Represents a mutable configuration object.
|
||||
</summary>
|
||||
<remarks>
|
||||
It is both an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> and an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
|
||||
As sources are added, it updates its current view of configuration.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationProvider">
|
||||
<summary>
|
||||
Provides configuration key/values for an application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.TryGet(System.String,System.String@)">
|
||||
<summary>
|
||||
Tries to get a configuration value for the specified key.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<param name="value">When this method returns, contains the value for the specified key.</param>
|
||||
<returns><see langword="true" /> if a value for the specified key was found, otherwise <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Set(System.String,System.String)">
|
||||
<summary>
|
||||
Sets a configuration value for the specified key.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<param name="value">The value.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetReloadToken">
|
||||
<summary>
|
||||
Attempts to get an <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> for change tracking.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> token if this provider supports change tracking, <see langword="null"/> otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads configuration values from the source represented by this <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetChildKeys(System.Collections.Generic.IEnumerable{System.String},System.String)">
|
||||
<summary>
|
||||
Returns the immediate descendant configuration keys for a given parent path based on the data of this
|
||||
<see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> and the set of keys returned by all the preceding
|
||||
<see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> providers.
|
||||
</summary>
|
||||
<param name="earlierKeys">The child keys returned by the preceding providers for the same parent path.</param>
|
||||
<param name="parentPath">The parent path.</param>
|
||||
<returns>The child keys.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationRoot">
|
||||
<summary>
|
||||
Represents the root of an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> hierarchy.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationRoot.Reload">
|
||||
<summary>
|
||||
Forces the configuration values to be reloaded from the underlying <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> providers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationRoot.Providers">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> providers for this configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationSection">
|
||||
<summary>
|
||||
Represents a section of application configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Key">
|
||||
<summary>
|
||||
Gets the key this section occupies in its parent.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Path">
|
||||
<summary>
|
||||
Gets the full path to this section within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value">
|
||||
<summary>
|
||||
Gets or sets the section value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationSource">
|
||||
<summary>
|
||||
Represents a source of configuration key/values for an application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>
|
||||
</member>
|
||||
<member name="P:System.SR.InvalidSectionName">
|
||||
<summary>Section '{0}' not found in configuration.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,524 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext">
|
||||
<summary>
|
||||
Provides data about the current item of the configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.#ctor(System.String,System.String,System.String,Microsoft.Extensions.Configuration.IConfigurationProvider)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext"/>.
|
||||
</summary>
|
||||
<param name="path">The path of the current item of the configuration.</param>
|
||||
<param name="key">The key of the current item of the configuration.</param>
|
||||
<param name="value">The value of the current item of the configuration.</param>
|
||||
<param name="configurationProvider">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> to use to get the value of the current item.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Path">
|
||||
<summary>
|
||||
Gets the path of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Key">
|
||||
<summary>
|
||||
Gets the key of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Value">
|
||||
<summary>
|
||||
Gets the value of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.ConfigurationProvider">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> that was used to get the value of the current item.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationExtensions">
|
||||
<summary>
|
||||
Provides extension methods for configuration classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Add``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{``0})">
|
||||
<summary>
|
||||
Adds a new configuration source.
|
||||
</summary>
|
||||
<param name="builder">The builder to add to.</param>
|
||||
<param name="configureSource">Configures the source secrets.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetConnectionString(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Gets the specified connection string from the specified configuration.
|
||||
Shorthand for <c>GetSection("ConnectionStrings")[name]</c>.
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<param name="name">The connection string key.</param>
|
||||
<returns>The connection string.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<returns>An enumeration of key value pairs.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration,System.Boolean)">
|
||||
<summary>
|
||||
Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<param name="makePathsRelative"><see langword="true" /> to trim the current configuration's path from the front of the returned child keys.</param>
|
||||
<returns>An enumeration of key value pairs.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Exists(Microsoft.Extensions.Configuration.IConfigurationSection)">
|
||||
<summary>
|
||||
Determines whether the section has a <see cref="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value"/> or has children.
|
||||
</summary>
|
||||
<param name="section">The section to enumerate.</param>
|
||||
<returns><see langword="true" /> if the section has values or children; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetRequiredSection(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Gets a configuration subsection with the specified key.
|
||||
</summary>
|
||||
<param name="configuration">The configuration to enumerate.</param>
|
||||
<param name="key">The key of the configuration section.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
|
||||
<remarks>
|
||||
If no matching sub-section is found with the specified key, an exception is raised.
|
||||
</remarks>
|
||||
<exception cref="T:System.InvalidOperationException">There is no section with key <paramref name="key"/>.</exception>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute">
|
||||
<summary>
|
||||
Specifies the key name for a configuration property.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute"/>.
|
||||
</summary>
|
||||
<param name="name">The key name.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute.Name">
|
||||
<summary>
|
||||
Gets the key name for a configuration property.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationPath">
|
||||
<summary>
|
||||
Provides utility methods and constants for manipulating Configuration paths.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Configuration.ConfigurationPath.KeyDelimiter">
|
||||
<summary>
|
||||
The delimiter ":" used to separate individual keys in a path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.String[])">
|
||||
<summary>
|
||||
Combines path segments into one path.
|
||||
</summary>
|
||||
<param name="pathSegments">The path segments to combine.</param>
|
||||
<returns>The combined path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.Collections.Generic.IEnumerable{System.String})">
|
||||
<summary>
|
||||
Combines path segments into one path.
|
||||
</summary>
|
||||
<param name="pathSegments">The path segments to combine.</param>
|
||||
<returns>The combined path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetSectionKey(System.String)">
|
||||
<summary>
|
||||
Extracts the last path segment from the path.
|
||||
</summary>
|
||||
<param name="path">The path.</param>
|
||||
<returns>The last path segment of the path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetParentPath(System.String)">
|
||||
<summary>
|
||||
Extracts the path corresponding to the parent node for a given path.
|
||||
</summary>
|
||||
<param name="path">The path.</param>
|
||||
<returns>The original path minus the last individual segment found in it. Null if the original path corresponds to a top level node.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationRootExtensions">
|
||||
<summary>
|
||||
Provides extension methods for <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot)">
|
||||
<summary>
|
||||
Generates a human-readable view of the configuration showing where each value came from.
|
||||
</summary>
|
||||
<returns>The debug view.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot,System.Func{Microsoft.Extensions.Configuration.ConfigurationDebugViewContext,System.String})">
|
||||
<summary>
|
||||
Generates a human-readable view of the configuration showing where each value came from.
|
||||
</summary>
|
||||
<param name="root">The configuration root.</param>
|
||||
<param name="processValue">
|
||||
The function for processing the value, for example, hiding secrets.
|
||||
Parameters:
|
||||
ConfigurationDebugViewContext: Context of the current configuration item.
|
||||
returns: A string value is used to assign as the Value of the configuration section.
|
||||
</param>
|
||||
<returns>The debug view.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfiguration">
|
||||
<summary>
|
||||
Represents a set of key/value application configuration properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfiguration.Item(System.String)">
|
||||
<summary>
|
||||
Gets or sets a configuration value.
|
||||
</summary>
|
||||
<param name="key">The configuration key.</param>
|
||||
<returns>The configuration value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetSection(System.String)">
|
||||
<summary>
|
||||
Gets a configuration sub-section with the specified key.
|
||||
</summary>
|
||||
<param name="key">The key of the configuration section.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
|
||||
<remarks>
|
||||
This method will never return <c>null</c>. If no matching sub-section is found with the specified key,
|
||||
an empty <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/> will be returned.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetChildren">
|
||||
<summary>
|
||||
Gets the immediate descendant configuration sub-sections.
|
||||
</summary>
|
||||
<returns>The configuration sub-sections.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetReloadToken">
|
||||
<summary>
|
||||
Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that can be used to observe when this configuration is reloaded.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> token if this provider supports change tracking; otherwise, <see langword="null" />.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationBuilder">
|
||||
<summary>
|
||||
Represents a type used to build application configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties">
|
||||
<summary>
|
||||
Gets a key/value collection that can be used to share data between the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>
|
||||
and the registered <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>s.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources">
|
||||
<summary>
|
||||
Gets the sources used to obtain configuration values
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Add(Microsoft.Extensions.Configuration.IConfigurationSource)">
|
||||
<summary>
|
||||
Adds a new configuration source.
|
||||
</summary>
|
||||
<param name="source">The configuration source to add.</param>
|
||||
<returns>The same <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Build">
|
||||
<summary>
|
||||
Builds an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> with keys and values from the set of sources registered in
|
||||
<see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources"/>.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/> with keys and values from the registered sources.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationManager">
|
||||
<summary>
|
||||
Represents a mutable configuration object.
|
||||
</summary>
|
||||
<remarks>
|
||||
It is both an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> and an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
|
||||
As sources are added, it updates its current view of configuration.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationProvider">
|
||||
<summary>
|
||||
Provides configuration key/values for an application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.TryGet(System.String,System.String@)">
|
||||
<summary>
|
||||
Tries to get a configuration value for the specified key.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<param name="value">When this method returns, contains the value for the specified key.</param>
|
||||
<returns><see langword="true" /> if a value for the specified key was found, otherwise <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Set(System.String,System.String)">
|
||||
<summary>
|
||||
Sets a configuration value for the specified key.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<param name="value">The value.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetReloadToken">
|
||||
<summary>
|
||||
Attempts to get an <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> for change tracking.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> token if this provider supports change tracking, <see langword="null"/> otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads configuration values from the source represented by this <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetChildKeys(System.Collections.Generic.IEnumerable{System.String},System.String)">
|
||||
<summary>
|
||||
Returns the immediate descendant configuration keys for a given parent path based on the data of this
|
||||
<see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> and the set of keys returned by all the preceding
|
||||
<see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> providers.
|
||||
</summary>
|
||||
<param name="earlierKeys">The child keys returned by the preceding providers for the same parent path.</param>
|
||||
<param name="parentPath">The parent path.</param>
|
||||
<returns>The child keys.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationRoot">
|
||||
<summary>
|
||||
Represents the root of an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> hierarchy.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationRoot.Reload">
|
||||
<summary>
|
||||
Forces the configuration values to be reloaded from the underlying <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> providers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationRoot.Providers">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> providers for this configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationSection">
|
||||
<summary>
|
||||
Represents a section of application configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Key">
|
||||
<summary>
|
||||
Gets the key this section occupies in its parent.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Path">
|
||||
<summary>
|
||||
Gets the full path to this section within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value">
|
||||
<summary>
|
||||
Gets or sets the section value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationSource">
|
||||
<summary>
|
||||
Represents a source of configuration key/values for an application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>
|
||||
</member>
|
||||
<member name="P:System.SR.InvalidSectionName">
|
||||
<summary>Section '{0}' not found in configuration.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field or property member will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field and property members will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.ExceptionPolyfills">
|
||||
<summary>Provides downlevel polyfills for static methods on Exception-derived types.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
Nz1mGqZGxgHDssZE6eeXV2gqTdOtcusWYe4vQ9Q//x+i7ExciLLOe9Zf4jE/EMfNoBq4kGXNUuca0gJgi0Pe6A==
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "8jujunpkNNfTkE9PFHp9/aD6GPKVfNCuz8tUbzOcyU5tQOCoIZId4hwQNVx3Tb8XEWw9BYdh0k5vPpqdCM+UtA==",
|
||||
"source": "/mnt/e/dev/git.stella-ops.org/local-nugets"
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@@ -0,0 +1,35 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.DependencyInjection.Abstractions</id>
|
||||
<version>10.0.0-rc.2.25502.107</version>
|
||||
<authors>Microsoft</authors>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>Icon.png</icon>
|
||||
<readme>PACKAGE.md</readme>
|
||||
<projectUrl>https://dot.net/</projectUrl>
|
||||
<description>Abstractions for dependency injection.
|
||||
|
||||
Commonly Used Types:
|
||||
Microsoft.Extensions.DependencyInjection.IServiceCollection</description>
|
||||
<releaseNotes>https://go.microsoft.com/fwlink/?LinkID=799421</releaseNotes>
|
||||
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
|
||||
<serviceable>true</serviceable>
|
||||
<repository type="git" url="https://github.com/dotnet/dotnet" commit="89c8f6a112d37d2ea8b77821e56d170a1bccdc5a" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.6.2">
|
||||
<dependency id="Microsoft.Bcl.AsyncInterfaces" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Threading.Tasks.Extensions" version="4.6.3" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net8.0" />
|
||||
<group targetFramework="net9.0" />
|
||||
<group targetFramework="net10.0" />
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Microsoft.Bcl.AsyncInterfaces" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Threading.Tasks.Extensions" version="4.6.3" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.1" />
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
@@ -0,0 +1,34 @@
|
||||
## About
|
||||
Supports the lower-level abstractions for the dependency injection (DI) software design pattern which is a technique for achieving Inversion of Control (IoC) between classes and their dependencies.
|
||||
|
||||
## Key Features
|
||||
- Interfaces for DI implementations which are provided in other packages including `Microsoft.Extensions.DependencyInjection`.
|
||||
- An implementation of a service collection, which is used to add services to and later retrieve them either directly or through constructor injection.
|
||||
- Interfaces, attributes and extensions methods to support various DI concepts including specifying a service's lifetime and supporting keyed services.
|
||||
|
||||
## How to Use
|
||||
This package is typically used with an implementation of the DI abstractions, such as `Microsoft.Extensions.DependencyInjection`.
|
||||
|
||||
## Main Types
|
||||
The main types provided by this library are:
|
||||
* `Microsoft.Extensions.DependencyInjection.ActivatorUtilities`
|
||||
* `Microsoft.Extensions.DependencyInjection.IServiceCollection`
|
||||
* `Microsoft.Extensions.DependencyInjection.ServiceCollection`
|
||||
* `Microsoft.Extensions.DependencyInjection.ServiceCollectionDescriptorExtensions`
|
||||
* `Microsoft.Extensions.DependencyInjection.ServiceDescriptor`
|
||||
* `Microsoft.Extensions.DependencyInjection.IServiceProviderFactory<TContainerBuilder>`
|
||||
|
||||
## Additional Documentation
|
||||
* [Conceptual documentation](https://learn.microsoft.com/dotnet/core/extensions/dependency-injection)
|
||||
* API documentation
|
||||
- [ActivatorUtilities](https://learn.microsoft.com/dotnet/api/microsoft.extensions.dependencyinjection.defaultserviceproviderfactory)
|
||||
- [ServiceCollection](https://learn.microsoft.com/dotnet/api/microsoft.extensions.dependencyinjection.servicecollection)
|
||||
- [ServiceDescriptor](https://learn.microsoft.com/dotnet/api/microsoft.extensions.dependencyinjection.servicedescriptor)
|
||||
|
||||
## Related Packages
|
||||
- `Microsoft.Extensions.DependencyInjection`
|
||||
- `Microsoft.Extensions.Hosting`
|
||||
- `Microsoft.Extensions.Options`
|
||||
|
||||
## Feedback & Contributing
|
||||
Microsoft.Extensions.DependencyInjection.Abstractions is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_DependencyInjection_Abstractions_net462">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_DependencyInjection_Abstractions_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.DependencyInjection.Abstractions 10.0.0-rc.2.25502.107 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net462 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_DependencyInjection_Abstractions_net8_0">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_DependencyInjection_Abstractions_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.DependencyInjection.Abstractions 10.0.0-rc.2.25502.107 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net8.0 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
Binary file not shown.
@@ -0,0 +1 @@
|
||||
e2dd55RbQW9r9K+0P/YJz7C/O9AANQ4SJqbuVySIFMtsMIDXUz1Y5BdDjxssFt672alhDxMCdJirMA+C4hsa/g==
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "x6XVv3RiwOlN2unjyX/Zat0gI0HiRoDDdjkwBCwsMftYWpbJu4SiyRwDbrv2zAF8v8nbEEvcWi3/pUxZfaqLQw==",
|
||||
"source": "/mnt/e/dev/git.stella-ops.org/local-nugets"
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@@ -0,0 +1,55 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Diagnostics.Abstractions</id>
|
||||
<version>10.0.0-rc.2.25502.107</version>
|
||||
<authors>Microsoft</authors>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>Icon.png</icon>
|
||||
<projectUrl>https://dot.net/</projectUrl>
|
||||
<description>Diagnostic abstractions for Microsoft.Extensions.Diagnostics.
|
||||
|
||||
Commonly Used Types:
|
||||
Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder
|
||||
Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener
|
||||
Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule
|
||||
Microsoft.Extensions.Diagnostics.Metrics.MeterScope
|
||||
Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions
|
||||
Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions</description>
|
||||
<releaseNotes>https://go.microsoft.com/fwlink/?LinkID=799421</releaseNotes>
|
||||
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
|
||||
<serviceable>true</serviceable>
|
||||
<repository type="git" url="https://github.com/dotnet/dotnet" commit="89c8f6a112d37d2ea8b77821e56d170a1bccdc5a" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.6.2">
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Options" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Diagnostics.DiagnosticSource" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Buffers" version="4.6.1" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Memory" version="4.6.3" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net8.0">
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Options" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Diagnostics.DiagnosticSource" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net9.0">
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Options" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Diagnostics.DiagnosticSource" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net10.0">
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Options" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Options" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Diagnostics.DiagnosticSource" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Buffers" version="4.6.1" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Memory" version="4.6.3" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Diagnostics_Abstractions_net462">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Diagnostics_Abstractions_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Diagnostics.Abstractions 10.0.0-rc.2.25502.107 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net462 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Diagnostics_Abstractions_net8_0">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Diagnostics_Abstractions_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Diagnostics.Abstractions 10.0.0-rc.2.25502.107 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net8.0 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,333 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Diagnostics.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder">
|
||||
<summary>
|
||||
Configures the metrics system by registering IMetricsListeners and using rules
|
||||
to determine which metrics are enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder.Services">
|
||||
<summary>
|
||||
Gets the application service collection that's used by extension methods to register services.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener">
|
||||
<summary>
|
||||
Listens to metrics emitted from the system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">
|
||||
<summary>
|
||||
Gets the name of the listener. This is used to identify the listener in the rules configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Initialize(Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource)">
|
||||
<summary>
|
||||
Called once by the runtime to provide a <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource"/> used to pull for fresh metrics data.
|
||||
</summary>
|
||||
<param name="source">A <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource"/> that can be called to request current metrics.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.InstrumentPublished(System.Diagnostics.Metrics.Instrument,System.Object@)">
|
||||
<summary>
|
||||
Called when a new instrument is created and enabled by a matching rule.
|
||||
</summary>
|
||||
<param name="instrument">The new <see cref="T:System.Diagnostics.Metrics.Instrument"/>.</param>
|
||||
<param name="userState">Listener state associated with this instrument. This will be returned to <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/>
|
||||
and <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.MeasurementsCompleted(System.Diagnostics.Metrics.Instrument,System.Object)"/>.</param>
|
||||
<returns><see langword="true" /> if the listener wants to subscribe to this instrument, otherwise <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.MeasurementsCompleted(System.Diagnostics.Metrics.Instrument,System.Object)">
|
||||
<summary>
|
||||
Called when a instrument is disabled by the producer or a rules change.
|
||||
</summary>
|
||||
<param name="instrument">The <see cref="T:System.Diagnostics.Metrics.Instrument"/> being disabled.</param>
|
||||
<param name="userState">The original listener state returned by <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.InstrumentPublished(System.Diagnostics.Metrics.Instrument,System.Object@)"/>.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.GetMeasurementHandlers">
|
||||
<summary>
|
||||
Called once to get the <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers"/> that will be used to process measurements.
|
||||
</summary>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule">
|
||||
<summary>
|
||||
Contains a set of parameters used to determine which instruments are enabled for which listeners. Unspecified
|
||||
parameters match anything.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>The most specific rule that matches a given instrument will be used. The priority of parameters is as follows:</para>
|
||||
<para>- MeterName, either an exact match, or the longest prefix match. See <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see>.</para>
|
||||
<para>- InstrumentName, an exact match. <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</para>
|
||||
<para>- ListenerName, an exact match. <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</para>
|
||||
<para>- Scopes</para>
|
||||
</remarks>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see> or prefix.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</param>
|
||||
<param name="listenerName">The <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</param>
|
||||
<param name="scopes">A bitwise combination of the enumeration values that specifies the scopes to consider.</param>
|
||||
<param name="enable"><see langword="true" /> to enable the matched instrument for this listener; otherwise, <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.#ctor(System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope,System.Boolean)">
|
||||
<summary>
|
||||
Contains a set of parameters used to determine which instruments are enabled for which listeners. Unspecified
|
||||
parameters match anything.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>The most specific rule that matches a given instrument will be used. The priority of parameters is as follows:</para>
|
||||
<para>- MeterName, either an exact match, or the longest prefix match. See <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see>.</para>
|
||||
<para>- InstrumentName, an exact match. <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</para>
|
||||
<para>- ListenerName, an exact match. <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</para>
|
||||
<para>- Scopes</para>
|
||||
</remarks>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see> or prefix.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</param>
|
||||
<param name="listenerName">The <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</param>
|
||||
<param name="scopes">A bitwise combination of the enumeration values that specifies the scopes to consider.</param>
|
||||
<param name="enable"><see langword="true" /> to enable the matched instrument for this listener; otherwise, <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.MeterName">
|
||||
<summary>
|
||||
Gets the <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see>, either an exact match or the longest prefix match. Only full segment matches are considered.
|
||||
</summary>
|
||||
<value>
|
||||
The meter name. If <see langword="null" />, all meters are matched.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.InstrumentName">
|
||||
<summary>
|
||||
Gets the <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>, an exact match.
|
||||
</summary>
|
||||
<value>
|
||||
The instrument name. If <see langword="null" />, all instruments for the meter are matched.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.ListenerName">
|
||||
<summary>
|
||||
Gets the <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>, an exact match.
|
||||
</summary>
|
||||
<value>
|
||||
The listener name. If <see langword="null" />, all listeners are matched.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.Scopes">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MeterScope"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This property is used to distinguish between meters created via <see cref="T:System.Diagnostics.Metrics.Meter"/> constructors (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Global"/>)
|
||||
and those created via Dependency Injection with <see cref="M:System.Diagnostics.Metrics.IMeterFactory.Create(System.Diagnostics.Metrics.MeterOptions)"/> (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Local"/>).
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.Enable">
|
||||
<summary>
|
||||
Gets a value that indicates whether the instrument should be enabled for the listener.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource">
|
||||
<summary>
|
||||
An interface registered with each IMetricsListener using <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Initialize(Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource)"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The listener can call <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource.RecordObservableInstruments"/> to receive the current set of measurements for enabled observable instruments.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource.RecordObservableInstruments">
|
||||
<summary>
|
||||
Requests that the current set of metrics for enabled instruments be sent to the listener's <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> objects.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers">
|
||||
<summary>
|
||||
Represents a set of supported measurement types. If a listener does not support a given type, the measurement is skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.ByteHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Byte"/>. If <see langword="null"/>, byte measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.ShortHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Int16"/>. If <see langword="null"/>, short measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.IntHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Int32"/>. If <see langword="null"/>, int measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.LongHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Int64"/>. If <see langword="null"/>, long measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.FloatHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Single"/>. If <see langword="null"/>, float measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.DoubleHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Double"/>. If <see langword="null"/>, double measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.DecimalHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Decimal"/>. If <see langword="null"/>, decimal measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MeterScope">
|
||||
<summary>
|
||||
Represents scopes used by <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule"/> to distinguish between meters created via <see cref="T:System.Diagnostics.Metrics.Meter"/> constructors (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Global"/>)
|
||||
and those created via Dependency Injection with <see cref="M:System.Diagnostics.Metrics.IMeterFactory.Create(System.Diagnostics.Metrics.MeterOptions)"/> (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Local"/>).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.None">
|
||||
<summary>
|
||||
No scope is specified. This field should not be used.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Global">
|
||||
<summary>
|
||||
Indicates <see cref="T:System.Diagnostics.Metrics.Meter"/> instances created via <see cref="T:System.Diagnostics.Metrics.Meter"/> constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Local">
|
||||
<summary>
|
||||
Indicates <see cref="T:System.Diagnostics.Metrics.Meter"/> instances created via Dependency Injection with <see cref="M:System.Diagnostics.Metrics.IMeterFactory.Create(System.Diagnostics.Metrics.MeterOptions)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions">
|
||||
<summary>
|
||||
Extension methods for <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> to add or clear <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> registrations, and to enable or disable metrics.
|
||||
</summary>
|
||||
<summary>
|
||||
Extension methods for <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> to add or clear <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> registrations, and to enable or disable metrics.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.AddListener``1(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder)">
|
||||
<summary>
|
||||
Registers a new <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> of type <typeparamref name="T"/>.
|
||||
</summary>
|
||||
<typeparam name="T">The implementation type of the listener.</typeparam>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<returns>Returns the original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.AddListener(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener)">
|
||||
<summary>
|
||||
Registers a new <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> instance.
|
||||
</summary>
|
||||
<param name="listener">The implementation type of the listener.</param>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<returns>Returns the original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.ClearListeners(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder)">
|
||||
<summary>
|
||||
Removes all <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> registrations from the dependency injection container.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<returns>Returns the original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String)">
|
||||
<summary>
|
||||
Enables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Enables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Defaults to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String)">
|
||||
<summary>
|
||||
Enables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Enables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Default to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String)">
|
||||
<summary>
|
||||
Disables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Disables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Defaults to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String)">
|
||||
<summary>
|
||||
Disables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Disables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Defaults to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions">
|
||||
<summary>
|
||||
Represents options for configuring the metrics system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions.Rules">
|
||||
<summary>
|
||||
Gets a list of instrument rules that identifies which metrics, instruments, and listeners are enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.TypeNameHelper.GetTypeDisplayName(System.Type,System.Boolean,System.Boolean,System.Boolean,System.Char)">
|
||||
<summary>
|
||||
Pretty print a type name.
|
||||
</summary>
|
||||
<param name="type">The <see cref="T:System.Type"/>.</param>
|
||||
<param name="fullName"><c>true</c> to print a fully qualified name.</param>
|
||||
<param name="includeGenericParameterNames"><c>true</c> to include generic parameter names.</param>
|
||||
<param name="includeGenericParameters"><c>true</c> to include generic parameters.</param>
|
||||
<param name="nestedTypeDelimiter">Character to use as a delimiter in nested type names</param>
|
||||
<returns>The pretty printed type name.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,727 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Diagnostics.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder">
|
||||
<summary>
|
||||
Configures the metrics system by registering IMetricsListeners and using rules
|
||||
to determine which metrics are enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder.Services">
|
||||
<summary>
|
||||
Gets the application service collection that's used by extension methods to register services.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener">
|
||||
<summary>
|
||||
Listens to metrics emitted from the system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">
|
||||
<summary>
|
||||
Gets the name of the listener. This is used to identify the listener in the rules configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Initialize(Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource)">
|
||||
<summary>
|
||||
Called once by the runtime to provide a <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource"/> used to pull for fresh metrics data.
|
||||
</summary>
|
||||
<param name="source">A <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource"/> that can be called to request current metrics.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.InstrumentPublished(System.Diagnostics.Metrics.Instrument,System.Object@)">
|
||||
<summary>
|
||||
Called when a new instrument is created and enabled by a matching rule.
|
||||
</summary>
|
||||
<param name="instrument">The new <see cref="T:System.Diagnostics.Metrics.Instrument"/>.</param>
|
||||
<param name="userState">Listener state associated with this instrument. This will be returned to <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/>
|
||||
and <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.MeasurementsCompleted(System.Diagnostics.Metrics.Instrument,System.Object)"/>.</param>
|
||||
<returns><see langword="true" /> if the listener wants to subscribe to this instrument, otherwise <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.MeasurementsCompleted(System.Diagnostics.Metrics.Instrument,System.Object)">
|
||||
<summary>
|
||||
Called when a instrument is disabled by the producer or a rules change.
|
||||
</summary>
|
||||
<param name="instrument">The <see cref="T:System.Diagnostics.Metrics.Instrument"/> being disabled.</param>
|
||||
<param name="userState">The original listener state returned by <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.InstrumentPublished(System.Diagnostics.Metrics.Instrument,System.Object@)"/>.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.GetMeasurementHandlers">
|
||||
<summary>
|
||||
Called once to get the <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers"/> that will be used to process measurements.
|
||||
</summary>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule">
|
||||
<summary>
|
||||
Contains a set of parameters used to determine which instruments are enabled for which listeners. Unspecified
|
||||
parameters match anything.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>The most specific rule that matches a given instrument will be used. The priority of parameters is as follows:</para>
|
||||
<para>- MeterName, either an exact match, or the longest prefix match. See <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see>.</para>
|
||||
<para>- InstrumentName, an exact match. <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</para>
|
||||
<para>- ListenerName, an exact match. <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</para>
|
||||
<para>- Scopes</para>
|
||||
</remarks>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see> or prefix.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</param>
|
||||
<param name="listenerName">The <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</param>
|
||||
<param name="scopes">A bitwise combination of the enumeration values that specifies the scopes to consider.</param>
|
||||
<param name="enable"><see langword="true" /> to enable the matched instrument for this listener; otherwise, <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.#ctor(System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope,System.Boolean)">
|
||||
<summary>
|
||||
Contains a set of parameters used to determine which instruments are enabled for which listeners. Unspecified
|
||||
parameters match anything.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>The most specific rule that matches a given instrument will be used. The priority of parameters is as follows:</para>
|
||||
<para>- MeterName, either an exact match, or the longest prefix match. See <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see>.</para>
|
||||
<para>- InstrumentName, an exact match. <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</para>
|
||||
<para>- ListenerName, an exact match. <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</para>
|
||||
<para>- Scopes</para>
|
||||
</remarks>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see> or prefix.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</param>
|
||||
<param name="listenerName">The <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</param>
|
||||
<param name="scopes">A bitwise combination of the enumeration values that specifies the scopes to consider.</param>
|
||||
<param name="enable"><see langword="true" /> to enable the matched instrument for this listener; otherwise, <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.MeterName">
|
||||
<summary>
|
||||
Gets the <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see>, either an exact match or the longest prefix match. Only full segment matches are considered.
|
||||
</summary>
|
||||
<value>
|
||||
The meter name. If <see langword="null" />, all meters are matched.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.InstrumentName">
|
||||
<summary>
|
||||
Gets the <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>, an exact match.
|
||||
</summary>
|
||||
<value>
|
||||
The instrument name. If <see langword="null" />, all instruments for the meter are matched.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.ListenerName">
|
||||
<summary>
|
||||
Gets the <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>, an exact match.
|
||||
</summary>
|
||||
<value>
|
||||
The listener name. If <see langword="null" />, all listeners are matched.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.Scopes">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MeterScope"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This property is used to distinguish between meters created via <see cref="T:System.Diagnostics.Metrics.Meter"/> constructors (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Global"/>)
|
||||
and those created via Dependency Injection with <see cref="M:System.Diagnostics.Metrics.IMeterFactory.Create(System.Diagnostics.Metrics.MeterOptions)"/> (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Local"/>).
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.Enable">
|
||||
<summary>
|
||||
Gets a value that indicates whether the instrument should be enabled for the listener.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource">
|
||||
<summary>
|
||||
An interface registered with each IMetricsListener using <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Initialize(Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource)"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The listener can call <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource.RecordObservableInstruments"/> to receive the current set of measurements for enabled observable instruments.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource.RecordObservableInstruments">
|
||||
<summary>
|
||||
Requests that the current set of metrics for enabled instruments be sent to the listener's <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> objects.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers">
|
||||
<summary>
|
||||
Represents a set of supported measurement types. If a listener does not support a given type, the measurement is skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.ByteHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Byte"/>. If <see langword="null"/>, byte measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.ShortHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Int16"/>. If <see langword="null"/>, short measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.IntHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Int32"/>. If <see langword="null"/>, int measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.LongHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Int64"/>. If <see langword="null"/>, long measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.FloatHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Single"/>. If <see langword="null"/>, float measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.DoubleHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Double"/>. If <see langword="null"/>, double measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.DecimalHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Decimal"/>. If <see langword="null"/>, decimal measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MeterScope">
|
||||
<summary>
|
||||
Represents scopes used by <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule"/> to distinguish between meters created via <see cref="T:System.Diagnostics.Metrics.Meter"/> constructors (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Global"/>)
|
||||
and those created via Dependency Injection with <see cref="M:System.Diagnostics.Metrics.IMeterFactory.Create(System.Diagnostics.Metrics.MeterOptions)"/> (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Local"/>).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.None">
|
||||
<summary>
|
||||
No scope is specified. This field should not be used.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Global">
|
||||
<summary>
|
||||
Indicates <see cref="T:System.Diagnostics.Metrics.Meter"/> instances created via <see cref="T:System.Diagnostics.Metrics.Meter"/> constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Local">
|
||||
<summary>
|
||||
Indicates <see cref="T:System.Diagnostics.Metrics.Meter"/> instances created via Dependency Injection with <see cref="M:System.Diagnostics.Metrics.IMeterFactory.Create(System.Diagnostics.Metrics.MeterOptions)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions">
|
||||
<summary>
|
||||
Extension methods for <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> to add or clear <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> registrations, and to enable or disable metrics.
|
||||
</summary>
|
||||
<summary>
|
||||
Extension methods for <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> to add or clear <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> registrations, and to enable or disable metrics.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.AddListener``1(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder)">
|
||||
<summary>
|
||||
Registers a new <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> of type <typeparamref name="T"/>.
|
||||
</summary>
|
||||
<typeparam name="T">The implementation type of the listener.</typeparam>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<returns>Returns the original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.AddListener(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener)">
|
||||
<summary>
|
||||
Registers a new <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> instance.
|
||||
</summary>
|
||||
<param name="listener">The implementation type of the listener.</param>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<returns>Returns the original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.ClearListeners(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder)">
|
||||
<summary>
|
||||
Removes all <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> registrations from the dependency injection container.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<returns>Returns the original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String)">
|
||||
<summary>
|
||||
Enables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Enables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Defaults to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String)">
|
||||
<summary>
|
||||
Enables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Enables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Default to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String)">
|
||||
<summary>
|
||||
Disables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Disables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Defaults to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String)">
|
||||
<summary>
|
||||
Disables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Disables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Defaults to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions">
|
||||
<summary>
|
||||
Represents options for configuring the metrics system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions.Rules">
|
||||
<summary>
|
||||
Gets a list of instrument rules that identifies which metrics, instruments, and listeners are enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.TypeNameHelper.GetTypeDisplayName(System.Type,System.Boolean,System.Boolean,System.Boolean,System.Char)">
|
||||
<summary>
|
||||
Pretty print a type name.
|
||||
</summary>
|
||||
<param name="type">The <see cref="T:System.Type"/>.</param>
|
||||
<param name="fullName"><c>true</c> to print a fully qualified name.</param>
|
||||
<param name="includeGenericParameterNames"><c>true</c> to include generic parameter names.</param>
|
||||
<param name="includeGenericParameters"><c>true</c> to include generic parameters.</param>
|
||||
<param name="nestedTypeDelimiter">Character to use as a delimiter in nested type names</param>
|
||||
<returns>The pretty printed type name.</returns>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute">
|
||||
<summary>
|
||||
Indicates that certain members on a specified <see cref="T:System.Type"/> are accessed dynamically,
|
||||
for example through <see cref="N:System.Reflection"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This allows tools to understand which members are being accessed during the execution
|
||||
of a program.
|
||||
|
||||
This attribute is valid on members whose type is <see cref="T:System.Type"/> or <see cref="T:System.String"/>.
|
||||
|
||||
When this attribute is applied to a location of type <see cref="T:System.String"/>, the assumption is
|
||||
that the string represents a fully qualified type name.
|
||||
|
||||
When this attribute is applied to a class, interface, or struct, the members specified
|
||||
can be accessed dynamically on <see cref="T:System.Type"/> instances returned from calling
|
||||
<see cref="M:System.Object.GetType"/> on instances of that class, interface, or struct.
|
||||
|
||||
If the attribute is applied to a method it's treated as a special case and it implies
|
||||
the attribute should be applied to the "this" parameter of the method. As such the attribute
|
||||
should only be used on instance methods of types assignable to System.Type (or string, but no methods
|
||||
will use it there).
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute"/> class
|
||||
with the specified member types.
|
||||
</summary>
|
||||
<param name="memberTypes">The types of members dynamically accessed.</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes">
|
||||
<summary>
|
||||
Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
|
||||
of members dynamically accessed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
|
||||
<summary>
|
||||
Specifies the types of members that are dynamically accessed.
|
||||
|
||||
This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a
|
||||
bitwise combination of its member values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
|
||||
<summary>
|
||||
Specifies no members.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
|
||||
<summary>
|
||||
Specifies the default, parameterless public constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
|
||||
<summary>
|
||||
Specifies all public constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
|
||||
<summary>
|
||||
Specifies all non-public constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
|
||||
<summary>
|
||||
Specifies all public methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
|
||||
<summary>
|
||||
Specifies all non-public methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
|
||||
<summary>
|
||||
Specifies all public fields.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
|
||||
<summary>
|
||||
Specifies all non-public fields.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
|
||||
<summary>
|
||||
Specifies all public nested types.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
|
||||
<summary>
|
||||
Specifies all non-public nested types.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
|
||||
<summary>
|
||||
Specifies all public properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
|
||||
<summary>
|
||||
Specifies all non-public properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
|
||||
<summary>
|
||||
Specifies all public events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
|
||||
<summary>
|
||||
Specifies all non-public events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
|
||||
<summary>
|
||||
Specifies all interfaces implemented by the type.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructorsWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public constructors, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethodsWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public methods, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFieldsWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public fields, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypesWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public nested types, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicPropertiesWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public properties, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEventsWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public events, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructorsWithInherited">
|
||||
<summary>
|
||||
Specifies all public constructors, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypesWithInherited">
|
||||
<summary>
|
||||
Specifies all public nested types, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllConstructors">
|
||||
<summary>
|
||||
Specifies all constructors, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllMethods">
|
||||
<summary>
|
||||
Specifies all methods, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllFields">
|
||||
<summary>
|
||||
Specifies all fields, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllNestedTypes">
|
||||
<summary>
|
||||
Specifies all nested types, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllProperties">
|
||||
<summary>
|
||||
Specifies all properties, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllEvents">
|
||||
<summary>
|
||||
Specifies all events, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
|
||||
<summary>
|
||||
Specifies all members.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field or property member will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field and property members will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute">
|
||||
<summary>
|
||||
When applied to an attribute class, instructs the compiler to flow applications of that attribute,
|
||||
from source code down to compiler-generated symbols. This can help IL-based analysis tools.
|
||||
</summary>
|
||||
<remarks>
|
||||
One example where this attribute applies is in C# primary constructor parameters. If an attribute
|
||||
marked with <see cref="T:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute"/> gets applied to a primary constructor
|
||||
parameter, the attribute will also be applied to any compiler-generated fields storing that parameter.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.ExceptionPolyfills">
|
||||
<summary>Provides downlevel polyfills for static methods on Exception-derived types.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,333 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Diagnostics.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder">
|
||||
<summary>
|
||||
Configures the metrics system by registering IMetricsListeners and using rules
|
||||
to determine which metrics are enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder.Services">
|
||||
<summary>
|
||||
Gets the application service collection that's used by extension methods to register services.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener">
|
||||
<summary>
|
||||
Listens to metrics emitted from the system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">
|
||||
<summary>
|
||||
Gets the name of the listener. This is used to identify the listener in the rules configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Initialize(Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource)">
|
||||
<summary>
|
||||
Called once by the runtime to provide a <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource"/> used to pull for fresh metrics data.
|
||||
</summary>
|
||||
<param name="source">A <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource"/> that can be called to request current metrics.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.InstrumentPublished(System.Diagnostics.Metrics.Instrument,System.Object@)">
|
||||
<summary>
|
||||
Called when a new instrument is created and enabled by a matching rule.
|
||||
</summary>
|
||||
<param name="instrument">The new <see cref="T:System.Diagnostics.Metrics.Instrument"/>.</param>
|
||||
<param name="userState">Listener state associated with this instrument. This will be returned to <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/>
|
||||
and <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.MeasurementsCompleted(System.Diagnostics.Metrics.Instrument,System.Object)"/>.</param>
|
||||
<returns><see langword="true" /> if the listener wants to subscribe to this instrument, otherwise <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.MeasurementsCompleted(System.Diagnostics.Metrics.Instrument,System.Object)">
|
||||
<summary>
|
||||
Called when a instrument is disabled by the producer or a rules change.
|
||||
</summary>
|
||||
<param name="instrument">The <see cref="T:System.Diagnostics.Metrics.Instrument"/> being disabled.</param>
|
||||
<param name="userState">The original listener state returned by <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.InstrumentPublished(System.Diagnostics.Metrics.Instrument,System.Object@)"/>.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.GetMeasurementHandlers">
|
||||
<summary>
|
||||
Called once to get the <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers"/> that will be used to process measurements.
|
||||
</summary>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule">
|
||||
<summary>
|
||||
Contains a set of parameters used to determine which instruments are enabled for which listeners. Unspecified
|
||||
parameters match anything.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>The most specific rule that matches a given instrument will be used. The priority of parameters is as follows:</para>
|
||||
<para>- MeterName, either an exact match, or the longest prefix match. See <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see>.</para>
|
||||
<para>- InstrumentName, an exact match. <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</para>
|
||||
<para>- ListenerName, an exact match. <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</para>
|
||||
<para>- Scopes</para>
|
||||
</remarks>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see> or prefix.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</param>
|
||||
<param name="listenerName">The <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</param>
|
||||
<param name="scopes">A bitwise combination of the enumeration values that specifies the scopes to consider.</param>
|
||||
<param name="enable"><see langword="true" /> to enable the matched instrument for this listener; otherwise, <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.#ctor(System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope,System.Boolean)">
|
||||
<summary>
|
||||
Contains a set of parameters used to determine which instruments are enabled for which listeners. Unspecified
|
||||
parameters match anything.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>The most specific rule that matches a given instrument will be used. The priority of parameters is as follows:</para>
|
||||
<para>- MeterName, either an exact match, or the longest prefix match. See <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see>.</para>
|
||||
<para>- InstrumentName, an exact match. <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</para>
|
||||
<para>- ListenerName, an exact match. <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</para>
|
||||
<para>- Scopes</para>
|
||||
</remarks>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see> or prefix.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</param>
|
||||
<param name="listenerName">The <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</param>
|
||||
<param name="scopes">A bitwise combination of the enumeration values that specifies the scopes to consider.</param>
|
||||
<param name="enable"><see langword="true" /> to enable the matched instrument for this listener; otherwise, <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.MeterName">
|
||||
<summary>
|
||||
Gets the <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see>, either an exact match or the longest prefix match. Only full segment matches are considered.
|
||||
</summary>
|
||||
<value>
|
||||
The meter name. If <see langword="null" />, all meters are matched.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.InstrumentName">
|
||||
<summary>
|
||||
Gets the <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>, an exact match.
|
||||
</summary>
|
||||
<value>
|
||||
The instrument name. If <see langword="null" />, all instruments for the meter are matched.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.ListenerName">
|
||||
<summary>
|
||||
Gets the <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>, an exact match.
|
||||
</summary>
|
||||
<value>
|
||||
The listener name. If <see langword="null" />, all listeners are matched.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.Scopes">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MeterScope"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This property is used to distinguish between meters created via <see cref="T:System.Diagnostics.Metrics.Meter"/> constructors (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Global"/>)
|
||||
and those created via Dependency Injection with <see cref="M:System.Diagnostics.Metrics.IMeterFactory.Create(System.Diagnostics.Metrics.MeterOptions)"/> (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Local"/>).
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.Enable">
|
||||
<summary>
|
||||
Gets a value that indicates whether the instrument should be enabled for the listener.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource">
|
||||
<summary>
|
||||
An interface registered with each IMetricsListener using <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Initialize(Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource)"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The listener can call <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource.RecordObservableInstruments"/> to receive the current set of measurements for enabled observable instruments.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource.RecordObservableInstruments">
|
||||
<summary>
|
||||
Requests that the current set of metrics for enabled instruments be sent to the listener's <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> objects.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers">
|
||||
<summary>
|
||||
Represents a set of supported measurement types. If a listener does not support a given type, the measurement is skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.ByteHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Byte"/>. If <see langword="null"/>, byte measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.ShortHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Int16"/>. If <see langword="null"/>, short measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.IntHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Int32"/>. If <see langword="null"/>, int measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.LongHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Int64"/>. If <see langword="null"/>, long measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.FloatHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Single"/>. If <see langword="null"/>, float measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.DoubleHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Double"/>. If <see langword="null"/>, double measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.DecimalHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Decimal"/>. If <see langword="null"/>, decimal measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MeterScope">
|
||||
<summary>
|
||||
Represents scopes used by <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule"/> to distinguish between meters created via <see cref="T:System.Diagnostics.Metrics.Meter"/> constructors (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Global"/>)
|
||||
and those created via Dependency Injection with <see cref="M:System.Diagnostics.Metrics.IMeterFactory.Create(System.Diagnostics.Metrics.MeterOptions)"/> (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Local"/>).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.None">
|
||||
<summary>
|
||||
No scope is specified. This field should not be used.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Global">
|
||||
<summary>
|
||||
Indicates <see cref="T:System.Diagnostics.Metrics.Meter"/> instances created via <see cref="T:System.Diagnostics.Metrics.Meter"/> constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Local">
|
||||
<summary>
|
||||
Indicates <see cref="T:System.Diagnostics.Metrics.Meter"/> instances created via Dependency Injection with <see cref="M:System.Diagnostics.Metrics.IMeterFactory.Create(System.Diagnostics.Metrics.MeterOptions)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions">
|
||||
<summary>
|
||||
Extension methods for <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> to add or clear <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> registrations, and to enable or disable metrics.
|
||||
</summary>
|
||||
<summary>
|
||||
Extension methods for <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> to add or clear <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> registrations, and to enable or disable metrics.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.AddListener``1(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder)">
|
||||
<summary>
|
||||
Registers a new <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> of type <typeparamref name="T"/>.
|
||||
</summary>
|
||||
<typeparam name="T">The implementation type of the listener.</typeparam>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<returns>Returns the original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.AddListener(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener)">
|
||||
<summary>
|
||||
Registers a new <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> instance.
|
||||
</summary>
|
||||
<param name="listener">The implementation type of the listener.</param>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<returns>Returns the original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.ClearListeners(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder)">
|
||||
<summary>
|
||||
Removes all <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> registrations from the dependency injection container.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<returns>Returns the original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String)">
|
||||
<summary>
|
||||
Enables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Enables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Defaults to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String)">
|
||||
<summary>
|
||||
Enables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Enables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Default to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String)">
|
||||
<summary>
|
||||
Disables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Disables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Defaults to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String)">
|
||||
<summary>
|
||||
Disables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Disables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Defaults to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions">
|
||||
<summary>
|
||||
Represents options for configuring the metrics system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions.Rules">
|
||||
<summary>
|
||||
Gets a list of instrument rules that identifies which metrics, instruments, and listeners are enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.TypeNameHelper.GetTypeDisplayName(System.Type,System.Boolean,System.Boolean,System.Boolean,System.Char)">
|
||||
<summary>
|
||||
Pretty print a type name.
|
||||
</summary>
|
||||
<param name="type">The <see cref="T:System.Type"/>.</param>
|
||||
<param name="fullName"><c>true</c> to print a fully qualified name.</param>
|
||||
<param name="includeGenericParameterNames"><c>true</c> to include generic parameter names.</param>
|
||||
<param name="includeGenericParameters"><c>true</c> to include generic parameters.</param>
|
||||
<param name="nestedTypeDelimiter">Character to use as a delimiter in nested type names</param>
|
||||
<returns>The pretty printed type name.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,333 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Diagnostics.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder">
|
||||
<summary>
|
||||
Configures the metrics system by registering IMetricsListeners and using rules
|
||||
to determine which metrics are enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder.Services">
|
||||
<summary>
|
||||
Gets the application service collection that's used by extension methods to register services.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener">
|
||||
<summary>
|
||||
Listens to metrics emitted from the system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">
|
||||
<summary>
|
||||
Gets the name of the listener. This is used to identify the listener in the rules configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Initialize(Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource)">
|
||||
<summary>
|
||||
Called once by the runtime to provide a <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource"/> used to pull for fresh metrics data.
|
||||
</summary>
|
||||
<param name="source">A <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource"/> that can be called to request current metrics.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.InstrumentPublished(System.Diagnostics.Metrics.Instrument,System.Object@)">
|
||||
<summary>
|
||||
Called when a new instrument is created and enabled by a matching rule.
|
||||
</summary>
|
||||
<param name="instrument">The new <see cref="T:System.Diagnostics.Metrics.Instrument"/>.</param>
|
||||
<param name="userState">Listener state associated with this instrument. This will be returned to <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/>
|
||||
and <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.MeasurementsCompleted(System.Diagnostics.Metrics.Instrument,System.Object)"/>.</param>
|
||||
<returns><see langword="true" /> if the listener wants to subscribe to this instrument, otherwise <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.MeasurementsCompleted(System.Diagnostics.Metrics.Instrument,System.Object)">
|
||||
<summary>
|
||||
Called when a instrument is disabled by the producer or a rules change.
|
||||
</summary>
|
||||
<param name="instrument">The <see cref="T:System.Diagnostics.Metrics.Instrument"/> being disabled.</param>
|
||||
<param name="userState">The original listener state returned by <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.InstrumentPublished(System.Diagnostics.Metrics.Instrument,System.Object@)"/>.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.GetMeasurementHandlers">
|
||||
<summary>
|
||||
Called once to get the <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers"/> that will be used to process measurements.
|
||||
</summary>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule">
|
||||
<summary>
|
||||
Contains a set of parameters used to determine which instruments are enabled for which listeners. Unspecified
|
||||
parameters match anything.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>The most specific rule that matches a given instrument will be used. The priority of parameters is as follows:</para>
|
||||
<para>- MeterName, either an exact match, or the longest prefix match. See <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see>.</para>
|
||||
<para>- InstrumentName, an exact match. <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</para>
|
||||
<para>- ListenerName, an exact match. <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</para>
|
||||
<para>- Scopes</para>
|
||||
</remarks>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see> or prefix.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</param>
|
||||
<param name="listenerName">The <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</param>
|
||||
<param name="scopes">A bitwise combination of the enumeration values that specifies the scopes to consider.</param>
|
||||
<param name="enable"><see langword="true" /> to enable the matched instrument for this listener; otherwise, <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.#ctor(System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope,System.Boolean)">
|
||||
<summary>
|
||||
Contains a set of parameters used to determine which instruments are enabled for which listeners. Unspecified
|
||||
parameters match anything.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>The most specific rule that matches a given instrument will be used. The priority of parameters is as follows:</para>
|
||||
<para>- MeterName, either an exact match, or the longest prefix match. See <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see>.</para>
|
||||
<para>- InstrumentName, an exact match. <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</para>
|
||||
<para>- ListenerName, an exact match. <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</para>
|
||||
<para>- Scopes</para>
|
||||
</remarks>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see> or prefix.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</param>
|
||||
<param name="listenerName">The <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</param>
|
||||
<param name="scopes">A bitwise combination of the enumeration values that specifies the scopes to consider.</param>
|
||||
<param name="enable"><see langword="true" /> to enable the matched instrument for this listener; otherwise, <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.MeterName">
|
||||
<summary>
|
||||
Gets the <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see>, either an exact match or the longest prefix match. Only full segment matches are considered.
|
||||
</summary>
|
||||
<value>
|
||||
The meter name. If <see langword="null" />, all meters are matched.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.InstrumentName">
|
||||
<summary>
|
||||
Gets the <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>, an exact match.
|
||||
</summary>
|
||||
<value>
|
||||
The instrument name. If <see langword="null" />, all instruments for the meter are matched.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.ListenerName">
|
||||
<summary>
|
||||
Gets the <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>, an exact match.
|
||||
</summary>
|
||||
<value>
|
||||
The listener name. If <see langword="null" />, all listeners are matched.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.Scopes">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MeterScope"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This property is used to distinguish between meters created via <see cref="T:System.Diagnostics.Metrics.Meter"/> constructors (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Global"/>)
|
||||
and those created via Dependency Injection with <see cref="M:System.Diagnostics.Metrics.IMeterFactory.Create(System.Diagnostics.Metrics.MeterOptions)"/> (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Local"/>).
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.Enable">
|
||||
<summary>
|
||||
Gets a value that indicates whether the instrument should be enabled for the listener.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource">
|
||||
<summary>
|
||||
An interface registered with each IMetricsListener using <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Initialize(Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource)"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The listener can call <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource.RecordObservableInstruments"/> to receive the current set of measurements for enabled observable instruments.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource.RecordObservableInstruments">
|
||||
<summary>
|
||||
Requests that the current set of metrics for enabled instruments be sent to the listener's <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> objects.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers">
|
||||
<summary>
|
||||
Represents a set of supported measurement types. If a listener does not support a given type, the measurement is skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.ByteHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Byte"/>. If <see langword="null"/>, byte measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.ShortHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Int16"/>. If <see langword="null"/>, short measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.IntHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Int32"/>. If <see langword="null"/>, int measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.LongHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Int64"/>. If <see langword="null"/>, long measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.FloatHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Single"/>. If <see langword="null"/>, float measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.DoubleHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Double"/>. If <see langword="null"/>, double measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.DecimalHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Decimal"/>. If <see langword="null"/>, decimal measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MeterScope">
|
||||
<summary>
|
||||
Represents scopes used by <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule"/> to distinguish between meters created via <see cref="T:System.Diagnostics.Metrics.Meter"/> constructors (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Global"/>)
|
||||
and those created via Dependency Injection with <see cref="M:System.Diagnostics.Metrics.IMeterFactory.Create(System.Diagnostics.Metrics.MeterOptions)"/> (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Local"/>).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.None">
|
||||
<summary>
|
||||
No scope is specified. This field should not be used.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Global">
|
||||
<summary>
|
||||
Indicates <see cref="T:System.Diagnostics.Metrics.Meter"/> instances created via <see cref="T:System.Diagnostics.Metrics.Meter"/> constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Local">
|
||||
<summary>
|
||||
Indicates <see cref="T:System.Diagnostics.Metrics.Meter"/> instances created via Dependency Injection with <see cref="M:System.Diagnostics.Metrics.IMeterFactory.Create(System.Diagnostics.Metrics.MeterOptions)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions">
|
||||
<summary>
|
||||
Extension methods for <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> to add or clear <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> registrations, and to enable or disable metrics.
|
||||
</summary>
|
||||
<summary>
|
||||
Extension methods for <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> to add or clear <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> registrations, and to enable or disable metrics.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.AddListener``1(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder)">
|
||||
<summary>
|
||||
Registers a new <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> of type <typeparamref name="T"/>.
|
||||
</summary>
|
||||
<typeparam name="T">The implementation type of the listener.</typeparam>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<returns>Returns the original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.AddListener(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener)">
|
||||
<summary>
|
||||
Registers a new <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> instance.
|
||||
</summary>
|
||||
<param name="listener">The implementation type of the listener.</param>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<returns>Returns the original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.ClearListeners(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder)">
|
||||
<summary>
|
||||
Removes all <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> registrations from the dependency injection container.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<returns>Returns the original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String)">
|
||||
<summary>
|
||||
Enables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Enables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Defaults to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String)">
|
||||
<summary>
|
||||
Enables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Enables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Default to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String)">
|
||||
<summary>
|
||||
Disables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Disables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Defaults to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String)">
|
||||
<summary>
|
||||
Disables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Disables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Defaults to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions">
|
||||
<summary>
|
||||
Represents options for configuring the metrics system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions.Rules">
|
||||
<summary>
|
||||
Gets a list of instrument rules that identifies which metrics, instruments, and listeners are enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.TypeNameHelper.GetTypeDisplayName(System.Type,System.Boolean,System.Boolean,System.Boolean,System.Char)">
|
||||
<summary>
|
||||
Pretty print a type name.
|
||||
</summary>
|
||||
<param name="type">The <see cref="T:System.Type"/>.</param>
|
||||
<param name="fullName"><c>true</c> to print a fully qualified name.</param>
|
||||
<param name="includeGenericParameterNames"><c>true</c> to include generic parameter names.</param>
|
||||
<param name="includeGenericParameters"><c>true</c> to include generic parameters.</param>
|
||||
<param name="nestedTypeDelimiter">Character to use as a delimiter in nested type names</param>
|
||||
<returns>The pretty printed type name.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,727 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Diagnostics.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder">
|
||||
<summary>
|
||||
Configures the metrics system by registering IMetricsListeners and using rules
|
||||
to determine which metrics are enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder.Services">
|
||||
<summary>
|
||||
Gets the application service collection that's used by extension methods to register services.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener">
|
||||
<summary>
|
||||
Listens to metrics emitted from the system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">
|
||||
<summary>
|
||||
Gets the name of the listener. This is used to identify the listener in the rules configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Initialize(Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource)">
|
||||
<summary>
|
||||
Called once by the runtime to provide a <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource"/> used to pull for fresh metrics data.
|
||||
</summary>
|
||||
<param name="source">A <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource"/> that can be called to request current metrics.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.InstrumentPublished(System.Diagnostics.Metrics.Instrument,System.Object@)">
|
||||
<summary>
|
||||
Called when a new instrument is created and enabled by a matching rule.
|
||||
</summary>
|
||||
<param name="instrument">The new <see cref="T:System.Diagnostics.Metrics.Instrument"/>.</param>
|
||||
<param name="userState">Listener state associated with this instrument. This will be returned to <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/>
|
||||
and <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.MeasurementsCompleted(System.Diagnostics.Metrics.Instrument,System.Object)"/>.</param>
|
||||
<returns><see langword="true" /> if the listener wants to subscribe to this instrument, otherwise <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.MeasurementsCompleted(System.Diagnostics.Metrics.Instrument,System.Object)">
|
||||
<summary>
|
||||
Called when a instrument is disabled by the producer or a rules change.
|
||||
</summary>
|
||||
<param name="instrument">The <see cref="T:System.Diagnostics.Metrics.Instrument"/> being disabled.</param>
|
||||
<param name="userState">The original listener state returned by <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.InstrumentPublished(System.Diagnostics.Metrics.Instrument,System.Object@)"/>.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.GetMeasurementHandlers">
|
||||
<summary>
|
||||
Called once to get the <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers"/> that will be used to process measurements.
|
||||
</summary>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule">
|
||||
<summary>
|
||||
Contains a set of parameters used to determine which instruments are enabled for which listeners. Unspecified
|
||||
parameters match anything.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>The most specific rule that matches a given instrument will be used. The priority of parameters is as follows:</para>
|
||||
<para>- MeterName, either an exact match, or the longest prefix match. See <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see>.</para>
|
||||
<para>- InstrumentName, an exact match. <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</para>
|
||||
<para>- ListenerName, an exact match. <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</para>
|
||||
<para>- Scopes</para>
|
||||
</remarks>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see> or prefix.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</param>
|
||||
<param name="listenerName">The <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</param>
|
||||
<param name="scopes">A bitwise combination of the enumeration values that specifies the scopes to consider.</param>
|
||||
<param name="enable"><see langword="true" /> to enable the matched instrument for this listener; otherwise, <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.#ctor(System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope,System.Boolean)">
|
||||
<summary>
|
||||
Contains a set of parameters used to determine which instruments are enabled for which listeners. Unspecified
|
||||
parameters match anything.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>The most specific rule that matches a given instrument will be used. The priority of parameters is as follows:</para>
|
||||
<para>- MeterName, either an exact match, or the longest prefix match. See <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see>.</para>
|
||||
<para>- InstrumentName, an exact match. <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</para>
|
||||
<para>- ListenerName, an exact match. <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</para>
|
||||
<para>- Scopes</para>
|
||||
</remarks>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see> or prefix.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>.</param>
|
||||
<param name="listenerName">The <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>.</param>
|
||||
<param name="scopes">A bitwise combination of the enumeration values that specifies the scopes to consider.</param>
|
||||
<param name="enable"><see langword="true" /> to enable the matched instrument for this listener; otherwise, <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.MeterName">
|
||||
<summary>
|
||||
Gets the <see cref="P:System.Diagnostics.Metrics.Meter.Name">Meter.Name</see>, either an exact match or the longest prefix match. Only full segment matches are considered.
|
||||
</summary>
|
||||
<value>
|
||||
The meter name. If <see langword="null" />, all meters are matched.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.InstrumentName">
|
||||
<summary>
|
||||
Gets the <see cref="P:System.Diagnostics.Metrics.Instrument.Name">Instrument.Name</see>, an exact match.
|
||||
</summary>
|
||||
<value>
|
||||
The instrument name. If <see langword="null" />, all instruments for the meter are matched.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.ListenerName">
|
||||
<summary>
|
||||
Gets the <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name">IMetricsListener.Name</see>, an exact match.
|
||||
</summary>
|
||||
<value>
|
||||
The listener name. If <see langword="null" />, all listeners are matched.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.Scopes">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MeterScope"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This property is used to distinguish between meters created via <see cref="T:System.Diagnostics.Metrics.Meter"/> constructors (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Global"/>)
|
||||
and those created via Dependency Injection with <see cref="M:System.Diagnostics.Metrics.IMeterFactory.Create(System.Diagnostics.Metrics.MeterOptions)"/> (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Local"/>).
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.Enable">
|
||||
<summary>
|
||||
Gets a value that indicates whether the instrument should be enabled for the listener.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource">
|
||||
<summary>
|
||||
An interface registered with each IMetricsListener using <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Initialize(Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource)"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The listener can call <see cref="M:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource.RecordObservableInstruments"/> to receive the current set of measurements for enabled observable instruments.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.IObservableInstrumentsSource.RecordObservableInstruments">
|
||||
<summary>
|
||||
Requests that the current set of metrics for enabled instruments be sent to the listener's <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> objects.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers">
|
||||
<summary>
|
||||
Represents a set of supported measurement types. If a listener does not support a given type, the measurement is skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.ByteHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Byte"/>. If <see langword="null"/>, byte measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.ShortHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Int16"/>. If <see langword="null"/>, short measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.IntHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Int32"/>. If <see langword="null"/>, int measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.LongHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Int64"/>. If <see langword="null"/>, long measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.FloatHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Single"/>. If <see langword="null"/>, float measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.DoubleHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Double"/>. If <see langword="null"/>, double measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MeasurementHandlers.DecimalHandler">
|
||||
<summary>
|
||||
Gets or sets a <see cref="T:System.Diagnostics.Metrics.MeasurementCallback`1"/> for <see cref="T:System.Decimal"/>. If <see langword="null"/>, decimal measurements are skipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MeterScope">
|
||||
<summary>
|
||||
Represents scopes used by <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule"/> to distinguish between meters created via <see cref="T:System.Diagnostics.Metrics.Meter"/> constructors (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Global"/>)
|
||||
and those created via Dependency Injection with <see cref="M:System.Diagnostics.Metrics.IMeterFactory.Create(System.Diagnostics.Metrics.MeterOptions)"/> (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Local"/>).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.None">
|
||||
<summary>
|
||||
No scope is specified. This field should not be used.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Global">
|
||||
<summary>
|
||||
Indicates <see cref="T:System.Diagnostics.Metrics.Meter"/> instances created via <see cref="T:System.Diagnostics.Metrics.Meter"/> constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Local">
|
||||
<summary>
|
||||
Indicates <see cref="T:System.Diagnostics.Metrics.Meter"/> instances created via Dependency Injection with <see cref="M:System.Diagnostics.Metrics.IMeterFactory.Create(System.Diagnostics.Metrics.MeterOptions)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions">
|
||||
<summary>
|
||||
Extension methods for <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> to add or clear <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> registrations, and to enable or disable metrics.
|
||||
</summary>
|
||||
<summary>
|
||||
Extension methods for <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> to add or clear <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> registrations, and to enable or disable metrics.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.AddListener``1(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder)">
|
||||
<summary>
|
||||
Registers a new <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> of type <typeparamref name="T"/>.
|
||||
</summary>
|
||||
<typeparam name="T">The implementation type of the listener.</typeparam>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<returns>Returns the original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.AddListener(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener)">
|
||||
<summary>
|
||||
Registers a new <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> instance.
|
||||
</summary>
|
||||
<param name="listener">The implementation type of the listener.</param>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<returns>Returns the original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.ClearListeners(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder)">
|
||||
<summary>
|
||||
Removes all <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> registrations from the dependency injection container.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<returns>Returns the original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String)">
|
||||
<summary>
|
||||
Enables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Enables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Defaults to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String)">
|
||||
<summary>
|
||||
Enables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.EnableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Enables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Default to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String)">
|
||||
<summary>
|
||||
Disables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Disables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Defaults to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String)">
|
||||
<summary>
|
||||
Disables all instruments for the given meter, for all registered listeners.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions.DisableMetrics(Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions,System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope)">
|
||||
<summary>
|
||||
Disables a specified <see cref="T:System.Diagnostics.Metrics.Instrument"/> for the given <see cref="T:System.Diagnostics.Metrics.Meter"/> and <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/>.</param>
|
||||
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name"/> or prefix. A null value matches all meters.</param>
|
||||
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name"/>. A null value matches all instruments.</param>
|
||||
<param name="listenerName">The <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/>.Name. A null value matches all listeners.</param>
|
||||
<param name="scopes">Indicates which meter scopes to consider. Defaults to all scopes.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions">
|
||||
<summary>
|
||||
Represents options for configuring the metrics system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions.Rules">
|
||||
<summary>
|
||||
Gets a list of instrument rules that identifies which metrics, instruments, and listeners are enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.TypeNameHelper.GetTypeDisplayName(System.Type,System.Boolean,System.Boolean,System.Boolean,System.Char)">
|
||||
<summary>
|
||||
Pretty print a type name.
|
||||
</summary>
|
||||
<param name="type">The <see cref="T:System.Type"/>.</param>
|
||||
<param name="fullName"><c>true</c> to print a fully qualified name.</param>
|
||||
<param name="includeGenericParameterNames"><c>true</c> to include generic parameter names.</param>
|
||||
<param name="includeGenericParameters"><c>true</c> to include generic parameters.</param>
|
||||
<param name="nestedTypeDelimiter">Character to use as a delimiter in nested type names</param>
|
||||
<returns>The pretty printed type name.</returns>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute">
|
||||
<summary>
|
||||
Indicates that certain members on a specified <see cref="T:System.Type"/> are accessed dynamically,
|
||||
for example through <see cref="N:System.Reflection"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This allows tools to understand which members are being accessed during the execution
|
||||
of a program.
|
||||
|
||||
This attribute is valid on members whose type is <see cref="T:System.Type"/> or <see cref="T:System.String"/>.
|
||||
|
||||
When this attribute is applied to a location of type <see cref="T:System.String"/>, the assumption is
|
||||
that the string represents a fully qualified type name.
|
||||
|
||||
When this attribute is applied to a class, interface, or struct, the members specified
|
||||
can be accessed dynamically on <see cref="T:System.Type"/> instances returned from calling
|
||||
<see cref="M:System.Object.GetType"/> on instances of that class, interface, or struct.
|
||||
|
||||
If the attribute is applied to a method it's treated as a special case and it implies
|
||||
the attribute should be applied to the "this" parameter of the method. As such the attribute
|
||||
should only be used on instance methods of types assignable to System.Type (or string, but no methods
|
||||
will use it there).
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute"/> class
|
||||
with the specified member types.
|
||||
</summary>
|
||||
<param name="memberTypes">The types of members dynamically accessed.</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes">
|
||||
<summary>
|
||||
Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
|
||||
of members dynamically accessed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
|
||||
<summary>
|
||||
Specifies the types of members that are dynamically accessed.
|
||||
|
||||
This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a
|
||||
bitwise combination of its member values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
|
||||
<summary>
|
||||
Specifies no members.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
|
||||
<summary>
|
||||
Specifies the default, parameterless public constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
|
||||
<summary>
|
||||
Specifies all public constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
|
||||
<summary>
|
||||
Specifies all non-public constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
|
||||
<summary>
|
||||
Specifies all public methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
|
||||
<summary>
|
||||
Specifies all non-public methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
|
||||
<summary>
|
||||
Specifies all public fields.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
|
||||
<summary>
|
||||
Specifies all non-public fields.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
|
||||
<summary>
|
||||
Specifies all public nested types.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
|
||||
<summary>
|
||||
Specifies all non-public nested types.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
|
||||
<summary>
|
||||
Specifies all public properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
|
||||
<summary>
|
||||
Specifies all non-public properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
|
||||
<summary>
|
||||
Specifies all public events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
|
||||
<summary>
|
||||
Specifies all non-public events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
|
||||
<summary>
|
||||
Specifies all interfaces implemented by the type.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructorsWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public constructors, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethodsWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public methods, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFieldsWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public fields, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypesWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public nested types, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicPropertiesWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public properties, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEventsWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public events, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructorsWithInherited">
|
||||
<summary>
|
||||
Specifies all public constructors, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypesWithInherited">
|
||||
<summary>
|
||||
Specifies all public nested types, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllConstructors">
|
||||
<summary>
|
||||
Specifies all constructors, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllMethods">
|
||||
<summary>
|
||||
Specifies all methods, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllFields">
|
||||
<summary>
|
||||
Specifies all fields, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllNestedTypes">
|
||||
<summary>
|
||||
Specifies all nested types, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllProperties">
|
||||
<summary>
|
||||
Specifies all properties, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllEvents">
|
||||
<summary>
|
||||
Specifies all events, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
|
||||
<summary>
|
||||
Specifies all members.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field or property member will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field and property members will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute">
|
||||
<summary>
|
||||
When applied to an attribute class, instructs the compiler to flow applications of that attribute,
|
||||
from source code down to compiler-generated symbols. This can help IL-based analysis tools.
|
||||
</summary>
|
||||
<remarks>
|
||||
One example where this attribute applies is in C# primary constructor parameters. If an attribute
|
||||
marked with <see cref="T:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute"/> gets applied to a primary constructor
|
||||
parameter, the attribute will also be applied to any compiler-generated fields storing that parameter.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.ExceptionPolyfills">
|
||||
<summary>Provides downlevel polyfills for static methods on Exception-derived types.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
uYtoWfMgpewhlZ/PcOOoY1OPM0moBQOg9gRdYJMt1Ucx5mVJLsXBQIShj7yTuwkGZq+zOBm4QlDKencLGkjUdQ==
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "dOpmW14MkOZIwV6269iXhoMp6alCHBoxqCR4pJ37GLjFaBIyzsIy+Ra8tsGmjHtFvEHKq0JRDIsb1PUkrK+yxw==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@@ -0,0 +1,40 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.FileProviders.Abstractions</id>
|
||||
<version>10.0.0-rc.2.25502.107</version>
|
||||
<authors>Microsoft</authors>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>Icon.png</icon>
|
||||
<readme>PACKAGE.md</readme>
|
||||
<projectUrl>https://dot.net/</projectUrl>
|
||||
<description>Abstractions of files and directories.
|
||||
|
||||
Commonly Used Types:
|
||||
Microsoft.Extensions.FileProviders.IDirectoryContents
|
||||
Microsoft.Extensions.FileProviders.IFileInfo
|
||||
Microsoft.Extensions.FileProviders.IFileProvider</description>
|
||||
<releaseNotes>https://go.microsoft.com/fwlink/?LinkID=799421</releaseNotes>
|
||||
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
|
||||
<serviceable>true</serviceable>
|
||||
<repository type="git" url="https://github.com/dotnet/dotnet" commit="89c8f6a112d37d2ea8b77821e56d170a1bccdc5a" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.6.2">
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net8.0">
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net9.0">
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net10.0">
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
@@ -0,0 +1,51 @@
|
||||
## About
|
||||
|
||||
<!-- A description of the package and where one can find more documentation -->
|
||||
|
||||
Serves as the foundation for creating file providers in .NET, offering core abstractions to develop custom file providers capable of fetching files from various sources.
|
||||
|
||||
## Key Features
|
||||
|
||||
<!-- The key features of this package -->
|
||||
|
||||
* Core abstractions for creating and managing file providers.
|
||||
* Flexibility to develop custom file providers for fetching files from distinct sources.
|
||||
|
||||
## How to Use
|
||||
|
||||
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
|
||||
|
||||
This package is typically used with an implementation of the file provider abstractions, such as `Microsoft.Extensions.FileProviders.Composite` or `Microsoft.Extensions.FileProviders.Physical`.
|
||||
|
||||
## Main Types
|
||||
|
||||
<!-- The main types provided in this library -->
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `Microsoft.Extensions.FileProviders.IFileProvider`
|
||||
* `Microsoft.Extensions.FileProviders.IDirectoryContents`
|
||||
* `Microsoft.Extensions.FileProviders.IFileInfo`
|
||||
* `Microsoft.Extensions.FileProviders.NullFileProvider`
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
|
||||
|
||||
* [Conceptual documentation](https://learn.microsoft.com/aspnet/core/fundamentals/file-providers)
|
||||
* [Detect changes with change tokens](https://learn.microsoft.com/aspnet/core/fundamentals/change-tokens)
|
||||
* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.fileproviders)
|
||||
|
||||
## Related Packages
|
||||
|
||||
<!-- The related packages associated with this package -->
|
||||
|
||||
* File provider for physical files: [Microsoft.Extensions.FileProviders.Physical](https://www.nuget.org/packages/Microsoft.Extensions.FileProviders.Physical/)
|
||||
* File provider for files in embedded resources: [Microsoft.Extensions.FileProviders.Embedded](https://www.nuget.org/packages/Microsoft.Extensions.FileProviders.Embedded/)
|
||||
* Composite file and directory providers: [Microsoft.Extensions.FileProviders.Composite](https://www.nuget.org/packages/Microsoft.Extensions.FileProviders.Composite/)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
<!-- How to provide feedback on this package and contribute to it -->
|
||||
|
||||
Microsoft.Extensions.FileProviders.Abstractions is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_FileProviders_Abstractions_net462">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_FileProviders_Abstractions_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.FileProviders.Abstractions 10.0.0-rc.2.25502.107 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net462 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_FileProviders_Abstractions_net8_0">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_FileProviders_Abstractions_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.FileProviders.Abstractions 10.0.0-rc.2.25502.107 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net8.0 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,211 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.FileProviders.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IDirectoryContents">
|
||||
<summary>
|
||||
Represents a directory's content in the file provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IDirectoryContents.Exists">
|
||||
<summary>
|
||||
True if a directory was located at the given path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IFileInfo">
|
||||
<summary>
|
||||
Represents a file in the given file provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Exists">
|
||||
<summary>
|
||||
Gets a value that indicates if the resource exists in the underlying storage system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Length">
|
||||
<summary>
|
||||
Gets the length of the file in bytes, or -1 for a directory or nonexistent file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.PhysicalPath">
|
||||
<summary>
|
||||
Gets the path to the file, including the file name. Returns <see langword="null"/> if the file is not directly accessible.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Name">
|
||||
<summary>
|
||||
Gets the name of the file or directory, not including any path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.LastModified">
|
||||
<summary>
|
||||
Gets the time when the file was last modified.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.IsDirectory">
|
||||
<summary>
|
||||
Gets a value that indicates whether <c>TryGetDirectoryContents</c> has enumerated a subdirectory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileInfo.CreateReadStream">
|
||||
<summary>
|
||||
Returns file contents as a read-only stream.
|
||||
</summary>
|
||||
<returns>The file stream.</returns>
|
||||
<remarks>The caller should dispose the stream when complete.</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IFileProvider">
|
||||
<summary>
|
||||
A read-only file provider abstraction.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.GetFileInfo(System.String)">
|
||||
<summary>
|
||||
Locates a file at the given path.
|
||||
</summary>
|
||||
<param name="subpath">The relative path that identifies the file.</param>
|
||||
<returns>The file information. Caller must check Exists property.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.GetDirectoryContents(System.String)">
|
||||
<summary>
|
||||
Enumerates a directory at the given path, if any.
|
||||
</summary>
|
||||
<param name="subpath">The relative path that identifies the directory.</param>
|
||||
<returns>The contents of the directory.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.Watch(System.String)">
|
||||
<summary>
|
||||
Creates an <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> for the specified <paramref name="filter"/>.
|
||||
</summary>
|
||||
<param name="filter">A filter string used to determine what files or folders to monitor. Examples: **/*.cs, *.*, subFolder/**/*.cshtml.</param>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that is notified when a file matching <paramref name="filter"/> is added, modified, or deleted.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents">
|
||||
<summary>
|
||||
Represents a nonexistent directory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.Singleton">
|
||||
<summary>
|
||||
Gets a shared instance of <see cref="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.Exists">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.GetEnumerator">
|
||||
<summary>Returns an enumerator that iterates through the collection.</summary>
|
||||
<returns>An enumerator to an empty collection.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.System#Collections#IEnumerable#GetEnumerator">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo">
|
||||
<summary>
|
||||
Represents a nonexistent file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundFileInfo.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo"/>.
|
||||
</summary>
|
||||
<param name="name">The name of the file that could not be found.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Exists">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.IsDirectory">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.LastModified">
|
||||
<summary>
|
||||
Gets <see cref="F:System.DateTimeOffset.MinValue"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Length">
|
||||
<summary>
|
||||
Gets a value that's always -1.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Name">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.PhysicalPath">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="null"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundFileInfo.CreateReadStream">
|
||||
<summary>
|
||||
Always throws. A stream cannot be created for a nonexistent file.
|
||||
</summary>
|
||||
<exception cref="T:System.IO.FileNotFoundException">In all cases.</exception>
|
||||
<returns>Does not return.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NullChangeToken">
|
||||
<summary>
|
||||
An empty change token that doesn't raise any change callbacks.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.Singleton">
|
||||
<summary>
|
||||
Gets a singleton instance of <see cref="T:Microsoft.Extensions.FileProviders.NullChangeToken"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.HasChanged">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.ActiveChangeCallbacks">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
|
||||
<summary>
|
||||
Always returns an empty disposable object. Callbacks will never be called.
|
||||
</summary>
|
||||
<param name="callback">This parameter is ignored.</param>
|
||||
<param name="state">This parameter is ignored.</param>
|
||||
<returns>A disposable object that no-ops on dispose.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NullFileProvider">
|
||||
<summary>
|
||||
An empty file provider with no contents.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.GetDirectoryContents(System.String)">
|
||||
<summary>
|
||||
Enumerates a nonexistent directory.
|
||||
</summary>
|
||||
<param name="subpath">A path under the root directory. This parameter is ignored.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.FileProviders.IDirectoryContents"/> that does not exist and does not contain any contents.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.GetFileInfo(System.String)">
|
||||
<summary>
|
||||
Locates a nonexistent file.
|
||||
</summary>
|
||||
<param name="subpath">A path under the root directory.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.FileProviders.IFileInfo"/> representing a nonexistent file at the given path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.Watch(System.String)">
|
||||
<summary>
|
||||
Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that monitors nothing.
|
||||
</summary>
|
||||
<param name="filter">Filter string used to determine what files or folders to monitor. This parameter is ignored.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that does not register callbacks.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.FileNotExists">
|
||||
<summary>The file {0} does not exist.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,394 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.FileProviders.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IDirectoryContents">
|
||||
<summary>
|
||||
Represents a directory's content in the file provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IDirectoryContents.Exists">
|
||||
<summary>
|
||||
True if a directory was located at the given path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IFileInfo">
|
||||
<summary>
|
||||
Represents a file in the given file provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Exists">
|
||||
<summary>
|
||||
Gets a value that indicates if the resource exists in the underlying storage system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Length">
|
||||
<summary>
|
||||
Gets the length of the file in bytes, or -1 for a directory or nonexistent file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.PhysicalPath">
|
||||
<summary>
|
||||
Gets the path to the file, including the file name. Returns <see langword="null"/> if the file is not directly accessible.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Name">
|
||||
<summary>
|
||||
Gets the name of the file or directory, not including any path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.LastModified">
|
||||
<summary>
|
||||
Gets the time when the file was last modified.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.IsDirectory">
|
||||
<summary>
|
||||
Gets a value that indicates whether <c>TryGetDirectoryContents</c> has enumerated a subdirectory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileInfo.CreateReadStream">
|
||||
<summary>
|
||||
Returns file contents as a read-only stream.
|
||||
</summary>
|
||||
<returns>The file stream.</returns>
|
||||
<remarks>The caller should dispose the stream when complete.</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IFileProvider">
|
||||
<summary>
|
||||
A read-only file provider abstraction.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.GetFileInfo(System.String)">
|
||||
<summary>
|
||||
Locates a file at the given path.
|
||||
</summary>
|
||||
<param name="subpath">The relative path that identifies the file.</param>
|
||||
<returns>The file information. Caller must check Exists property.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.GetDirectoryContents(System.String)">
|
||||
<summary>
|
||||
Enumerates a directory at the given path, if any.
|
||||
</summary>
|
||||
<param name="subpath">The relative path that identifies the directory.</param>
|
||||
<returns>The contents of the directory.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.Watch(System.String)">
|
||||
<summary>
|
||||
Creates an <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> for the specified <paramref name="filter"/>.
|
||||
</summary>
|
||||
<param name="filter">A filter string used to determine what files or folders to monitor. Examples: **/*.cs, *.*, subFolder/**/*.cshtml.</param>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that is notified when a file matching <paramref name="filter"/> is added, modified, or deleted.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents">
|
||||
<summary>
|
||||
Represents a nonexistent directory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.Singleton">
|
||||
<summary>
|
||||
Gets a shared instance of <see cref="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.Exists">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.GetEnumerator">
|
||||
<summary>Returns an enumerator that iterates through the collection.</summary>
|
||||
<returns>An enumerator to an empty collection.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.System#Collections#IEnumerable#GetEnumerator">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo">
|
||||
<summary>
|
||||
Represents a nonexistent file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundFileInfo.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo"/>.
|
||||
</summary>
|
||||
<param name="name">The name of the file that could not be found.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Exists">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.IsDirectory">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.LastModified">
|
||||
<summary>
|
||||
Gets <see cref="F:System.DateTimeOffset.MinValue"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Length">
|
||||
<summary>
|
||||
Gets a value that's always -1.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Name">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.PhysicalPath">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="null"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundFileInfo.CreateReadStream">
|
||||
<summary>
|
||||
Always throws. A stream cannot be created for a nonexistent file.
|
||||
</summary>
|
||||
<exception cref="T:System.IO.FileNotFoundException">In all cases.</exception>
|
||||
<returns>Does not return.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NullChangeToken">
|
||||
<summary>
|
||||
An empty change token that doesn't raise any change callbacks.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.Singleton">
|
||||
<summary>
|
||||
Gets a singleton instance of <see cref="T:Microsoft.Extensions.FileProviders.NullChangeToken"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.HasChanged">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.ActiveChangeCallbacks">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
|
||||
<summary>
|
||||
Always returns an empty disposable object. Callbacks will never be called.
|
||||
</summary>
|
||||
<param name="callback">This parameter is ignored.</param>
|
||||
<param name="state">This parameter is ignored.</param>
|
||||
<returns>A disposable object that no-ops on dispose.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NullFileProvider">
|
||||
<summary>
|
||||
An empty file provider with no contents.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.GetDirectoryContents(System.String)">
|
||||
<summary>
|
||||
Enumerates a nonexistent directory.
|
||||
</summary>
|
||||
<param name="subpath">A path under the root directory. This parameter is ignored.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.FileProviders.IDirectoryContents"/> that does not exist and does not contain any contents.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.GetFileInfo(System.String)">
|
||||
<summary>
|
||||
Locates a nonexistent file.
|
||||
</summary>
|
||||
<param name="subpath">A path under the root directory.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.FileProviders.IFileInfo"/> representing a nonexistent file at the given path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.Watch(System.String)">
|
||||
<summary>
|
||||
Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that monitors nothing.
|
||||
</summary>
|
||||
<param name="filter">Filter string used to determine what files or folders to monitor. This parameter is ignored.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that does not register callbacks.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.FileNotExists">
|
||||
<summary>The file {0} does not exist.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field or property member will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field and property members will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.ExceptionPolyfills">
|
||||
<summary>Provides downlevel polyfills for static methods on Exception-derived types.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,211 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.FileProviders.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IDirectoryContents">
|
||||
<summary>
|
||||
Represents a directory's content in the file provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IDirectoryContents.Exists">
|
||||
<summary>
|
||||
True if a directory was located at the given path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IFileInfo">
|
||||
<summary>
|
||||
Represents a file in the given file provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Exists">
|
||||
<summary>
|
||||
Gets a value that indicates if the resource exists in the underlying storage system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Length">
|
||||
<summary>
|
||||
Gets the length of the file in bytes, or -1 for a directory or nonexistent file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.PhysicalPath">
|
||||
<summary>
|
||||
Gets the path to the file, including the file name. Returns <see langword="null"/> if the file is not directly accessible.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Name">
|
||||
<summary>
|
||||
Gets the name of the file or directory, not including any path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.LastModified">
|
||||
<summary>
|
||||
Gets the time when the file was last modified.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.IsDirectory">
|
||||
<summary>
|
||||
Gets a value that indicates whether <c>TryGetDirectoryContents</c> has enumerated a subdirectory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileInfo.CreateReadStream">
|
||||
<summary>
|
||||
Returns file contents as a read-only stream.
|
||||
</summary>
|
||||
<returns>The file stream.</returns>
|
||||
<remarks>The caller should dispose the stream when complete.</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IFileProvider">
|
||||
<summary>
|
||||
A read-only file provider abstraction.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.GetFileInfo(System.String)">
|
||||
<summary>
|
||||
Locates a file at the given path.
|
||||
</summary>
|
||||
<param name="subpath">The relative path that identifies the file.</param>
|
||||
<returns>The file information. Caller must check Exists property.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.GetDirectoryContents(System.String)">
|
||||
<summary>
|
||||
Enumerates a directory at the given path, if any.
|
||||
</summary>
|
||||
<param name="subpath">The relative path that identifies the directory.</param>
|
||||
<returns>The contents of the directory.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.Watch(System.String)">
|
||||
<summary>
|
||||
Creates an <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> for the specified <paramref name="filter"/>.
|
||||
</summary>
|
||||
<param name="filter">A filter string used to determine what files or folders to monitor. Examples: **/*.cs, *.*, subFolder/**/*.cshtml.</param>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that is notified when a file matching <paramref name="filter"/> is added, modified, or deleted.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents">
|
||||
<summary>
|
||||
Represents a nonexistent directory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.Singleton">
|
||||
<summary>
|
||||
Gets a shared instance of <see cref="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.Exists">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.GetEnumerator">
|
||||
<summary>Returns an enumerator that iterates through the collection.</summary>
|
||||
<returns>An enumerator to an empty collection.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.System#Collections#IEnumerable#GetEnumerator">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo">
|
||||
<summary>
|
||||
Represents a nonexistent file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundFileInfo.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo"/>.
|
||||
</summary>
|
||||
<param name="name">The name of the file that could not be found.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Exists">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.IsDirectory">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.LastModified">
|
||||
<summary>
|
||||
Gets <see cref="F:System.DateTimeOffset.MinValue"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Length">
|
||||
<summary>
|
||||
Gets a value that's always -1.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Name">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.PhysicalPath">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="null"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundFileInfo.CreateReadStream">
|
||||
<summary>
|
||||
Always throws. A stream cannot be created for a nonexistent file.
|
||||
</summary>
|
||||
<exception cref="T:System.IO.FileNotFoundException">In all cases.</exception>
|
||||
<returns>Does not return.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NullChangeToken">
|
||||
<summary>
|
||||
An empty change token that doesn't raise any change callbacks.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.Singleton">
|
||||
<summary>
|
||||
Gets a singleton instance of <see cref="T:Microsoft.Extensions.FileProviders.NullChangeToken"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.HasChanged">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.ActiveChangeCallbacks">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
|
||||
<summary>
|
||||
Always returns an empty disposable object. Callbacks will never be called.
|
||||
</summary>
|
||||
<param name="callback">This parameter is ignored.</param>
|
||||
<param name="state">This parameter is ignored.</param>
|
||||
<returns>A disposable object that no-ops on dispose.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NullFileProvider">
|
||||
<summary>
|
||||
An empty file provider with no contents.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.GetDirectoryContents(System.String)">
|
||||
<summary>
|
||||
Enumerates a nonexistent directory.
|
||||
</summary>
|
||||
<param name="subpath">A path under the root directory. This parameter is ignored.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.FileProviders.IDirectoryContents"/> that does not exist and does not contain any contents.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.GetFileInfo(System.String)">
|
||||
<summary>
|
||||
Locates a nonexistent file.
|
||||
</summary>
|
||||
<param name="subpath">A path under the root directory.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.FileProviders.IFileInfo"/> representing a nonexistent file at the given path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.Watch(System.String)">
|
||||
<summary>
|
||||
Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that monitors nothing.
|
||||
</summary>
|
||||
<param name="filter">Filter string used to determine what files or folders to monitor. This parameter is ignored.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that does not register callbacks.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.FileNotExists">
|
||||
<summary>The file {0} does not exist.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,211 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.FileProviders.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IDirectoryContents">
|
||||
<summary>
|
||||
Represents a directory's content in the file provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IDirectoryContents.Exists">
|
||||
<summary>
|
||||
True if a directory was located at the given path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IFileInfo">
|
||||
<summary>
|
||||
Represents a file in the given file provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Exists">
|
||||
<summary>
|
||||
Gets a value that indicates if the resource exists in the underlying storage system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Length">
|
||||
<summary>
|
||||
Gets the length of the file in bytes, or -1 for a directory or nonexistent file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.PhysicalPath">
|
||||
<summary>
|
||||
Gets the path to the file, including the file name. Returns <see langword="null"/> if the file is not directly accessible.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Name">
|
||||
<summary>
|
||||
Gets the name of the file or directory, not including any path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.LastModified">
|
||||
<summary>
|
||||
Gets the time when the file was last modified.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.IsDirectory">
|
||||
<summary>
|
||||
Gets a value that indicates whether <c>TryGetDirectoryContents</c> has enumerated a subdirectory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileInfo.CreateReadStream">
|
||||
<summary>
|
||||
Returns file contents as a read-only stream.
|
||||
</summary>
|
||||
<returns>The file stream.</returns>
|
||||
<remarks>The caller should dispose the stream when complete.</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IFileProvider">
|
||||
<summary>
|
||||
A read-only file provider abstraction.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.GetFileInfo(System.String)">
|
||||
<summary>
|
||||
Locates a file at the given path.
|
||||
</summary>
|
||||
<param name="subpath">The relative path that identifies the file.</param>
|
||||
<returns>The file information. Caller must check Exists property.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.GetDirectoryContents(System.String)">
|
||||
<summary>
|
||||
Enumerates a directory at the given path, if any.
|
||||
</summary>
|
||||
<param name="subpath">The relative path that identifies the directory.</param>
|
||||
<returns>The contents of the directory.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.Watch(System.String)">
|
||||
<summary>
|
||||
Creates an <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> for the specified <paramref name="filter"/>.
|
||||
</summary>
|
||||
<param name="filter">A filter string used to determine what files or folders to monitor. Examples: **/*.cs, *.*, subFolder/**/*.cshtml.</param>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that is notified when a file matching <paramref name="filter"/> is added, modified, or deleted.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents">
|
||||
<summary>
|
||||
Represents a nonexistent directory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.Singleton">
|
||||
<summary>
|
||||
Gets a shared instance of <see cref="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.Exists">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.GetEnumerator">
|
||||
<summary>Returns an enumerator that iterates through the collection.</summary>
|
||||
<returns>An enumerator to an empty collection.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.System#Collections#IEnumerable#GetEnumerator">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo">
|
||||
<summary>
|
||||
Represents a nonexistent file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundFileInfo.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo"/>.
|
||||
</summary>
|
||||
<param name="name">The name of the file that could not be found.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Exists">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.IsDirectory">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.LastModified">
|
||||
<summary>
|
||||
Gets <see cref="F:System.DateTimeOffset.MinValue"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Length">
|
||||
<summary>
|
||||
Gets a value that's always -1.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Name">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.PhysicalPath">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="null"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundFileInfo.CreateReadStream">
|
||||
<summary>
|
||||
Always throws. A stream cannot be created for a nonexistent file.
|
||||
</summary>
|
||||
<exception cref="T:System.IO.FileNotFoundException">In all cases.</exception>
|
||||
<returns>Does not return.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NullChangeToken">
|
||||
<summary>
|
||||
An empty change token that doesn't raise any change callbacks.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.Singleton">
|
||||
<summary>
|
||||
Gets a singleton instance of <see cref="T:Microsoft.Extensions.FileProviders.NullChangeToken"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.HasChanged">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.ActiveChangeCallbacks">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
|
||||
<summary>
|
||||
Always returns an empty disposable object. Callbacks will never be called.
|
||||
</summary>
|
||||
<param name="callback">This parameter is ignored.</param>
|
||||
<param name="state">This parameter is ignored.</param>
|
||||
<returns>A disposable object that no-ops on dispose.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NullFileProvider">
|
||||
<summary>
|
||||
An empty file provider with no contents.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.GetDirectoryContents(System.String)">
|
||||
<summary>
|
||||
Enumerates a nonexistent directory.
|
||||
</summary>
|
||||
<param name="subpath">A path under the root directory. This parameter is ignored.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.FileProviders.IDirectoryContents"/> that does not exist and does not contain any contents.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.GetFileInfo(System.String)">
|
||||
<summary>
|
||||
Locates a nonexistent file.
|
||||
</summary>
|
||||
<param name="subpath">A path under the root directory.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.FileProviders.IFileInfo"/> representing a nonexistent file at the given path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.Watch(System.String)">
|
||||
<summary>
|
||||
Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that monitors nothing.
|
||||
</summary>
|
||||
<param name="filter">Filter string used to determine what files or folders to monitor. This parameter is ignored.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that does not register callbacks.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.FileNotExists">
|
||||
<summary>The file {0} does not exist.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,394 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.FileProviders.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IDirectoryContents">
|
||||
<summary>
|
||||
Represents a directory's content in the file provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IDirectoryContents.Exists">
|
||||
<summary>
|
||||
True if a directory was located at the given path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IFileInfo">
|
||||
<summary>
|
||||
Represents a file in the given file provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Exists">
|
||||
<summary>
|
||||
Gets a value that indicates if the resource exists in the underlying storage system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Length">
|
||||
<summary>
|
||||
Gets the length of the file in bytes, or -1 for a directory or nonexistent file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.PhysicalPath">
|
||||
<summary>
|
||||
Gets the path to the file, including the file name. Returns <see langword="null"/> if the file is not directly accessible.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Name">
|
||||
<summary>
|
||||
Gets the name of the file or directory, not including any path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.LastModified">
|
||||
<summary>
|
||||
Gets the time when the file was last modified.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.IsDirectory">
|
||||
<summary>
|
||||
Gets a value that indicates whether <c>TryGetDirectoryContents</c> has enumerated a subdirectory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileInfo.CreateReadStream">
|
||||
<summary>
|
||||
Returns file contents as a read-only stream.
|
||||
</summary>
|
||||
<returns>The file stream.</returns>
|
||||
<remarks>The caller should dispose the stream when complete.</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IFileProvider">
|
||||
<summary>
|
||||
A read-only file provider abstraction.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.GetFileInfo(System.String)">
|
||||
<summary>
|
||||
Locates a file at the given path.
|
||||
</summary>
|
||||
<param name="subpath">The relative path that identifies the file.</param>
|
||||
<returns>The file information. Caller must check Exists property.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.GetDirectoryContents(System.String)">
|
||||
<summary>
|
||||
Enumerates a directory at the given path, if any.
|
||||
</summary>
|
||||
<param name="subpath">The relative path that identifies the directory.</param>
|
||||
<returns>The contents of the directory.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.Watch(System.String)">
|
||||
<summary>
|
||||
Creates an <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> for the specified <paramref name="filter"/>.
|
||||
</summary>
|
||||
<param name="filter">A filter string used to determine what files or folders to monitor. Examples: **/*.cs, *.*, subFolder/**/*.cshtml.</param>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that is notified when a file matching <paramref name="filter"/> is added, modified, or deleted.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents">
|
||||
<summary>
|
||||
Represents a nonexistent directory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.Singleton">
|
||||
<summary>
|
||||
Gets a shared instance of <see cref="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.Exists">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.GetEnumerator">
|
||||
<summary>Returns an enumerator that iterates through the collection.</summary>
|
||||
<returns>An enumerator to an empty collection.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.System#Collections#IEnumerable#GetEnumerator">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo">
|
||||
<summary>
|
||||
Represents a nonexistent file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundFileInfo.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo"/>.
|
||||
</summary>
|
||||
<param name="name">The name of the file that could not be found.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Exists">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.IsDirectory">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.LastModified">
|
||||
<summary>
|
||||
Gets <see cref="F:System.DateTimeOffset.MinValue"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Length">
|
||||
<summary>
|
||||
Gets a value that's always -1.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Name">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.PhysicalPath">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="null"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundFileInfo.CreateReadStream">
|
||||
<summary>
|
||||
Always throws. A stream cannot be created for a nonexistent file.
|
||||
</summary>
|
||||
<exception cref="T:System.IO.FileNotFoundException">In all cases.</exception>
|
||||
<returns>Does not return.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NullChangeToken">
|
||||
<summary>
|
||||
An empty change token that doesn't raise any change callbacks.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.Singleton">
|
||||
<summary>
|
||||
Gets a singleton instance of <see cref="T:Microsoft.Extensions.FileProviders.NullChangeToken"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.HasChanged">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.ActiveChangeCallbacks">
|
||||
<summary>
|
||||
Gets a value that's always <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
|
||||
<summary>
|
||||
Always returns an empty disposable object. Callbacks will never be called.
|
||||
</summary>
|
||||
<param name="callback">This parameter is ignored.</param>
|
||||
<param name="state">This parameter is ignored.</param>
|
||||
<returns>A disposable object that no-ops on dispose.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NullFileProvider">
|
||||
<summary>
|
||||
An empty file provider with no contents.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.GetDirectoryContents(System.String)">
|
||||
<summary>
|
||||
Enumerates a nonexistent directory.
|
||||
</summary>
|
||||
<param name="subpath">A path under the root directory. This parameter is ignored.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.FileProviders.IDirectoryContents"/> that does not exist and does not contain any contents.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.GetFileInfo(System.String)">
|
||||
<summary>
|
||||
Locates a nonexistent file.
|
||||
</summary>
|
||||
<param name="subpath">A path under the root directory.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.FileProviders.IFileInfo"/> representing a nonexistent file at the given path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.Watch(System.String)">
|
||||
<summary>
|
||||
Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that monitors nothing.
|
||||
</summary>
|
||||
<param name="filter">Filter string used to determine what files or folders to monitor. This parameter is ignored.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that does not register callbacks.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.FileNotExists">
|
||||
<summary>The file {0} does not exist.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field or property member will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field and property members will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.ExceptionPolyfills">
|
||||
<summary>Provides downlevel polyfills for static methods on Exception-derived types.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
XXEaDg+lUAWxOMML/ip80n5T04QBqSu+oC878Jq8Lno2qZLWoheu5Nn85Ex/zJvByfEDXDMcUugWZW0ExxY+bg==
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "M6zqZFbqjdCx8g5Y2XZKTfYfS0gAh4uJkmdAq/ZRDrpIr3Nd+u74allmw15jX1kM61IXM49EnTbhMzlWw5pGVQ==",
|
||||
"source": "/mnt/e/dev/git.stella-ops.org/local-nugets"
|
||||
}
|
||||
Binary file not shown.
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user