update of local deps cache
This commit is contained in:
master
@@ -1,30 +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>
|
||||
<?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>
|
||||
@@ -1,211 +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>
|
||||
<?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>
|
||||
|
||||
@@ -1,211 +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>
|
||||
<?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>
|
||||
|
||||
@@ -1,211 +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>
|
||||
<?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>
|
||||
|
||||
@@ -1,208 +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>
|
||||
<?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>
|
||||
|
||||
@@ -1,211 +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>
|
||||
<?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>
|
||||
|
||||
@@ -1,45 +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>
|
||||
<?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>
|
||||
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
@@ -1,36 +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>
|
||||
<?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>
|
||||
@@ -1,82 +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).
|
||||
## 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
@@ -1,6 +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>
|
||||
<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>
|
||||
|
||||
@@ -1,6 +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>
|
||||
<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>
|
||||
|
||||
@@ -1,341 +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>
|
||||
<?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>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,341 +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>
|
||||
<?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>
|
||||
|
||||
@@ -1,341 +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>
|
||||
<?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>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,35 +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>
|
||||
<?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>
|
||||
@@ -1,34 +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).
|
||||
## 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
@@ -1,6 +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>
|
||||
<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>
|
||||
|
||||
@@ -1,6 +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>
|
||||
<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
@@ -1,55 +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>
|
||||
<?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
@@ -1,6 +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>
|
||||
<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>
|
||||
|
||||
@@ -1,6 +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>
|
||||
<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>
|
||||
|
||||
@@ -1,333 +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>
|
||||
<?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>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,333 +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>
|
||||
<?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>
|
||||
|
||||
@@ -1,333 +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>
|
||||
<?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>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,40 +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>
|
||||
<?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>
|
||||
@@ -1,51 +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).
|
||||
## 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
@@ -1,6 +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>
|
||||
<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>
|
||||
|
||||
@@ -1,6 +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>
|
||||
<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>
|
||||
|
||||
@@ -1,211 +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>
|
||||
<?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>
|
||||
|
||||
@@ -1,394 +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>
|
||||
<?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>
|
||||
|
||||
@@ -1,211 +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>
|
||||
<?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>
|
||||
|
||||
@@ -1,211 +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>
|
||||
<?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>
|
||||
|
||||
@@ -1,394 +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>
|
||||
<?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>
|
||||
|
||||
@@ -1,66 +1,66 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Hosting.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>Hosting and startup abstractions for applications.</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="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Diagnostics.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" 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">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Diagnostics.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net9.0">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Diagnostics.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net10.0">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Diagnostics.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Microsoft.Bcl.AsyncInterfaces" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Diagnostics.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" 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">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Diagnostics.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Hosting.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>Hosting and startup abstractions for applications.</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="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Diagnostics.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" 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">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Diagnostics.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net9.0">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Diagnostics.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net10.0">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Diagnostics.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Microsoft.Bcl.AsyncInterfaces" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Diagnostics.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" 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">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Diagnostics.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
@@ -1,43 +1,43 @@
|
||||
## About
|
||||
Contains abstractions to host user code in an application by encapsulating an application's resources and lifetime functionality including:
|
||||
- Dependency injection (DI).
|
||||
- Logging.
|
||||
- Configuration.
|
||||
- Starting, stopping and obtaining notifications.
|
||||
|
||||
This package is also used to wire up specific application models like ASP.NET Core that are built on top of hosting.
|
||||
|
||||
## Key Features
|
||||
* Provides the `BackgroundService` base class and the `IHostedService` interface for implementing worker services.
|
||||
* Provides interfaces used to configure and start\stop a host.
|
||||
* Provides types to obtain environment settings such as an application name and paths.
|
||||
|
||||
## How to Use
|
||||
See the Conceptual documentation below for using `BackgroundService` and `IHostedService` to host worker services.
|
||||
|
||||
## Main Types
|
||||
The main types provided by this library are:
|
||||
|
||||
* `Microsoft.Extensions.Hosting.BackgroundService`
|
||||
* `Microsoft.Extensions.Hosting.IHostBuilder`
|
||||
* `Microsoft.Extensions.Hosting.IHostedService`
|
||||
|
||||
## Additional Documentation
|
||||
* Conceptual documentation
|
||||
- [Worker services in .NET](https://learn.microsoft.com/dotnet/core/extensions/workers)
|
||||
- [Implement the IHostedService interface](https://learn.microsoft.com/dotnet/core/extensions/timer-service)
|
||||
* API documentation
|
||||
- [BackgroundService](https://learn.microsoft.com/dotnet/api/microsoft.extensions.hosting.backgroundservice)
|
||||
- [IHostBuilder](https://learn.microsoft.com/dotnet/api/microsoft.extensions.hosting.ihostbuilder)
|
||||
- [IHostedService](https://learn.microsoft.com/dotnet/api/microsoft.extensions.hosting.ihostedservice)
|
||||
|
||||
## Related Packages
|
||||
- `Microsoft.Extensions.Hosting`
|
||||
- `Microsoft.Extensions.Configuration.Abstractions`
|
||||
- `Microsoft.Extensions.DependencyInjection.Abstractions`
|
||||
- `Microsoft.Extensions.Diagnostics.Abstractions`
|
||||
- `Microsoft.Extensions.FileProviders.Abstractions`
|
||||
- `Microsoft.Extensions.Logging.Abstractions`
|
||||
|
||||
## Feedback & Contributing
|
||||
Microsoft.Extensions.Hosting.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).
|
||||
## About
|
||||
Contains abstractions to host user code in an application by encapsulating an application's resources and lifetime functionality including:
|
||||
- Dependency injection (DI).
|
||||
- Logging.
|
||||
- Configuration.
|
||||
- Starting, stopping and obtaining notifications.
|
||||
|
||||
This package is also used to wire up specific application models like ASP.NET Core that are built on top of hosting.
|
||||
|
||||
## Key Features
|
||||
* Provides the `BackgroundService` base class and the `IHostedService` interface for implementing worker services.
|
||||
* Provides interfaces used to configure and start\stop a host.
|
||||
* Provides types to obtain environment settings such as an application name and paths.
|
||||
|
||||
## How to Use
|
||||
See the Conceptual documentation below for using `BackgroundService` and `IHostedService` to host worker services.
|
||||
|
||||
## Main Types
|
||||
The main types provided by this library are:
|
||||
|
||||
* `Microsoft.Extensions.Hosting.BackgroundService`
|
||||
* `Microsoft.Extensions.Hosting.IHostBuilder`
|
||||
* `Microsoft.Extensions.Hosting.IHostedService`
|
||||
|
||||
## Additional Documentation
|
||||
* Conceptual documentation
|
||||
- [Worker services in .NET](https://learn.microsoft.com/dotnet/core/extensions/workers)
|
||||
- [Implement the IHostedService interface](https://learn.microsoft.com/dotnet/core/extensions/timer-service)
|
||||
* API documentation
|
||||
- [BackgroundService](https://learn.microsoft.com/dotnet/api/microsoft.extensions.hosting.backgroundservice)
|
||||
- [IHostBuilder](https://learn.microsoft.com/dotnet/api/microsoft.extensions.hosting.ihostbuilder)
|
||||
- [IHostedService](https://learn.microsoft.com/dotnet/api/microsoft.extensions.hosting.ihostedservice)
|
||||
|
||||
## Related Packages
|
||||
- `Microsoft.Extensions.Hosting`
|
||||
- `Microsoft.Extensions.Configuration.Abstractions`
|
||||
- `Microsoft.Extensions.DependencyInjection.Abstractions`
|
||||
- `Microsoft.Extensions.Diagnostics.Abstractions`
|
||||
- `Microsoft.Extensions.FileProviders.Abstractions`
|
||||
- `Microsoft.Extensions.Logging.Abstractions`
|
||||
|
||||
## Feedback & Contributing
|
||||
Microsoft.Extensions.Hosting.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
@@ -1,6 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Hosting_Abstractions_net462">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Hosting_Abstractions_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Hosting.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>
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Hosting_Abstractions_net462">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Hosting_Abstractions_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Hosting.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>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Hosting_Abstractions_net8_0">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Hosting_Abstractions_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Hosting.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>
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Hosting_Abstractions_net8_0">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Hosting_Abstractions_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Hosting.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
@@ -1,52 +1,52 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Logging.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>Logging abstractions for Microsoft.Extensions.Logging.
|
||||
|
||||
Commonly Used Types:
|
||||
Microsoft.Extensions.Logging.ILogger
|
||||
Microsoft.Extensions.Logging.ILoggerFactory
|
||||
Microsoft.Extensions.Logging.ILogger<TCategoryName>
|
||||
Microsoft.Extensions.Logging.LogLevel
|
||||
Microsoft.Extensions.Logging.Logger<T>
|
||||
Microsoft.Extensions.Logging.LoggerMessage
|
||||
Microsoft.Extensions.Logging.Abstractions.NullLogger</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="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="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="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" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" 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>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Logging.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>Logging abstractions for Microsoft.Extensions.Logging.
|
||||
|
||||
Commonly Used Types:
|
||||
Microsoft.Extensions.Logging.ILogger
|
||||
Microsoft.Extensions.Logging.ILoggerFactory
|
||||
Microsoft.Extensions.Logging.ILogger<TCategoryName>
|
||||
Microsoft.Extensions.Logging.LogLevel
|
||||
Microsoft.Extensions.Logging.Logger<T>
|
||||
Microsoft.Extensions.Logging.LoggerMessage
|
||||
Microsoft.Extensions.Logging.Abstractions.NullLogger</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="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="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="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" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" 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>
|
||||
@@ -1,164 +1,164 @@
|
||||
## About
|
||||
|
||||
<!-- A description of the package and where one can find more documentation -->
|
||||
|
||||
`Microsoft.Extensions.Logging.Abstractions` provides abstractions of logging. Interfaces defined in this package are implemented by classes in [Microsoft.Extensions.Logging](https://www.nuget.org/packages/Microsoft.Extensions.Logging/) and other logging packages.
|
||||
|
||||
This package includes a logging source generator that produces highly efficient and optimized code for logging message methods.
|
||||
|
||||
## Key Features
|
||||
|
||||
<!-- The key features of this package -->
|
||||
|
||||
* Define main logging abstraction interfaces like ILogger, ILoggerFactory, ILoggerProvider, etc.
|
||||
|
||||
## 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 -->
|
||||
|
||||
#### Custom logger provider implementation example
|
||||
|
||||
```C#
|
||||
using Microsoft.Extensions.Logging;
|
||||
|
||||
public sealed class ColorConsoleLogger : ILogger
|
||||
{
|
||||
private readonly string _name;
|
||||
private readonly Func<ColorConsoleLoggerConfiguration> _getCurrentConfig;
|
||||
|
||||
public ColorConsoleLogger(
|
||||
string name,
|
||||
Func<ColorConsoleLoggerConfiguration> getCurrentConfig) =>
|
||||
(_name, _getCurrentConfig) = (name, getCurrentConfig);
|
||||
|
||||
public IDisposable? BeginScope<TState>(TState state) where TState : notnull => default!;
|
||||
|
||||
public bool IsEnabled(LogLevel logLevel) =>
|
||||
_getCurrentConfig().LogLevelToColorMap.ContainsKey(logLevel);
|
||||
|
||||
public void Log<TState>(
|
||||
LogLevel logLevel,
|
||||
EventId eventId,
|
||||
TState state,
|
||||
Exception? exception,
|
||||
Func<TState, Exception?, string> formatter)
|
||||
{
|
||||
if (!IsEnabled(logLevel))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
ColorConsoleLoggerConfiguration config = _getCurrentConfig();
|
||||
if (config.EventId == 0 || config.EventId == eventId.Id)
|
||||
{
|
||||
ConsoleColor originalColor = Console.ForegroundColor;
|
||||
|
||||
Console.ForegroundColor = config.LogLevelToColorMap[logLevel];
|
||||
Console.WriteLine($"[{eventId.Id,2}: {logLevel,-12}]");
|
||||
|
||||
Console.ForegroundColor = originalColor;
|
||||
Console.Write($" {_name} - ");
|
||||
|
||||
Console.ForegroundColor = config.LogLevelToColorMap[logLevel];
|
||||
Console.Write($"{formatter(state, exception)}");
|
||||
|
||||
Console.ForegroundColor = originalColor;
|
||||
Console.WriteLine();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
#### Create logs
|
||||
|
||||
```csharp
|
||||
|
||||
// Worker class that uses logger implementation of teh interface ILogger<T>
|
||||
|
||||
public sealed class Worker : BackgroundService
|
||||
{
|
||||
private readonly ILogger<Worker> _logger;
|
||||
|
||||
public Worker(ILogger<Worker> logger) =>
|
||||
_logger = logger;
|
||||
|
||||
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
|
||||
{
|
||||
while (!stoppingToken.IsCancellationRequested)
|
||||
{
|
||||
_logger.LogInformation("Worker running at: {time}", DateTimeOffset.UtcNow);
|
||||
await Task.Delay(1_000, stoppingToken);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
#### Use source generator
|
||||
|
||||
```csharp
|
||||
public static partial class Log
|
||||
{
|
||||
[LoggerMessage(
|
||||
EventId = 0,
|
||||
Level = LogLevel.Critical,
|
||||
Message = "Could not open socket to `{hostName}`")]
|
||||
public static partial void CouldNotOpenSocket(this ILogger logger, string hostName);
|
||||
}
|
||||
|
||||
public partial class InstanceLoggingExample
|
||||
{
|
||||
private readonly ILogger _logger;
|
||||
|
||||
public InstanceLoggingExample(ILogger logger)
|
||||
{
|
||||
_logger = logger;
|
||||
}
|
||||
|
||||
[LoggerMessage(
|
||||
EventId = 0,
|
||||
Level = LogLevel.Critical,
|
||||
Message = "Could not open socket to `{hostName}`")]
|
||||
public partial void CouldNotOpenSocket(string hostName);
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## Main Types
|
||||
|
||||
<!-- The main types provided in this library -->
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `Microsoft.Extensions.Logging.ILogger`
|
||||
* `Microsoft.Extensions.Logging.ILoggerProvider`
|
||||
* `Microsoft.Extensions.Logging.ILoggerFactory`
|
||||
* `Microsoft.Extensions.Logging.ILogger<TCategoryName>`
|
||||
* `Microsoft.Extensions.Logging.LogLevel`
|
||||
* `Microsoft.Extensions.Logging.Logger<T>`
|
||||
* `Microsoft.Extensions.Logging.LoggerMessage`
|
||||
* `Microsoft.Extensions.Logging.Abstractions.NullLogger`
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
|
||||
|
||||
* [Conceptual documentation](https://learn.microsoft.com/dotnet/core/extensions/logging)
|
||||
* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging)
|
||||
|
||||
## Related Packages
|
||||
|
||||
<!-- The related packages associated with this package -->
|
||||
[Microsoft.Extensions.Logging](https://www.nuget.org/packages/Microsoft.Extensions.Logging)
|
||||
[Microsoft.Extensions.Logging.Console](https://www.nuget.org/packages/Microsoft.Extensions.Logging.Console)
|
||||
[Microsoft.Extensions.Logging.Debug](https://www.nuget.org/packages/Microsoft.Extensions.Logging.Debug)
|
||||
[Microsoft.Extensions.Logging.EventSource](https://www.nuget.org/packages/Microsoft.Extensions.Logging.EventSource)
|
||||
[Microsoft.Extensions.Logging.EventLog](https://www.nuget.org/packages/Microsoft.Extensions.Logging.EventLog)
|
||||
[Microsoft.Extensions.Logging.TraceSource](https://www.nuget.org/packages/Microsoft.Extensions.Logging.TraceSource)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
<!-- How to provide feedback on this package and contribute to it -->
|
||||
|
||||
## About
|
||||
|
||||
<!-- A description of the package and where one can find more documentation -->
|
||||
|
||||
`Microsoft.Extensions.Logging.Abstractions` provides abstractions of logging. Interfaces defined in this package are implemented by classes in [Microsoft.Extensions.Logging](https://www.nuget.org/packages/Microsoft.Extensions.Logging/) and other logging packages.
|
||||
|
||||
This package includes a logging source generator that produces highly efficient and optimized code for logging message methods.
|
||||
|
||||
## Key Features
|
||||
|
||||
<!-- The key features of this package -->
|
||||
|
||||
* Define main logging abstraction interfaces like ILogger, ILoggerFactory, ILoggerProvider, etc.
|
||||
|
||||
## 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 -->
|
||||
|
||||
#### Custom logger provider implementation example
|
||||
|
||||
```C#
|
||||
using Microsoft.Extensions.Logging;
|
||||
|
||||
public sealed class ColorConsoleLogger : ILogger
|
||||
{
|
||||
private readonly string _name;
|
||||
private readonly Func<ColorConsoleLoggerConfiguration> _getCurrentConfig;
|
||||
|
||||
public ColorConsoleLogger(
|
||||
string name,
|
||||
Func<ColorConsoleLoggerConfiguration> getCurrentConfig) =>
|
||||
(_name, _getCurrentConfig) = (name, getCurrentConfig);
|
||||
|
||||
public IDisposable? BeginScope<TState>(TState state) where TState : notnull => default!;
|
||||
|
||||
public bool IsEnabled(LogLevel logLevel) =>
|
||||
_getCurrentConfig().LogLevelToColorMap.ContainsKey(logLevel);
|
||||
|
||||
public void Log<TState>(
|
||||
LogLevel logLevel,
|
||||
EventId eventId,
|
||||
TState state,
|
||||
Exception? exception,
|
||||
Func<TState, Exception?, string> formatter)
|
||||
{
|
||||
if (!IsEnabled(logLevel))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
ColorConsoleLoggerConfiguration config = _getCurrentConfig();
|
||||
if (config.EventId == 0 || config.EventId == eventId.Id)
|
||||
{
|
||||
ConsoleColor originalColor = Console.ForegroundColor;
|
||||
|
||||
Console.ForegroundColor = config.LogLevelToColorMap[logLevel];
|
||||
Console.WriteLine($"[{eventId.Id,2}: {logLevel,-12}]");
|
||||
|
||||
Console.ForegroundColor = originalColor;
|
||||
Console.Write($" {_name} - ");
|
||||
|
||||
Console.ForegroundColor = config.LogLevelToColorMap[logLevel];
|
||||
Console.Write($"{formatter(state, exception)}");
|
||||
|
||||
Console.ForegroundColor = originalColor;
|
||||
Console.WriteLine();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
#### Create logs
|
||||
|
||||
```csharp
|
||||
|
||||
// Worker class that uses logger implementation of teh interface ILogger<T>
|
||||
|
||||
public sealed class Worker : BackgroundService
|
||||
{
|
||||
private readonly ILogger<Worker> _logger;
|
||||
|
||||
public Worker(ILogger<Worker> logger) =>
|
||||
_logger = logger;
|
||||
|
||||
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
|
||||
{
|
||||
while (!stoppingToken.IsCancellationRequested)
|
||||
{
|
||||
_logger.LogInformation("Worker running at: {time}", DateTimeOffset.UtcNow);
|
||||
await Task.Delay(1_000, stoppingToken);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
#### Use source generator
|
||||
|
||||
```csharp
|
||||
public static partial class Log
|
||||
{
|
||||
[LoggerMessage(
|
||||
EventId = 0,
|
||||
Level = LogLevel.Critical,
|
||||
Message = "Could not open socket to `{hostName}`")]
|
||||
public static partial void CouldNotOpenSocket(this ILogger logger, string hostName);
|
||||
}
|
||||
|
||||
public partial class InstanceLoggingExample
|
||||
{
|
||||
private readonly ILogger _logger;
|
||||
|
||||
public InstanceLoggingExample(ILogger logger)
|
||||
{
|
||||
_logger = logger;
|
||||
}
|
||||
|
||||
[LoggerMessage(
|
||||
EventId = 0,
|
||||
Level = LogLevel.Critical,
|
||||
Message = "Could not open socket to `{hostName}`")]
|
||||
public partial void CouldNotOpenSocket(string hostName);
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## Main Types
|
||||
|
||||
<!-- The main types provided in this library -->
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `Microsoft.Extensions.Logging.ILogger`
|
||||
* `Microsoft.Extensions.Logging.ILoggerProvider`
|
||||
* `Microsoft.Extensions.Logging.ILoggerFactory`
|
||||
* `Microsoft.Extensions.Logging.ILogger<TCategoryName>`
|
||||
* `Microsoft.Extensions.Logging.LogLevel`
|
||||
* `Microsoft.Extensions.Logging.Logger<T>`
|
||||
* `Microsoft.Extensions.Logging.LoggerMessage`
|
||||
* `Microsoft.Extensions.Logging.Abstractions.NullLogger`
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
|
||||
|
||||
* [Conceptual documentation](https://learn.microsoft.com/dotnet/core/extensions/logging)
|
||||
* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging)
|
||||
|
||||
## Related Packages
|
||||
|
||||
<!-- The related packages associated with this package -->
|
||||
[Microsoft.Extensions.Logging](https://www.nuget.org/packages/Microsoft.Extensions.Logging)
|
||||
[Microsoft.Extensions.Logging.Console](https://www.nuget.org/packages/Microsoft.Extensions.Logging.Console)
|
||||
[Microsoft.Extensions.Logging.Debug](https://www.nuget.org/packages/Microsoft.Extensions.Logging.Debug)
|
||||
[Microsoft.Extensions.Logging.EventSource](https://www.nuget.org/packages/Microsoft.Extensions.Logging.EventSource)
|
||||
[Microsoft.Extensions.Logging.EventLog](https://www.nuget.org/packages/Microsoft.Extensions.Logging.EventLog)
|
||||
[Microsoft.Extensions.Logging.TraceSource](https://www.nuget.org/packages/Microsoft.Extensions.Logging.TraceSource)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
<!-- How to provide feedback on this package and contribute to it -->
|
||||
|
||||
Microsoft.Extensions.Logging.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
@@ -1,6 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Logging_Abstractions_net462">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Logging_Abstractions_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Logging.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>
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Logging_Abstractions_net462">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Logging_Abstractions_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Logging.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>
|
||||
|
||||
@@ -1,31 +1,31 @@
|
||||
<Project>
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<_Microsoft_Extensions_Logging_AbstractionsAnalyzer Include="@(Analyzer)" Condition="'%(Analyzer.NuGetPackageId)' == 'Microsoft.Extensions.Logging.Abstractions'" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsAnalyzerMultiTargeting"
|
||||
Condition="'$(SupportsRoslynComponentVersioning)' != 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<!-- Remove our analyzers targeting roslyn4.x -->
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_Logging_AbstractionsAnalyzer)"
|
||||
Condition="$([System.String]::Copy('%(_Microsoft_Extensions_Logging_AbstractionsAnalyzer.Identity)').IndexOf('roslyn4')) >= 0"/>
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsRemoveAnalyzers"
|
||||
Condition="'$(DisableMicrosoftExtensionsLoggingSourceGenerator)' == 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<!-- Remove all our analyzers -->
|
||||
<ItemGroup>
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_Logging_AbstractionsAnalyzer)" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
</Project>
|
||||
<Project>
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<_Microsoft_Extensions_Logging_AbstractionsAnalyzer Include="@(Analyzer)" Condition="'%(Analyzer.NuGetPackageId)' == 'Microsoft.Extensions.Logging.Abstractions'" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsAnalyzerMultiTargeting"
|
||||
Condition="'$(SupportsRoslynComponentVersioning)' != 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<!-- Remove our analyzers targeting roslyn4.x -->
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_Logging_AbstractionsAnalyzer)"
|
||||
Condition="$([System.String]::Copy('%(_Microsoft_Extensions_Logging_AbstractionsAnalyzer.Identity)').IndexOf('roslyn4')) >= 0"/>
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsRemoveAnalyzers"
|
||||
Condition="'$(DisableMicrosoftExtensionsLoggingSourceGenerator)' == 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<!-- Remove all our analyzers -->
|
||||
<ItemGroup>
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_Logging_AbstractionsAnalyzer)" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
</Project>
|
||||
|
||||
@@ -1,31 +1,31 @@
|
||||
<Project>
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<_Microsoft_Extensions_Logging_AbstractionsAnalyzer Include="@(Analyzer)" Condition="'%(Analyzer.NuGetPackageId)' == 'Microsoft.Extensions.Logging.Abstractions'" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsAnalyzerMultiTargeting"
|
||||
Condition="'$(SupportsRoslynComponentVersioning)' != 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<!-- Remove our analyzers targeting roslyn4.x -->
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_Logging_AbstractionsAnalyzer)"
|
||||
Condition="$([System.String]::Copy('%(_Microsoft_Extensions_Logging_AbstractionsAnalyzer.Identity)').IndexOf('roslyn4')) >= 0"/>
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsRemoveAnalyzers"
|
||||
Condition="'$(DisableMicrosoftExtensionsLoggingSourceGenerator)' == 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<!-- Remove all our analyzers -->
|
||||
<ItemGroup>
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_Logging_AbstractionsAnalyzer)" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
</Project>
|
||||
<Project>
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<_Microsoft_Extensions_Logging_AbstractionsAnalyzer Include="@(Analyzer)" Condition="'%(Analyzer.NuGetPackageId)' == 'Microsoft.Extensions.Logging.Abstractions'" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsAnalyzerMultiTargeting"
|
||||
Condition="'$(SupportsRoslynComponentVersioning)' != 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<!-- Remove our analyzers targeting roslyn4.x -->
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_Logging_AbstractionsAnalyzer)"
|
||||
Condition="$([System.String]::Copy('%(_Microsoft_Extensions_Logging_AbstractionsAnalyzer.Identity)').IndexOf('roslyn4')) >= 0"/>
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsRemoveAnalyzers"
|
||||
Condition="'$(DisableMicrosoftExtensionsLoggingSourceGenerator)' == 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<!-- Remove all our analyzers -->
|
||||
<ItemGroup>
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_Logging_AbstractionsAnalyzer)" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
</Project>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Logging_Abstractions_net8_0">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Logging_Abstractions_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Logging.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>
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Logging_Abstractions_net8_0">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Logging_Abstractions_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Logging.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>
|
||||
|
||||
@@ -1,31 +1,31 @@
|
||||
<Project>
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<_Microsoft_Extensions_Logging_AbstractionsAnalyzer Include="@(Analyzer)" Condition="'%(Analyzer.NuGetPackageId)' == 'Microsoft.Extensions.Logging.Abstractions'" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsAnalyzerMultiTargeting"
|
||||
Condition="'$(SupportsRoslynComponentVersioning)' != 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<!-- Remove our analyzers targeting roslyn4.x -->
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_Logging_AbstractionsAnalyzer)"
|
||||
Condition="$([System.String]::Copy('%(_Microsoft_Extensions_Logging_AbstractionsAnalyzer.Identity)').IndexOf('roslyn4')) >= 0"/>
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsRemoveAnalyzers"
|
||||
Condition="'$(DisableMicrosoftExtensionsLoggingSourceGenerator)' == 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<!-- Remove all our analyzers -->
|
||||
<ItemGroup>
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_Logging_AbstractionsAnalyzer)" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
</Project>
|
||||
<Project>
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<_Microsoft_Extensions_Logging_AbstractionsAnalyzer Include="@(Analyzer)" Condition="'%(Analyzer.NuGetPackageId)' == 'Microsoft.Extensions.Logging.Abstractions'" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsAnalyzerMultiTargeting"
|
||||
Condition="'$(SupportsRoslynComponentVersioning)' != 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<!-- Remove our analyzers targeting roslyn4.x -->
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_Logging_AbstractionsAnalyzer)"
|
||||
Condition="$([System.String]::Copy('%(_Microsoft_Extensions_Logging_AbstractionsAnalyzer.Identity)').IndexOf('roslyn4')) >= 0"/>
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_Logging_AbstractionsRemoveAnalyzers"
|
||||
Condition="'$(DisableMicrosoftExtensionsLoggingSourceGenerator)' == 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_Logging_AbstractionsGatherAnalyzers">
|
||||
|
||||
<!-- Remove all our analyzers -->
|
||||
<ItemGroup>
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_Logging_AbstractionsAnalyzer)" />
|
||||
</ItemGroup>
|
||||
</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
@@ -1,29 +1,29 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Logging.Abstractions</id>
|
||||
<version>2.0.0</version>
|
||||
<authors>Microsoft</authors>
|
||||
<owners>Microsoft</owners>
|
||||
<requireLicenseAcceptance>true</requireLicenseAcceptance>
|
||||
<licenseUrl>https://raw.githubusercontent.com/aspnet/Home/2.0.0/LICENSE.txt</licenseUrl>
|
||||
<projectUrl>https://asp.net/</projectUrl>
|
||||
<iconUrl>https://go.microsoft.com/fwlink/?LinkID=288859</iconUrl>
|
||||
<description>Logging abstractions for Microsoft.Extensions.Logging.
|
||||
Commonly used types:
|
||||
Microsoft.Extensions.Logging.ILogger
|
||||
Microsoft.Extensions.Logging.ILoggerFactory
|
||||
Microsoft.Extensions.Logging.ILogger<TCategoryName>
|
||||
Microsoft.Extensions.Logging.LogLevel
|
||||
Microsoft.Extensions.Logging.Logger<T>
|
||||
Microsoft.Extensions.Logging.LoggerMessage
|
||||
Microsoft.Extensions.Logging.Abstractions.NullLogger</description>
|
||||
<copyright>Copyright © Microsoft Corporation</copyright>
|
||||
<tags>logging</tags>
|
||||
<serviceable>true</serviceable>
|
||||
<repository type="git" url="https://github.com/aspnet/Logging" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETStandard2.0" />
|
||||
</dependencies>
|
||||
</metadata>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Logging.Abstractions</id>
|
||||
<version>2.0.0</version>
|
||||
<authors>Microsoft</authors>
|
||||
<owners>Microsoft</owners>
|
||||
<requireLicenseAcceptance>true</requireLicenseAcceptance>
|
||||
<licenseUrl>https://raw.githubusercontent.com/aspnet/Home/2.0.0/LICENSE.txt</licenseUrl>
|
||||
<projectUrl>https://asp.net/</projectUrl>
|
||||
<iconUrl>https://go.microsoft.com/fwlink/?LinkID=288859</iconUrl>
|
||||
<description>Logging abstractions for Microsoft.Extensions.Logging.
|
||||
Commonly used types:
|
||||
Microsoft.Extensions.Logging.ILogger
|
||||
Microsoft.Extensions.Logging.ILoggerFactory
|
||||
Microsoft.Extensions.Logging.ILogger<TCategoryName>
|
||||
Microsoft.Extensions.Logging.LogLevel
|
||||
Microsoft.Extensions.Logging.Logger<T>
|
||||
Microsoft.Extensions.Logging.LoggerMessage
|
||||
Microsoft.Extensions.Logging.Abstractions.NullLogger</description>
|
||||
<copyright>Copyright © Microsoft Corporation</copyright>
|
||||
<tags>logging</tags>
|
||||
<serviceable>true</serviceable>
|
||||
<repository type="git" url="https://github.com/aspnet/Logging" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETStandard2.0" />
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,50 +1,50 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Options</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 a strongly typed way of specifying and accessing settings using dependency injection.</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.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.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<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.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<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.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<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.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="System.ComponentModel.Annotations" version="5.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.1">
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="System.ComponentModel.Annotations" version="5.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
<frameworkAssemblies>
|
||||
<frameworkAssembly assemblyName="System.ComponentModel.DataAnnotations" targetFramework=".NETFramework4.6.2" />
|
||||
</frameworkAssemblies>
|
||||
</metadata>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Options</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 a strongly typed way of specifying and accessing settings using dependency injection.</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.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.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<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.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<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.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<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.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="System.ComponentModel.Annotations" version="5.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.1">
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="System.ComponentModel.Annotations" version="5.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
<frameworkAssemblies>
|
||||
<frameworkAssembly assemblyName="System.ComponentModel.DataAnnotations" targetFramework=".NETFramework4.6.2" />
|
||||
</frameworkAssemblies>
|
||||
</metadata>
|
||||
</package>
|
||||
@@ -1,170 +1,170 @@
|
||||
## About
|
||||
`Microsoft.Extensions.Options` provides a strongly typed way of specifying and accessing settings using dependency injection and acts as a bridge between configuration, DI, and higher level libraries. This library is the glue for how an app developer uses DI to configure the behavior of a library like HttpClient Factory. This also enables user to get a strongly-typed view of their configuration.
|
||||
|
||||
Within this package, you'll find an options validation source generator that generates exceptionally efficient and optimized code for validating options.
|
||||
|
||||
## Key Features
|
||||
|
||||
* Offer the IValidateOptions interface for the validation of options, along with several generic ValidateOptions classes that implement this interface.
|
||||
* OptionsBuilder to configure options.
|
||||
* Provide extension methods for service collections and options builder to register options and validate options.
|
||||
* Supply a set of generic ConfigureNamedOptions classes that implement the IConfigureNamedOptions interface for configuring named options.
|
||||
* Provide a source generator that generates validation code for options.
|
||||
* Options caching, managing and monitoring.
|
||||
|
||||
## How to Use
|
||||
|
||||
#### Options validation example
|
||||
|
||||
```C#
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Options;
|
||||
|
||||
var builder = WebApplication.CreateBuilder(args);
|
||||
|
||||
builder.Services.AddControllersWithViews();
|
||||
|
||||
// Load the configuration and validate it
|
||||
builder.Services.AddOptions<MyConfigOptions>()
|
||||
.Bind(builder.Configuration.GetSection(MyConfigOptions.MyConfig))
|
||||
.ValidateDataAnnotations();
|
||||
var app = builder.Build();
|
||||
|
||||
|
||||
// Declare the option class to validate
|
||||
public class MyConfigOptions
|
||||
{
|
||||
public const string MyConfig = "MyConfig";
|
||||
|
||||
[RegularExpression(@"^[a-zA-Z''-'\s]{1,40}$")]
|
||||
public string Key1 { get; set; }
|
||||
[Range(0, 1000,
|
||||
ErrorMessage = "Value for {0} must be between {1} and {2}.")]
|
||||
public int Key2 { get; set; }
|
||||
public int Key3 { get; set; }
|
||||
}
|
||||
```
|
||||
|
||||
#### Using IValidateOptions to validate options
|
||||
|
||||
```C#
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Options;
|
||||
|
||||
var builder = WebApplication.CreateBuilder(args);
|
||||
|
||||
builder.Services.AddControllersWithViews();
|
||||
|
||||
// Configuration to validate
|
||||
builder.Services.Configure<MyConfigOptions>(builder.Configuration.GetSection(
|
||||
MyConfigOptions.MyConfig));
|
||||
|
||||
// OPtions validation through the DI container
|
||||
builder.Services.AddSingleton<IValidateOptions
|
||||
<MyConfigOptions>, MyConfigValidation>();
|
||||
|
||||
var app = builder.Build();
|
||||
|
||||
public class MyConfigValidation : IValidateOptions<MyConfigOptions>
|
||||
{
|
||||
public MyConfigOptions _config { get; private set; }
|
||||
|
||||
public MyConfigValidation(IConfiguration config)
|
||||
{
|
||||
_config = config.GetSection(MyConfigOptions.MyConfig)
|
||||
.Get<MyConfigOptions>();
|
||||
}
|
||||
|
||||
public ValidateOptionsResult Validate(string name, MyConfigOptions options)
|
||||
{
|
||||
string? vor = null;
|
||||
var rx = new Regex(@"^[a-zA-Z''-'\s]{1,40}$");
|
||||
var match = rx.Match(options.Key1!);
|
||||
|
||||
if (string.IsNullOrEmpty(match.Value))
|
||||
{
|
||||
vor = $"{options.Key1} doesn't match RegEx \n";
|
||||
}
|
||||
|
||||
if ( options.Key2 < 0 || options.Key2 > 1000)
|
||||
{
|
||||
vor = $"{options.Key2} doesn't match Range 0 - 1000 \n";
|
||||
}
|
||||
|
||||
if (_config.Key2 != default)
|
||||
{
|
||||
if(_config.Key3 <= _config.Key2)
|
||||
{
|
||||
vor += "Key3 must be > than Key2.";
|
||||
}
|
||||
}
|
||||
|
||||
if (vor != null)
|
||||
{
|
||||
return ValidateOptionsResult.Fail(vor);
|
||||
}
|
||||
|
||||
return ValidateOptionsResult.Success;
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
#### Options Validation Source Generator Example
|
||||
|
||||
```C#
|
||||
using System;
|
||||
using System.ComponentModel.DataAnnotations;
|
||||
using Microsoft.Extensions.Options;
|
||||
|
||||
public class MyConfigOptions
|
||||
{
|
||||
[RegularExpression(@"^[a-zA-Z''-'\s]{1,40}$")]
|
||||
public string Key1 { get; set; }
|
||||
|
||||
[Range(0, 1000,
|
||||
ErrorMessage = "Value for {0} must be between {1} and {2}.")]
|
||||
public int Key2 { get; set; }
|
||||
public int Key3 { get; set; }
|
||||
}
|
||||
|
||||
[OptionsValidator]
|
||||
public partial class MyConfigValidation : IValidateOptions<MyConfigOptions>
|
||||
{
|
||||
// Source generator will automatically provide the implementation of IValidateOptions
|
||||
// Then you can add the validation to the DI Container using the following code:
|
||||
//
|
||||
// builder.Services.AddSingleton<IValidateOptions
|
||||
// <MyConfigOptions>, MyConfigValidation>();
|
||||
// builder.Services.AddOptions<MyConfigOptions>()
|
||||
// .Bind(builder.Configuration.GetSection(MyConfigOptions.MyConfig))
|
||||
// .ValidateDataAnnotations();
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## Main Types
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `IOptions`, `IOptionsFactory`, and `IOptionsMonitor`
|
||||
* `IValidateOptions` and `ValidateOptions`
|
||||
* `OptionsBuilder`, `OptionsFactory`, `OptionsMonitor`, and `OptionsManager`
|
||||
* `OptionsServiceCollectionExtensions`
|
||||
* `OptionsValidatorAttribute`
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
* [Conceptual documentation](https://learn.microsoft.com/aspnet/core/fundamentals/configuration/options)
|
||||
* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.options)
|
||||
|
||||
## Related Packages
|
||||
|
||||
[Microsoft.Extensions.Logging](https://www.nuget.org/packages/Microsoft.Extensions.Logging)
|
||||
[Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
## About
|
||||
`Microsoft.Extensions.Options` provides a strongly typed way of specifying and accessing settings using dependency injection and acts as a bridge between configuration, DI, and higher level libraries. This library is the glue for how an app developer uses DI to configure the behavior of a library like HttpClient Factory. This also enables user to get a strongly-typed view of their configuration.
|
||||
|
||||
Within this package, you'll find an options validation source generator that generates exceptionally efficient and optimized code for validating options.
|
||||
|
||||
## Key Features
|
||||
|
||||
* Offer the IValidateOptions interface for the validation of options, along with several generic ValidateOptions classes that implement this interface.
|
||||
* OptionsBuilder to configure options.
|
||||
* Provide extension methods for service collections and options builder to register options and validate options.
|
||||
* Supply a set of generic ConfigureNamedOptions classes that implement the IConfigureNamedOptions interface for configuring named options.
|
||||
* Provide a source generator that generates validation code for options.
|
||||
* Options caching, managing and monitoring.
|
||||
|
||||
## How to Use
|
||||
|
||||
#### Options validation example
|
||||
|
||||
```C#
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Options;
|
||||
|
||||
var builder = WebApplication.CreateBuilder(args);
|
||||
|
||||
builder.Services.AddControllersWithViews();
|
||||
|
||||
// Load the configuration and validate it
|
||||
builder.Services.AddOptions<MyConfigOptions>()
|
||||
.Bind(builder.Configuration.GetSection(MyConfigOptions.MyConfig))
|
||||
.ValidateDataAnnotations();
|
||||
var app = builder.Build();
|
||||
|
||||
|
||||
// Declare the option class to validate
|
||||
public class MyConfigOptions
|
||||
{
|
||||
public const string MyConfig = "MyConfig";
|
||||
|
||||
[RegularExpression(@"^[a-zA-Z''-'\s]{1,40}$")]
|
||||
public string Key1 { get; set; }
|
||||
[Range(0, 1000,
|
||||
ErrorMessage = "Value for {0} must be between {1} and {2}.")]
|
||||
public int Key2 { get; set; }
|
||||
public int Key3 { get; set; }
|
||||
}
|
||||
```
|
||||
|
||||
#### Using IValidateOptions to validate options
|
||||
|
||||
```C#
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Options;
|
||||
|
||||
var builder = WebApplication.CreateBuilder(args);
|
||||
|
||||
builder.Services.AddControllersWithViews();
|
||||
|
||||
// Configuration to validate
|
||||
builder.Services.Configure<MyConfigOptions>(builder.Configuration.GetSection(
|
||||
MyConfigOptions.MyConfig));
|
||||
|
||||
// OPtions validation through the DI container
|
||||
builder.Services.AddSingleton<IValidateOptions
|
||||
<MyConfigOptions>, MyConfigValidation>();
|
||||
|
||||
var app = builder.Build();
|
||||
|
||||
public class MyConfigValidation : IValidateOptions<MyConfigOptions>
|
||||
{
|
||||
public MyConfigOptions _config { get; private set; }
|
||||
|
||||
public MyConfigValidation(IConfiguration config)
|
||||
{
|
||||
_config = config.GetSection(MyConfigOptions.MyConfig)
|
||||
.Get<MyConfigOptions>();
|
||||
}
|
||||
|
||||
public ValidateOptionsResult Validate(string name, MyConfigOptions options)
|
||||
{
|
||||
string? vor = null;
|
||||
var rx = new Regex(@"^[a-zA-Z''-'\s]{1,40}$");
|
||||
var match = rx.Match(options.Key1!);
|
||||
|
||||
if (string.IsNullOrEmpty(match.Value))
|
||||
{
|
||||
vor = $"{options.Key1} doesn't match RegEx \n";
|
||||
}
|
||||
|
||||
if ( options.Key2 < 0 || options.Key2 > 1000)
|
||||
{
|
||||
vor = $"{options.Key2} doesn't match Range 0 - 1000 \n";
|
||||
}
|
||||
|
||||
if (_config.Key2 != default)
|
||||
{
|
||||
if(_config.Key3 <= _config.Key2)
|
||||
{
|
||||
vor += "Key3 must be > than Key2.";
|
||||
}
|
||||
}
|
||||
|
||||
if (vor != null)
|
||||
{
|
||||
return ValidateOptionsResult.Fail(vor);
|
||||
}
|
||||
|
||||
return ValidateOptionsResult.Success;
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
#### Options Validation Source Generator Example
|
||||
|
||||
```C#
|
||||
using System;
|
||||
using System.ComponentModel.DataAnnotations;
|
||||
using Microsoft.Extensions.Options;
|
||||
|
||||
public class MyConfigOptions
|
||||
{
|
||||
[RegularExpression(@"^[a-zA-Z''-'\s]{1,40}$")]
|
||||
public string Key1 { get; set; }
|
||||
|
||||
[Range(0, 1000,
|
||||
ErrorMessage = "Value for {0} must be between {1} and {2}.")]
|
||||
public int Key2 { get; set; }
|
||||
public int Key3 { get; set; }
|
||||
}
|
||||
|
||||
[OptionsValidator]
|
||||
public partial class MyConfigValidation : IValidateOptions<MyConfigOptions>
|
||||
{
|
||||
// Source generator will automatically provide the implementation of IValidateOptions
|
||||
// Then you can add the validation to the DI Container using the following code:
|
||||
//
|
||||
// builder.Services.AddSingleton<IValidateOptions
|
||||
// <MyConfigOptions>, MyConfigValidation>();
|
||||
// builder.Services.AddOptions<MyConfigOptions>()
|
||||
// .Bind(builder.Configuration.GetSection(MyConfigOptions.MyConfig))
|
||||
// .ValidateDataAnnotations();
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## Main Types
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `IOptions`, `IOptionsFactory`, and `IOptionsMonitor`
|
||||
* `IValidateOptions` and `ValidateOptions`
|
||||
* `OptionsBuilder`, `OptionsFactory`, `OptionsMonitor`, and `OptionsManager`
|
||||
* `OptionsServiceCollectionExtensions`
|
||||
* `OptionsValidatorAttribute`
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
* [Conceptual documentation](https://learn.microsoft.com/aspnet/core/fundamentals/configuration/options)
|
||||
* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.options)
|
||||
|
||||
## Related Packages
|
||||
|
||||
[Microsoft.Extensions.Logging](https://www.nuget.org/packages/Microsoft.Extensions.Logging)
|
||||
[Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
Microsoft.Extensions.Options 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
@@ -1,6 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Options_net462">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Options_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Options 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>
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Options_net462">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Options_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Options 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>
|
||||
|
||||
@@ -1,31 +1,31 @@
|
||||
<Project>
|
||||
<Target Name="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<_Microsoft_Extensions_OptionsAnalyzer Include="@(Analyzer)" Condition="'%(Analyzer.NuGetPackageId)' == 'Microsoft.Extensions.Options'" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_OptionsAnalyzerMultiTargeting"
|
||||
Condition="'$(SupportsRoslynComponentVersioning)' != 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<!-- Remove our analyzers targeting roslyn4.x -->
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_OptionsAnalyzer)"
|
||||
Condition="$([System.String]::Copy('%(_Microsoft_Extensions_OptionsAnalyzer.Identity)').IndexOf('roslyn4')) >= 0"/>
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_OptionsRemoveAnalyzers"
|
||||
Condition="'$(DisableMicrosoftExtensionsOptionsSourceGenerator)' == 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<!-- Remove all our analyzers -->
|
||||
<ItemGroup>
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_OptionsAnalyzer)" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
</Project>
|
||||
<Project>
|
||||
<Target Name="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<_Microsoft_Extensions_OptionsAnalyzer Include="@(Analyzer)" Condition="'%(Analyzer.NuGetPackageId)' == 'Microsoft.Extensions.Options'" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_OptionsAnalyzerMultiTargeting"
|
||||
Condition="'$(SupportsRoslynComponentVersioning)' != 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<!-- Remove our analyzers targeting roslyn4.x -->
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_OptionsAnalyzer)"
|
||||
Condition="$([System.String]::Copy('%(_Microsoft_Extensions_OptionsAnalyzer.Identity)').IndexOf('roslyn4')) >= 0"/>
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_OptionsRemoveAnalyzers"
|
||||
Condition="'$(DisableMicrosoftExtensionsOptionsSourceGenerator)' == 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<!-- Remove all our analyzers -->
|
||||
<ItemGroup>
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_OptionsAnalyzer)" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
</Project>
|
||||
|
||||
@@ -1,31 +1,31 @@
|
||||
<Project>
|
||||
<Target Name="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<_Microsoft_Extensions_OptionsAnalyzer Include="@(Analyzer)" Condition="'%(Analyzer.NuGetPackageId)' == 'Microsoft.Extensions.Options'" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_OptionsAnalyzerMultiTargeting"
|
||||
Condition="'$(SupportsRoslynComponentVersioning)' != 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<!-- Remove our analyzers targeting roslyn4.x -->
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_OptionsAnalyzer)"
|
||||
Condition="$([System.String]::Copy('%(_Microsoft_Extensions_OptionsAnalyzer.Identity)').IndexOf('roslyn4')) >= 0"/>
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_OptionsRemoveAnalyzers"
|
||||
Condition="'$(DisableMicrosoftExtensionsOptionsSourceGenerator)' == 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<!-- Remove all our analyzers -->
|
||||
<ItemGroup>
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_OptionsAnalyzer)" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
</Project>
|
||||
<Project>
|
||||
<Target Name="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<_Microsoft_Extensions_OptionsAnalyzer Include="@(Analyzer)" Condition="'%(Analyzer.NuGetPackageId)' == 'Microsoft.Extensions.Options'" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_OptionsAnalyzerMultiTargeting"
|
||||
Condition="'$(SupportsRoslynComponentVersioning)' != 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<!-- Remove our analyzers targeting roslyn4.x -->
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_OptionsAnalyzer)"
|
||||
Condition="$([System.String]::Copy('%(_Microsoft_Extensions_OptionsAnalyzer.Identity)').IndexOf('roslyn4')) >= 0"/>
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_OptionsRemoveAnalyzers"
|
||||
Condition="'$(DisableMicrosoftExtensionsOptionsSourceGenerator)' == 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<!-- Remove all our analyzers -->
|
||||
<ItemGroup>
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_OptionsAnalyzer)" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
</Project>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Options_net8_0">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Options_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Options 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>
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Options_net8_0">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Options_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Options 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>
|
||||
|
||||
@@ -1,31 +1,31 @@
|
||||
<Project>
|
||||
<Target Name="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<_Microsoft_Extensions_OptionsAnalyzer Include="@(Analyzer)" Condition="'%(Analyzer.NuGetPackageId)' == 'Microsoft.Extensions.Options'" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_OptionsAnalyzerMultiTargeting"
|
||||
Condition="'$(SupportsRoslynComponentVersioning)' != 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<!-- Remove our analyzers targeting roslyn4.x -->
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_OptionsAnalyzer)"
|
||||
Condition="$([System.String]::Copy('%(_Microsoft_Extensions_OptionsAnalyzer.Identity)').IndexOf('roslyn4')) >= 0"/>
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_OptionsRemoveAnalyzers"
|
||||
Condition="'$(DisableMicrosoftExtensionsOptionsSourceGenerator)' == 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<!-- Remove all our analyzers -->
|
||||
<ItemGroup>
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_OptionsAnalyzer)" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
</Project>
|
||||
<Project>
|
||||
<Target Name="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<_Microsoft_Extensions_OptionsAnalyzer Include="@(Analyzer)" Condition="'%(Analyzer.NuGetPackageId)' == 'Microsoft.Extensions.Options'" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_OptionsAnalyzerMultiTargeting"
|
||||
Condition="'$(SupportsRoslynComponentVersioning)' != 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<ItemGroup>
|
||||
<!-- Remove our analyzers targeting roslyn4.x -->
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_OptionsAnalyzer)"
|
||||
Condition="$([System.String]::Copy('%(_Microsoft_Extensions_OptionsAnalyzer.Identity)').IndexOf('roslyn4')) >= 0"/>
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_OptionsRemoveAnalyzers"
|
||||
Condition="'$(DisableMicrosoftExtensionsOptionsSourceGenerator)' == 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
|
||||
DependsOnTargets="_Microsoft_Extensions_OptionsGatherAnalyzers">
|
||||
|
||||
<!-- Remove all our analyzers -->
|
||||
<ItemGroup>
|
||||
<Analyzer Remove="@(_Microsoft_Extensions_OptionsAnalyzer)" />
|
||||
</ItemGroup>
|
||||
</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
@@ -1,36 +1,36 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Primitives</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>Primitives shared by framework extensions. Commonly used types include:
|
||||
|
||||
Commonly Used Types:
|
||||
Microsoft.Extensions.Primitives.IChangeToken
|
||||
Microsoft.Extensions.Primitives.StringValues
|
||||
Microsoft.Extensions.Primitives.StringSegment</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="System.Memory" version="4.6.3" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Runtime.CompilerServices.Unsafe" version="6.1.2" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net8.0" />
|
||||
<group targetFramework="net9.0" />
|
||||
<group targetFramework="net10.0" />
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="System.Memory" version="4.6.3" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Runtime.CompilerServices.Unsafe" version="6.1.2" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Primitives</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>Primitives shared by framework extensions. Commonly used types include:
|
||||
|
||||
Commonly Used Types:
|
||||
Microsoft.Extensions.Primitives.IChangeToken
|
||||
Microsoft.Extensions.Primitives.StringValues
|
||||
Microsoft.Extensions.Primitives.StringSegment</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="System.Memory" version="4.6.3" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Runtime.CompilerServices.Unsafe" version="6.1.2" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net8.0" />
|
||||
<group targetFramework="net9.0" />
|
||||
<group targetFramework="net10.0" />
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="System.Memory" version="4.6.3" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Runtime.CompilerServices.Unsafe" version="6.1.2" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
@@ -1,109 +1,109 @@
|
||||
## About
|
||||
|
||||
`Microsoft.Extensions.Primitives` contains isolated types that are used in many places within console or ASP.NET Core applications using framework extensions.
|
||||
|
||||
## Key Features
|
||||
|
||||
* IChangeToken: An interface that represents a token that can notify when a change occurs. This can be used to trigger actions or invalidate caches when something changes. For example, the configuration and file providers libraries use this interface to reload settings or files when they are modified.
|
||||
* StringValues: A struct that represents a single string or an array of strings. This can be used to efficiently store and manipulate multiple values that are logically a single value. For example, the HTTP headers and query strings libraries use this struct to handle multiple values for the same key.
|
||||
* StringSegment: A struct that represents a substring of another string. This can be used to avoid allocating new strings when performing operations on parts of a string. For example, the configuration and logging libraries use this struct to parse and format strings.
|
||||
|
||||
## How to Use
|
||||
|
||||
#### IChangeToken with configuration example
|
||||
|
||||
```C#
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using Microsoft.Extensions.Primitives;
|
||||
using System;
|
||||
|
||||
class Program
|
||||
{
|
||||
static void Main(string[] args)
|
||||
{
|
||||
// Create a configuration builder
|
||||
var configurationBuilder = new ConfigurationBuilder()
|
||||
.SetBasePath(Environment.CurrentDirectory)
|
||||
// appsettings.json expected to have the following contents:
|
||||
// {
|
||||
// "SomeKey": "SomeValue"
|
||||
// }
|
||||
.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);
|
||||
|
||||
// Build the configuration
|
||||
IConfiguration configuration = configurationBuilder.Build();
|
||||
|
||||
// Create a change token for the configuration
|
||||
IChangeToken changeToken = configuration.GetReloadToken();
|
||||
|
||||
// Attach a change callback
|
||||
IDisposable changeTokenRegistration = changeToken.RegisterChangeCallback(state =>
|
||||
{
|
||||
Console.WriteLine("Configuration changed!");
|
||||
IConfigurationRoot root = (IConfigurationRoot)state;
|
||||
var someValue = root["SomeKey"]; // Access the updated configuration value
|
||||
Console.WriteLine($"New value of SomeKey: {someValue}");
|
||||
}, configuration);
|
||||
|
||||
// go and update the value of the key SomeKey in appsettings.json.
|
||||
// The change callback will be invoked when the file is saved.
|
||||
Console.WriteLine("Listening for configuration changes. Press any key to exit.");
|
||||
Console.ReadKey();
|
||||
|
||||
// Clean up the change token registration when no longer needed
|
||||
changeTokenRegistration.Dispose();
|
||||
}
|
||||
}
|
||||
```
|
||||
#### StringValues example
|
||||
|
||||
```C#
|
||||
using System;
|
||||
using Microsoft.Extensions.Primitives;
|
||||
|
||||
namespace StringValuesSample
|
||||
{
|
||||
class Program
|
||||
{
|
||||
static void Main(string[] args)
|
||||
{
|
||||
// Create a StringValues object from a single string or an array of strings
|
||||
StringValues single = "Hello";
|
||||
StringValues multiple = new string[] { "Hello", "World" };
|
||||
|
||||
// Use the implicit conversion to string or the ToString method to get the values
|
||||
Console.WriteLine($"Single: {single}"); // Single: Hello
|
||||
Console.WriteLine($"Multiple: {multiple}"); // Multiple: Hello,World
|
||||
|
||||
// Use the indexer, the Count property, and the IsNullOrEmpty method to access the values
|
||||
Console.WriteLine($"Multiple[1]: {multiple[1]}"); // Multiple[1]: World
|
||||
Console.WriteLine($"Single.Count: {single.Count}"); // Single.Count: 1
|
||||
Console.WriteLine($"Multiple.IsNullOrEmpty: {StringValues.IsNullOrEmpty(multiple)}"); // Multiple.IsNullOrEmpty: False
|
||||
|
||||
// Use the Equals method or the == operator to compare two StringValues objects
|
||||
Console.WriteLine($"single == \"Hello\": {single == "Hello"}"); // single == "Hello": True
|
||||
Console.WriteLine($"multiple == \"Hello\": {multiple == "Hello"}"); // multiple == "Hello": False
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
## Main Types
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `IChangeToken`
|
||||
* `StringValues`
|
||||
* `StringSegment`
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
* [Conceptual documentation](https://learn.microsoft.com/dotnet/core/extensions/primitives)
|
||||
* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.primitives)
|
||||
|
||||
## Related Packages
|
||||
|
||||
* [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
## About
|
||||
|
||||
`Microsoft.Extensions.Primitives` contains isolated types that are used in many places within console or ASP.NET Core applications using framework extensions.
|
||||
|
||||
## Key Features
|
||||
|
||||
* IChangeToken: An interface that represents a token that can notify when a change occurs. This can be used to trigger actions or invalidate caches when something changes. For example, the configuration and file providers libraries use this interface to reload settings or files when they are modified.
|
||||
* StringValues: A struct that represents a single string or an array of strings. This can be used to efficiently store and manipulate multiple values that are logically a single value. For example, the HTTP headers and query strings libraries use this struct to handle multiple values for the same key.
|
||||
* StringSegment: A struct that represents a substring of another string. This can be used to avoid allocating new strings when performing operations on parts of a string. For example, the configuration and logging libraries use this struct to parse and format strings.
|
||||
|
||||
## How to Use
|
||||
|
||||
#### IChangeToken with configuration example
|
||||
|
||||
```C#
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using Microsoft.Extensions.Primitives;
|
||||
using System;
|
||||
|
||||
class Program
|
||||
{
|
||||
static void Main(string[] args)
|
||||
{
|
||||
// Create a configuration builder
|
||||
var configurationBuilder = new ConfigurationBuilder()
|
||||
.SetBasePath(Environment.CurrentDirectory)
|
||||
// appsettings.json expected to have the following contents:
|
||||
// {
|
||||
// "SomeKey": "SomeValue"
|
||||
// }
|
||||
.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);
|
||||
|
||||
// Build the configuration
|
||||
IConfiguration configuration = configurationBuilder.Build();
|
||||
|
||||
// Create a change token for the configuration
|
||||
IChangeToken changeToken = configuration.GetReloadToken();
|
||||
|
||||
// Attach a change callback
|
||||
IDisposable changeTokenRegistration = changeToken.RegisterChangeCallback(state =>
|
||||
{
|
||||
Console.WriteLine("Configuration changed!");
|
||||
IConfigurationRoot root = (IConfigurationRoot)state;
|
||||
var someValue = root["SomeKey"]; // Access the updated configuration value
|
||||
Console.WriteLine($"New value of SomeKey: {someValue}");
|
||||
}, configuration);
|
||||
|
||||
// go and update the value of the key SomeKey in appsettings.json.
|
||||
// The change callback will be invoked when the file is saved.
|
||||
Console.WriteLine("Listening for configuration changes. Press any key to exit.");
|
||||
Console.ReadKey();
|
||||
|
||||
// Clean up the change token registration when no longer needed
|
||||
changeTokenRegistration.Dispose();
|
||||
}
|
||||
}
|
||||
```
|
||||
#### StringValues example
|
||||
|
||||
```C#
|
||||
using System;
|
||||
using Microsoft.Extensions.Primitives;
|
||||
|
||||
namespace StringValuesSample
|
||||
{
|
||||
class Program
|
||||
{
|
||||
static void Main(string[] args)
|
||||
{
|
||||
// Create a StringValues object from a single string or an array of strings
|
||||
StringValues single = "Hello";
|
||||
StringValues multiple = new string[] { "Hello", "World" };
|
||||
|
||||
// Use the implicit conversion to string or the ToString method to get the values
|
||||
Console.WriteLine($"Single: {single}"); // Single: Hello
|
||||
Console.WriteLine($"Multiple: {multiple}"); // Multiple: Hello,World
|
||||
|
||||
// Use the indexer, the Count property, and the IsNullOrEmpty method to access the values
|
||||
Console.WriteLine($"Multiple[1]: {multiple[1]}"); // Multiple[1]: World
|
||||
Console.WriteLine($"Single.Count: {single.Count}"); // Single.Count: 1
|
||||
Console.WriteLine($"Multiple.IsNullOrEmpty: {StringValues.IsNullOrEmpty(multiple)}"); // Multiple.IsNullOrEmpty: False
|
||||
|
||||
// Use the Equals method or the == operator to compare two StringValues objects
|
||||
Console.WriteLine($"single == \"Hello\": {single == "Hello"}"); // single == "Hello": True
|
||||
Console.WriteLine($"multiple == \"Hello\": {multiple == "Hello"}"); // multiple == "Hello": False
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
## Main Types
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `IChangeToken`
|
||||
* `StringValues`
|
||||
* `StringSegment`
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
* [Conceptual documentation](https://learn.microsoft.com/dotnet/core/extensions/primitives)
|
||||
* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.primitives)
|
||||
|
||||
## Related Packages
|
||||
|
||||
* [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
Microsoft.Extensions.Primitives 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
@@ -1,6 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Primitives_net462">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Primitives_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Primitives 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>
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Primitives_net462">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Primitives_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Primitives 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>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Primitives_net8_0">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Primitives_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Primitives 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>
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Primitives_net8_0">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Primitives_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Primitives 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
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user