nuget updates
This commit is contained in:
StellaOps Bot
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "/2TgjyEl8rEfmDiFsdeRmy12hgls+06hOS9+TCHyvbJbQl9H/62fisWaPURV0b+sLBQ7XU60dnJ8/+zavxTy0Q==",
|
||||
"source": "/mnt/e/dev/git.stella-ops.org/local-nugets"
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@@ -0,0 +1,26 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.AspNetCore.Authentication.JwtBearer</id>
|
||||
<version>10.0.0-rc.1.25451.107</version>
|
||||
<authors>Microsoft</authors>
|
||||
<requireLicenseAcceptance>true</requireLicenseAcceptance>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>Icon.png</icon>
|
||||
<readme>PACKAGE.md</readme>
|
||||
<projectUrl>https://asp.net/</projectUrl>
|
||||
<description>ASP.NET Core middleware that enables an application to receive an OpenID Connect bearer token.
|
||||
|
||||
This package was built from the source code at https://github.com/dotnet/dotnet/tree/2db1f5ee2bdda2e8d873769325fabede32e420e0</description>
|
||||
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
|
||||
<tags>aspnetcore authentication security</tags>
|
||||
<serviceable>true</serviceable>
|
||||
<repository type="git" url="https://github.com/dotnet/dotnet" commit="2db1f5ee2bdda2e8d873769325fabede32e420e0" />
|
||||
<dependencies>
|
||||
<group targetFramework="net10.0">
|
||||
<dependency id="Microsoft.IdentityModel.Protocols.OpenIdConnect" version="8.0.1" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
<frameworkReferences><group targetFramework="net10.0"><frameworkReference name="Microsoft.AspNetCore.App" /></group></frameworkReferences></metadata>
|
||||
</package>
|
||||
@@ -0,0 +1,69 @@
|
||||
## About
|
||||
|
||||
Microsoft.AspNetCore.Authentication.JwtBearer is a middleware component designed for ASP.NET Core applications. It facilitates JSON Web Token (JWT) authentication, enabling secure authentication for APIs and web services. This package allows you to validate JWT tokens issued by an authentication server, ensuring secure access to your application's resources.
|
||||
|
||||
## Key Features
|
||||
|
||||
<!-- The key features of this package -->
|
||||
|
||||
* Seamless integration with ASP.NET Core applications.
|
||||
* Supports JSON Web Token (JWT) authentication.
|
||||
* Enables secure authentication for APIs and web services.
|
||||
* Flexible configuration options for token validation parameters.
|
||||
* Works with .NET Core 3.0 and newer, as well as .NET Standard 2.1.
|
||||
|
||||
## 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 -->
|
||||
|
||||
```C#
|
||||
using Microsoft.AspNetCore.Authentication.JwtBearer;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.IdentityModel.Tokens;
|
||||
using System.Text;
|
||||
|
||||
public void ConfigureServices(IServiceCollection services)
|
||||
{
|
||||
services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
|
||||
.AddJwtBearer(options =>
|
||||
{
|
||||
options.TokenValidationParameters = new TokenValidationParameters
|
||||
{
|
||||
ValidateIssuer = true,
|
||||
ValidateAudience = true,
|
||||
ValidateLifetime = true,
|
||||
ValidateIssuerSigningKey = true,
|
||||
ValidIssuer = "your_issuer",
|
||||
ValidAudience = "your_audience",
|
||||
IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes("your_secret_key"))
|
||||
};
|
||||
});
|
||||
|
||||
// Other configurations...
|
||||
}
|
||||
```
|
||||
For more detailed configuration options and advanced scenarios, please refer to the blog [JWT Validation and Authorization in ASP.NET Core](https://devblogs.microsoft.com/dotnet/jwt-validation-and-authorization-in-asp-net-core/).
|
||||
|
||||
## Main Types
|
||||
|
||||
<!-- The main types provided in this library -->
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `JwtBearerDefaults`: Contains default values for JWT Bearer authentication.
|
||||
* `JwtBearerEvents`: Events used to handle JWT Bearer authentication events.
|
||||
* `JwtBearerHandler`: Handles JWT Bearer authentication requests.
|
||||
* `wtBearerOptions`: Options for configuring JWT Bearer authentication.
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
|
||||
|
||||
* [Overview of ASP.NET Core authentication](https://learn.microsoft.com/aspnet/core/security/authentication/?view=aspnetcore-8.0)
|
||||
* [JwtBearer sample](https://github.com/dotnet/aspnetcore/tree/main/src/Security/Authentication/JwtBearer/samples)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
<!-- How to provide feedback on this package and contribute to it -->
|
||||
|
||||
Microsoft.AspNetCore.Authentication.JwtBearer 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/aspnetcore).
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,461 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Authentication.JwtBearer</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.AuthenticationFailedContext">
|
||||
<summary>
|
||||
A <see cref="T:Microsoft.AspNetCore.Authentication.ResultContext`1"/> when authentication has failed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.AuthenticationFailedContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationScheme,Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.AuthenticationFailedContext"/>.
|
||||
</summary>
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.AuthenticationFailedContext.Exception">
|
||||
<summary>
|
||||
Gets or sets the exception associated with the authentication failure.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.ForbiddenContext">
|
||||
<summary>
|
||||
A <see cref="T:Microsoft.AspNetCore.Authentication.ResultContext`1"/> when access to a resource is forbidden.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.ForbiddenContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationScheme,Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.ForbiddenContext"/>.
|
||||
</summary>
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext">
|
||||
<summary>
|
||||
A <see cref="T:Microsoft.AspNetCore.Authentication.PropertiesContext`1"/> when access to a resource authenticated using JWT bearer is challenged.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationScheme,Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext"/>.
|
||||
</summary>
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext.AuthenticateFailure">
|
||||
<summary>
|
||||
Any failures encountered during the authentication process.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext.Error">
|
||||
<summary>
|
||||
Gets or sets the "error" value returned to the caller as part
|
||||
of the WWW-Authenticate header. This property may be null when
|
||||
<see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.IncludeErrorDetails"/> is set to <c>false</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext.ErrorDescription">
|
||||
<summary>
|
||||
Gets or sets the "error_description" value returned to the caller as part
|
||||
of the WWW-Authenticate header. This property may be null when
|
||||
<see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.IncludeErrorDetails"/> is set to <c>false</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext.ErrorUri">
|
||||
<summary>
|
||||
Gets or sets the "error_uri" value returned to the caller as part of the
|
||||
WWW-Authenticate header. This property is always null unless explicitly set.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext.Handled">
|
||||
<summary>
|
||||
If true, will skip any default logic for this challenge.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext.HandleResponse">
|
||||
<summary>
|
||||
Skips any default logic for this challenge.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerDefaults">
|
||||
<summary>
|
||||
Default values used by <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler"/> for JWT bearer authentication.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerDefaults.AuthenticationScheme">
|
||||
<summary>
|
||||
Default value for AuthenticationScheme property in the <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents">
|
||||
<summary>
|
||||
Specifies events which the <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler"/> invokes to enable developer control over the authentication process.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.OnAuthenticationFailed">
|
||||
<summary>
|
||||
Invoked if authentication fails during request processing. The exceptions will be re-thrown after this event unless suppressed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.OnForbidden">
|
||||
<summary>
|
||||
Invoked if Authorization fails and results in a Forbidden response.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.OnMessageReceived">
|
||||
<summary>
|
||||
Invoked when a protocol message is first received.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.OnTokenValidated">
|
||||
<summary>
|
||||
Invoked after the security token has passed validation and a ClaimsIdentity has been generated.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.OnChallenge">
|
||||
<summary>
|
||||
Invoked before a challenge is sent back to the caller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.AuthenticationFailed(Microsoft.AspNetCore.Authentication.JwtBearer.AuthenticationFailedContext)">
|
||||
<summary>
|
||||
Invoked if exceptions are thrown during request processing. The exceptions will be re-thrown after this event unless suppressed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.Forbidden(Microsoft.AspNetCore.Authentication.JwtBearer.ForbiddenContext)">
|
||||
<summary>
|
||||
Invoked if Authorization fails and results in a Forbidden response
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.MessageReceived(Microsoft.AspNetCore.Authentication.JwtBearer.MessageReceivedContext)">
|
||||
<summary>
|
||||
Invoked when a protocol message is first received.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.TokenValidated(Microsoft.AspNetCore.Authentication.JwtBearer.TokenValidatedContext)">
|
||||
<summary>
|
||||
Invoked after the security token has passed validation and a ClaimsIdentity has been generated.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.Challenge(Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext)">
|
||||
<summary>
|
||||
Invoked before a challenge is sent back to the caller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler">
|
||||
<summary>
|
||||
An <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationHandler`1"/> that can perform JWT-bearer based authentication.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler.#ctor(Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions},Microsoft.Extensions.Logging.ILoggerFactory,System.Text.Encodings.Web.UrlEncoder,Microsoft.AspNetCore.Authentication.ISystemClock)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler"/>.
|
||||
</summary>
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler.#ctor(Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions},Microsoft.Extensions.Logging.ILoggerFactory,System.Text.Encodings.Web.UrlEncoder)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler"/>.
|
||||
</summary>
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler.Events">
|
||||
<summary>
|
||||
The handler calls methods on the events which give the application control at certain points where processing is occurring.
|
||||
If it is not provided a default instance is supplied which does nothing when the methods are called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler.CreateEventsAsync">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler.HandleAuthenticateAsync">
|
||||
<summary>
|
||||
Searches the 'Authorization' header for a 'Bearer' token. If the 'Bearer' token is found, it is validated using <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> set in the options.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler.HandleChallengeAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler.HandleForbiddenAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions">
|
||||
<summary>
|
||||
Options class provides information needed to control Bearer Authentication handler behavior
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.RequireHttpsMetadata">
|
||||
<summary>
|
||||
Gets or sets if HTTPS is required for the metadata address or authority.
|
||||
The default is true. This should be disabled only in development environments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.MetadataAddress">
|
||||
<summary>
|
||||
Gets or sets the discovery endpoint for obtaining metadata
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.Authority">
|
||||
<summary>
|
||||
Gets or sets the Authority to use when making OpenIdConnect calls.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.Audience">
|
||||
<summary>
|
||||
Gets or sets a single valid audience value for any received OpenIdConnect token.
|
||||
This value is passed into TokenValidationParameters.ValidAudience if that property is empty.
|
||||
</summary>
|
||||
<value>
|
||||
The expected audience for any received OpenIdConnect token.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.Challenge">
|
||||
<summary>
|
||||
Gets or sets the challenge to put in the "WWW-Authenticate" header.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.Events">
|
||||
<summary>
|
||||
The object provided by the application to process events raised by the bearer authentication handler.
|
||||
The application may implement the interface fully, or it may create an instance of JwtBearerEvents
|
||||
and assign delegates only to the events it wants to process.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.BackchannelHttpHandler">
|
||||
<summary>
|
||||
The HttpMessageHandler used to retrieve metadata.
|
||||
This cannot be set at the same time as BackchannelCertificateValidator unless the value
|
||||
is a WebRequestHandler.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.Backchannel">
|
||||
<summary>
|
||||
The Backchannel used to retrieve metadata.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.BackchannelTimeout">
|
||||
<summary>
|
||||
Gets or sets the timeout when using the backchannel to make an http call.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.Configuration">
|
||||
<summary>
|
||||
Configuration provided directly by the developer. If provided, then MetadataAddress and the Backchannel properties
|
||||
will not be used. This information should not be updated during request processing.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.ConfigurationManager">
|
||||
<summary>
|
||||
Responsible for retrieving, caching, and refreshing the configuration from metadata.
|
||||
If not provided, then one will be created using the MetadataAddress and Backchannel properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.RefreshOnIssuerKeyNotFound">
|
||||
<summary>
|
||||
Gets or sets if a metadata refresh should be attempted after a SecurityTokenSignatureKeyNotFoundException. This allows for automatic
|
||||
recovery in the event of a signature key rollover. This is enabled by default.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.SecurityTokenValidators">
|
||||
<summary>
|
||||
Gets the ordered list of <see cref="T:Microsoft.IdentityModel.Tokens.ISecurityTokenValidator"/> used to validate access tokens.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.TokenHandlers">
|
||||
<summary>
|
||||
Gets the ordered list of <see cref="T:Microsoft.IdentityModel.Tokens.TokenHandler"/> used to validate access tokens.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.TokenValidationParameters">
|
||||
<summary>
|
||||
Gets or sets the parameters used to validate identity tokens.
|
||||
</summary>
|
||||
<remarks>Contains the types and definitions required for validating a token.</remarks>
|
||||
<exception cref="T:System.ArgumentNullException">if 'value' is null.</exception>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.SaveToken">
|
||||
<summary>
|
||||
Defines whether the bearer token should be stored in the
|
||||
<see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> after a successful authorization.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.IncludeErrorDetails">
|
||||
<summary>
|
||||
Defines whether the token validation errors should be returned to the caller.
|
||||
Enabled by default, this option can be disabled to prevent the JWT handler
|
||||
from returning an error and an error_description in the WWW-Authenticate header.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.MapInboundClaims">
|
||||
<summary>
|
||||
Gets or sets the <see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.MapInboundClaims"/> property on the default instance of <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler"/> in SecurityTokenValidators, or <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler"/> in TokenHandlers, which is used when determining
|
||||
whether or not to map claim types that are extracted when validating a <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/> or a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>.
|
||||
<para>If this is set to true, the Claim Type is set to the JSON claim 'name' after translating using this mapping. Otherwise, no mapping occurs.</para>
|
||||
<para>The default value is true.</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.AutomaticRefreshInterval">
|
||||
<summary>
|
||||
Gets or sets how often an automatic metadata refresh should occur.
|
||||
</summary>
|
||||
<value>
|
||||
Defaults to <see cref="F:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.DefaultAutomaticRefreshInterval" />.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.RefreshInterval">
|
||||
<summary>
|
||||
Gets or sets the minimum time between retrievals, in the event that a retrieval failed, or that a refresh was explicitly requested.
|
||||
</summary>
|
||||
<value>
|
||||
Defaults to <see cref="F:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.DefaultRefreshInterval" />.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.UseSecurityTokenValidators">
|
||||
<summary>
|
||||
Gets or sets whether <see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.TokenHandlers"/> or <see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.SecurityTokenValidators"/> will be used to validate the inbound token.
|
||||
</summary>
|
||||
<remarks>
|
||||
The advantages of using TokenHandlers are:
|
||||
<para>There is an Async model.</para>
|
||||
<para>The default token handler is a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler"/> which is faster than a <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler"/>.</para>
|
||||
<para>There is an ability to make use of a Last-Known-Good model for metadata that protects applications when metadata is published with errors.</para>
|
||||
SecurityTokenValidators can be used when <see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.TokenValidatedContext.SecurityToken"/> needs a <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/>.
|
||||
When using TokenHandlers, <see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.TokenValidatedContext.SecurityToken"/> will be a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerPostConfigureOptions">
|
||||
<summary>
|
||||
Used to setup defaults for all <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerPostConfigureOptions.PostConfigure(System.String,Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions)">
|
||||
<summary>
|
||||
Invoked to post configure a JwtBearerOptions instance.
|
||||
</summary>
|
||||
<param name="name">The name of the options instance being configured.</param>
|
||||
<param name="options">The options instance to configure.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.MessageReceivedContext">
|
||||
<summary>
|
||||
A context for <see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.OnMessageReceived"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.MessageReceivedContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationScheme,Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.MessageReceivedContext"/>.
|
||||
</summary>
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.MessageReceivedContext.Token">
|
||||
<summary>
|
||||
Bearer Token. This will give the application an opportunity to retrieve a token from an alternative location.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.TokenValidatedContext">
|
||||
<summary>
|
||||
A context for <see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.OnTokenValidated"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.TokenValidatedContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationScheme,Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.TokenValidatedContext"/>.
|
||||
</summary>
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.TokenValidatedContext.SecurityToken">
|
||||
<summary>
|
||||
Gets or sets the validated security token.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.Resources.Exception_OptionMustBeProvided">
|
||||
<summary>The '{0}' option must be provided.</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.Resources.FormatException_OptionMustBeProvided(System.Object)">
|
||||
<summary>The '{0}' option must be provided.</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.Resources.Exception_ValidatorHandlerMismatch">
|
||||
<summary>An ICertificateValidator cannot be specified at the same time as an HttpMessageHandler unless it is a WebRequestHandler.</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearerConfigureOptions.#ctor(Microsoft.AspNetCore.Authentication.IAuthenticationConfigurationProvider)">
|
||||
<summary>
|
||||
Initializes a new <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearerConfigureOptions"/> given the configuration
|
||||
provided by the <paramref name="configurationProvider"/>.
|
||||
</summary>
|
||||
<param name="configurationProvider">An <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationConfigurationProvider"/> instance.</param>\
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearerConfigureOptions.Configure(System.String,Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearerConfigureOptions.Configure(Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.JwtBearerExtensions">
|
||||
<summary>
|
||||
Extension methods to configure JWT bearer authentication.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.JwtBearerExtensions.AddJwtBearer(Microsoft.AspNetCore.Authentication.AuthenticationBuilder)">
|
||||
<summary>
|
||||
Enables JWT-bearer authentication using the default scheme <see cref="F:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerDefaults.AuthenticationScheme"/>.
|
||||
<para>
|
||||
JWT bearer authentication performs authentication by extracting and validating a JWT token from the <c>Authorization</c> request header.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationBuilder"/>.</param>
|
||||
<returns>A reference to <paramref name="builder"/> after the operation has completed.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.JwtBearerExtensions.AddJwtBearer(Microsoft.AspNetCore.Authentication.AuthenticationBuilder,System.String)">
|
||||
<summary>
|
||||
Enables JWT-bearer authentication using a pre-defined scheme.
|
||||
<para>
|
||||
JWT bearer authentication performs authentication by extracting and validating a JWT token from the <c>Authorization</c> request header.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationBuilder"/>.</param>
|
||||
<param name="authenticationScheme">The authentication scheme.</param>
|
||||
<returns>A reference to <paramref name="builder"/> after the operation has completed.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.JwtBearerExtensions.AddJwtBearer(Microsoft.AspNetCore.Authentication.AuthenticationBuilder,System.Action{Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions})">
|
||||
<summary>
|
||||
Enables JWT-bearer authentication using the default scheme <see cref="F:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerDefaults.AuthenticationScheme"/>.
|
||||
<para>
|
||||
JWT bearer authentication performs authentication by extracting and validating a JWT token from the <c>Authorization</c> request header.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationBuilder"/>.</param>
|
||||
<param name="configureOptions">A delegate that allows configuring <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions"/>.</param>
|
||||
<returns>A reference to <paramref name="builder"/> after the operation has completed.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.JwtBearerExtensions.AddJwtBearer(Microsoft.AspNetCore.Authentication.AuthenticationBuilder,System.String,System.Action{Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions})">
|
||||
<summary>
|
||||
Enables JWT-bearer authentication using the specified scheme.
|
||||
<para>
|
||||
JWT bearer authentication performs authentication by extracting and validating a JWT token from the <c>Authorization</c> request header.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationBuilder"/>.</param>
|
||||
<param name="authenticationScheme">The authentication scheme.</param>
|
||||
<param name="configureOptions">A delegate that allows configuring <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions"/>.</param>
|
||||
<returns>A reference to <paramref name="builder"/> after the operation has completed.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.JwtBearerExtensions.AddJwtBearer(Microsoft.AspNetCore.Authentication.AuthenticationBuilder,System.String,System.String,System.Action{Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions})">
|
||||
<summary>
|
||||
Enables JWT-bearer authentication using the specified scheme.
|
||||
<para>
|
||||
JWT bearer authentication performs authentication by extracting and validating a JWT token from the <c>Authorization</c> request header.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationBuilder"/>.</param>
|
||||
<param name="authenticationScheme">The authentication scheme.</param>
|
||||
<param name="displayName">The display name for the authentication handler.</param>
|
||||
<param name="configureOptions">A delegate that allows configuring <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions"/>.</param>
|
||||
<returns>A reference to <paramref name="builder"/> after the operation has completed.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
IEwqDuYVSb6Xcpe0a7iqqDgyqlgUDR1JrIIDcDPJpQw1HJNBE5aZUo4BEpRIsu7+oCF6oXvi6hAdGOGQFF+Rng==
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "/jV4F+rrdy1/6AsZm2u3gkkt3Fp5R2vlBn6J4PE/wgZ9dQPC1moNiOReyxX/fmSNIur+VrxfrBRgDdfqNTQ3Ag==",
|
||||
"source": "/mnt/e/dev/git.stella-ops.org/local-nugets"
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@@ -0,0 +1,28 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.AspNetCore.Mvc.Testing</id>
|
||||
<version>10.0.0-rc.2.25502.107</version>
|
||||
<authors>Microsoft</authors>
|
||||
<requireLicenseAcceptance>true</requireLicenseAcceptance>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>Icon.png</icon>
|
||||
<readme>PACKAGE.md</readme>
|
||||
<projectUrl>https://asp.net/</projectUrl>
|
||||
<description>Support for writing functional tests for MVC applications.
|
||||
|
||||
This package was built from the source code at https://github.com/dotnet/dotnet/tree/89c8f6a112d37d2ea8b77821e56d170a1bccdc5a</description>
|
||||
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
|
||||
<tags>aspnetcore aspnetcoremvc aspnetcoremvctesting</tags>
|
||||
<serviceable>true</serviceable>
|
||||
<repository type="git" url="https://github.com/dotnet/dotnet" commit="89c8f6a112d37d2ea8b77821e56d170a1bccdc5a" />
|
||||
<dependencies>
|
||||
<group targetFramework="net10.0">
|
||||
<dependency id="Microsoft.AspNetCore.TestHost" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyModel" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Hosting" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
<frameworkReferences><group targetFramework="net10.0"><frameworkReference name="Microsoft.AspNetCore.App" /></group></frameworkReferences></metadata>
|
||||
</package>
|
||||
@@ -0,0 +1,72 @@
|
||||
## About
|
||||
|
||||
`Microsoft.AspNetCore.Mvc.Testing` provides support for writing integration tests for ASP.NET Core apps that utilize MVC or Minimal APIs.
|
||||
|
||||
## Key Features
|
||||
|
||||
* Copies the dependencies file (`.deps.json`) from the System Under Test (SUT) into the test project's `bin` directory
|
||||
* Sets the [content root](https://learn.microsoft.com/aspnet/core/fundamentals/#content-root) to the SUT's project root so that static files are found during test execution
|
||||
* Provides the [`WebApplicationFactory`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.mvc.testing.webapplicationfactory-1) class to streamline bootstrapping the SUT with [`TestServer`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.testhost.testserver)
|
||||
|
||||
## How to Use
|
||||
|
||||
To use `Microsoft.AspNetCore.Mvc.Testing`, follow these steps:
|
||||
|
||||
### Installation
|
||||
|
||||
To install the package, run the following command from the directory containing the test project file:
|
||||
|
||||
```shell
|
||||
dotnet add package Microsoft.AspNetCore.Mvc.Testing
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
To configure the test app, follow these steps:
|
||||
|
||||
1. Specify the Web SDK in the test project file (`<Project Sdk="Microsoft.NET.Sdk.Web">`).
|
||||
2. Add references to the following packages:
|
||||
* `xunit`
|
||||
* `xunit.runner.visualstudio`
|
||||
* `Microsoft.NET.Test.Sdk`
|
||||
3. Add a test class to the test project:
|
||||
```csharp
|
||||
public class BasicTests
|
||||
: IClassFixture<WebApplicationFactory<Program>>
|
||||
{
|
||||
private readonly WebApplicationFactory<Program> _factory;
|
||||
|
||||
public BasicTests(WebApplicationFactory<Program> factory)
|
||||
{
|
||||
_factory = factory;
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[InlineData("/")]
|
||||
[InlineData("/Index")]
|
||||
[InlineData("/About")]
|
||||
[InlineData("/Privacy")]
|
||||
[InlineData("/Contact")]
|
||||
public async Task Get_EndpointsReturnSuccessAndCorrectContentType(string url)
|
||||
{
|
||||
// Arrange
|
||||
var client = _factory.CreateClient();
|
||||
|
||||
// Act
|
||||
var response = await client.GetAsync(url);
|
||||
|
||||
// Assert
|
||||
response.EnsureSuccessStatusCode(); // Status Code 200-299
|
||||
Assert.Equal("text/html; charset=utf-8",
|
||||
response.Content.Headers.ContentType.ToString());
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
For additional documentation and examples, refer to the [official documentation](https://learn.microsoft.com/aspnet/core/test/integration-tests) on integration testing in ASP.NET Core.
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
`Microsoft.AspNetCore.Mvc.Testing` 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/aspnetcore).
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,3 @@
|
||||
<Project>
|
||||
<Import Project="..\..\build\net10.0\Microsoft.AspNetCore.Mvc.Testing.targets" />
|
||||
</Project>
|
||||
@@ -0,0 +1,440 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Mvc.Testing</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.AspNetCore.Mvc.Testing.Handlers.CookieContainerHandler">
|
||||
<summary>
|
||||
A <see cref="T:System.Net.Http.DelegatingHandler"/> that manages cookies associated with one or
|
||||
more pairs of <see cref="T:System.Net.Http.HttpRequestMessage"/> and <see cref="T:System.Net.Http.HttpResponseMessage"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.Handlers.CookieContainerHandler.#ctor">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:Microsoft.AspNetCore.Mvc.Testing.Handlers.CookieContainerHandler"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.Handlers.CookieContainerHandler.#ctor(System.Net.CookieContainer)">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:Microsoft.AspNetCore.Mvc.Testing.Handlers.CookieContainerHandler"/>.
|
||||
</summary>
|
||||
<param name="cookieContainer">The <see cref="T:System.Net.CookieContainer"/> to use for
|
||||
storing and retrieving cookies.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.Handlers.CookieContainerHandler.Container">
|
||||
<summary>
|
||||
Gets the <see cref="T:System.Net.CookieContainer"/> used to store and retrieve cookies.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.Handlers.CookieContainerHandler.SendAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Mvc.Testing.Handlers.RedirectHandler">
|
||||
<summary>
|
||||
A <see cref="T:System.Net.Http.DelegatingHandler"/> that follows redirect responses.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.Handlers.RedirectHandler.#ctor">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:Microsoft.AspNetCore.Mvc.Testing.Handlers.RedirectHandler"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.Handlers.RedirectHandler.#ctor(System.Int32)">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:Microsoft.AspNetCore.Mvc.Testing.Handlers.RedirectHandler"/>.
|
||||
</summary>
|
||||
<param name="maxRedirects">The maximum number of redirect responses to follow. It must be
|
||||
equal or greater than 0.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.Handlers.RedirectHandler.MaxRedirects">
|
||||
<summary>
|
||||
Gets the maximum number of redirects this handler will follow.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.Handlers.RedirectHandler.SendAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1">
|
||||
<summary>
|
||||
Factory for bootstrapping an application in memory for functional end to end tests.
|
||||
</summary>
|
||||
<typeparam name="TEntryPoint">A type in the entry point assembly of the application.
|
||||
Typically the Startup or Program classes can be used.</typeparam>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.#ctor">
|
||||
<summary>
|
||||
<para>
|
||||
Creates an instance of <see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1"/>. This factory can be used to
|
||||
create a <see cref="T:Microsoft.AspNetCore.TestHost.TestServer"/> instance using the MVC application defined by <typeparamref name="TEntryPoint"/>
|
||||
and one or more <see cref="T:System.Net.Http.HttpClient"/> instances used to send <see cref="T:System.Net.Http.HttpRequestMessage"/> to the <see cref="T:Microsoft.AspNetCore.TestHost.TestServer"/>.
|
||||
The <see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1"/> will find the entry point class of <typeparamref name="TEntryPoint"/>
|
||||
assembly and initialize the application by calling <c>IWebHostBuilder CreateWebHostBuilder(string [] args)</c>
|
||||
on <typeparamref name="TEntryPoint"/>.
|
||||
</para>
|
||||
<para>
|
||||
This constructor will infer the application content root path by searching for a
|
||||
<see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute"/> on the assembly containing the functional tests with
|
||||
a key equal to the <typeparamref name="TEntryPoint"/> assembly <see cref="P:System.Reflection.Assembly.FullName"/>.
|
||||
In case an attribute with the right key can't be found, <see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1"/>
|
||||
will fall back to searching for a solution file (*.sln) and then appending <typeparamref name="TEntryPoint"/> assembly name
|
||||
to the solution directory. The application root directory will be used to discover views and content files.
|
||||
</para>
|
||||
<para>
|
||||
The application assemblies will be loaded from the dependency context of the assembly containing
|
||||
<typeparamref name="TEntryPoint" />. This means that project dependencies of the assembly containing
|
||||
<typeparamref name="TEntryPoint" /> will be loaded as application assemblies.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.Finalize">
|
||||
<summary>
|
||||
Finalizes an instance of the <see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.Server">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.AspNetCore.TestHost.TestServer"/> created by this <see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.Services">
|
||||
<summary>
|
||||
Gets the <see cref="T:System.IServiceProvider"/> created by the server associated with this <see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.ServerStarted">
|
||||
<summary>
|
||||
Helps determine if the `StartServer` method has been called already.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.Factories">
|
||||
<summary>
|
||||
Gets the <see cref="T:System.Collections.Generic.IReadOnlyList`1"/> of factories created from this factory
|
||||
by further customizing the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> when calling
|
||||
<see cref="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.WithWebHostBuilder(System.Action{Microsoft.AspNetCore.Hosting.IWebHostBuilder})"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.ClientOptions">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryClientOptions"/> used by <see cref="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateClient"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.WithWebHostBuilder(System.Action{Microsoft.AspNetCore.Hosting.IWebHostBuilder})">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1"/> with a <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>
|
||||
that is further customized by <paramref name="configuration"/>.
|
||||
</summary>
|
||||
<param name="configuration">
|
||||
An <see cref="T:System.Action`1"/> to configure the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.
|
||||
</param>
|
||||
<returns>A new <see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.UseKestrel">
|
||||
<summary>
|
||||
Configures the factory to use Kestrel as the server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.UseKestrel(System.Int32)">
|
||||
<summary>
|
||||
Configures the factory to use Kestrel as the server.
|
||||
</summary>
|
||||
<param name="port">The port to listen to when the server starts. Use `0` to allow dynamic port selection.</param>
|
||||
<exception cref="T:System.InvalidOperationException">Thrown, if this method is called after the WebHostFactory has been initialized.</exception>
|
||||
<remarks>This method should be called before the factory is initialized either via one of the <see cref="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateClient"/> methods
|
||||
or via the <see cref="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.StartServer"/> method.</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.UseKestrel(System.Action{Microsoft.AspNetCore.Server.Kestrel.Core.KestrelServerOptions})">
|
||||
<summary>
|
||||
Configures the factory to use Kestrel as the server.
|
||||
</summary>
|
||||
<param name="configureKestrelOptions">A callback handler that will be used for configuring the server when it starts.</param>
|
||||
<exception cref="T:System.InvalidOperationException">Thrown, if this method is called after the WebHostFactory has been initialized.</exception>
|
||||
<remarks>This method should be called before the factory is initialized either via one of the <see cref="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateClient"/> methods
|
||||
or via the <see cref="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.StartServer"/> method.</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.StartServer">
|
||||
<summary>
|
||||
Initializes the instance by configurating the host builder.
|
||||
</summary>
|
||||
<exception cref="T:System.InvalidOperationException">Thrown if the provided <typeparamref name="TEntryPoint"/> type has no factory method.</exception>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CustomJsonSerializerContext.IDictionaryStringString">
|
||||
<summary>
|
||||
Defines the source generated JSON serialization contract metadata for a given type.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CustomJsonSerializerContext.String">
|
||||
<summary>
|
||||
Defines the source generated JSON serialization contract metadata for a given type.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CustomJsonSerializerContext.Default">
|
||||
<summary>
|
||||
The default <see cref="T:System.Text.Json.Serialization.JsonSerializerContext"/> associated with a default <see cref="T:System.Text.Json.JsonSerializerOptions"/> instance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CustomJsonSerializerContext.GeneratedSerializerOptions">
|
||||
<summary>
|
||||
The source-generated options associated with this context.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CustomJsonSerializerContext.#ctor">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CustomJsonSerializerContext.#ctor(System.Text.Json.JsonSerializerOptions)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CustomJsonSerializerContext.GetTypeInfo(System.Type)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.GetTestAssemblies">
|
||||
<summary>
|
||||
Gets the assemblies containing the functional tests. The
|
||||
<see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute"/> applied to these
|
||||
assemblies defines the content root to use for the given
|
||||
<typeparamref name="TEntryPoint"/>.
|
||||
</summary>
|
||||
<returns>The list of <see cref="T:System.Reflection.Assembly"/> containing tests.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateHostBuilder">
|
||||
<summary>
|
||||
Creates a <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> used to set up <see cref="T:Microsoft.AspNetCore.TestHost.TestServer"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The default implementation of this method looks for a <c>public static IHostBuilder CreateHostBuilder(string[] args)</c>
|
||||
method defined on the entry point of the assembly of <typeparamref name="TEntryPoint" /> and invokes it passing an empty string
|
||||
array as arguments.
|
||||
</remarks>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> instance.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateWebHostBuilder">
|
||||
<summary>
|
||||
Creates a <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> used to set up <see cref="T:Microsoft.AspNetCore.TestHost.TestServer"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The default implementation of this method looks for a <c>public static IWebHostBuilder CreateWebHostBuilder(string[] args)</c>
|
||||
method defined on the entry point of the assembly of <typeparamref name="TEntryPoint" /> and invokes it passing an empty string
|
||||
array as arguments.
|
||||
</remarks>
|
||||
<returns>A <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> instance.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateServer(Microsoft.AspNetCore.Hosting.IWebHostBuilder)">
|
||||
<summary>
|
||||
Creates the <see cref="T:Microsoft.AspNetCore.TestHost.TestServer"/> with the bootstrapped application in <paramref name="builder"/>.
|
||||
This is only called for applications using <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>. Applications based on
|
||||
<see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> will use <see cref="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateHost(Microsoft.Extensions.Hosting.IHostBuilder)"/> instead.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> used to
|
||||
create the server.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.TestHost.TestServer"/> with the bootstrapped application.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateServer(System.IServiceProvider)">
|
||||
<summary>
|
||||
Creates the <see cref="T:Microsoft.AspNetCore.TestHost.TestServer"/> with the <see cref="T:System.IServiceProvider"/> from the bootstrapped application.
|
||||
This is only called for applications using <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/>. Applications based on
|
||||
<see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> will use <see cref="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateHost(Microsoft.Extensions.Hosting.IHostBuilder)"/> instead.
|
||||
</summary>
|
||||
<param name="serviceProvider">The <see cref="T:System.IServiceProvider"/> from the bootstrapped application.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateHost(Microsoft.Extensions.Hosting.IHostBuilder)">
|
||||
<summary>
|
||||
Creates the <see cref="T:Microsoft.Extensions.Hosting.IHost"/> with the bootstrapped application in <paramref name="builder"/>.
|
||||
This is only called for applications using <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/>. Applications based on
|
||||
<see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> will use <see cref="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateServer(Microsoft.AspNetCore.Hosting.IWebHostBuilder)"/> instead.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> used to create the host.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Hosting.IHost"/> with the bootstrapped application.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.ConfigureWebHost(Microsoft.AspNetCore.Hosting.IWebHostBuilder)">
|
||||
<summary>
|
||||
Gives a fixture an opportunity to configure the application before it gets built.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> for the application.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateClient">
|
||||
<summary>
|
||||
Creates an instance of <see cref="T:System.Net.Http.HttpClient"/> that automatically follows
|
||||
redirects and handles cookies.
|
||||
</summary>
|
||||
<returns>The <see cref="T:System.Net.Http.HttpClient"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateClient(Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryClientOptions)">
|
||||
<summary>
|
||||
Creates an instance of <see cref="T:System.Net.Http.HttpClient"/> that automatically follows
|
||||
redirects and handles cookies.
|
||||
</summary>
|
||||
<returns>The <see cref="T:System.Net.Http.HttpClient"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateDefaultClient(System.Net.Http.DelegatingHandler[])">
|
||||
<summary>
|
||||
Creates a new instance of an <see cref="T:System.Net.Http.HttpClient"/> that can be used to
|
||||
send <see cref="T:System.Net.Http.HttpRequestMessage"/> to the server. The base address of the <see cref="T:System.Net.Http.HttpClient"/>
|
||||
instance will be set to <c>http://localhost</c>.
|
||||
</summary>
|
||||
<param name="handlers">A list of <see cref="T:System.Net.Http.DelegatingHandler"/> instances to set up on the
|
||||
<see cref="T:System.Net.Http.HttpClient"/>.</param>
|
||||
<returns>The <see cref="T:System.Net.Http.HttpClient"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.ConfigureClient(System.Net.Http.HttpClient)">
|
||||
<summary>
|
||||
Configures <see cref="T:System.Net.Http.HttpClient"/> instances created by this <see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1"/>.
|
||||
</summary>
|
||||
<param name="client">The <see cref="T:System.Net.Http.HttpClient"/> instance getting configured.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateDefaultClient(System.Uri,System.Net.Http.DelegatingHandler[])">
|
||||
<summary>
|
||||
Creates a new instance of an <see cref="T:System.Net.Http.HttpClient"/> that can be used to
|
||||
send <see cref="T:System.Net.Http.HttpRequestMessage"/> to the server.
|
||||
</summary>
|
||||
<param name="baseAddress">The base address of the <see cref="T:System.Net.Http.HttpClient"/> instance.</param>
|
||||
<param name="handlers">A list of <see cref="T:System.Net.Http.DelegatingHandler"/> instances to set up on the
|
||||
<see cref="T:System.Net.Http.HttpClient"/>.</param>
|
||||
<returns>The <see cref="T:System.Net.Http.HttpClient"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.Dispose(System.Boolean)">
|
||||
<summary>
|
||||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||||
</summary>
|
||||
<param name="disposing">
|
||||
<see langword="true" /> to release both managed and unmanaged resources;
|
||||
<see langword="false" /> to release only unmanaged resources.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.DisposeAsync">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryClientOptions">
|
||||
<summary>
|
||||
The default options to use to when creating
|
||||
<see cref="T:System.Net.Http.HttpClient"/> instances by calling
|
||||
<see cref="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateClient(Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryClientOptions)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryClientOptions.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryClientOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryClientOptions.BaseAddress">
|
||||
<summary>
|
||||
Gets or sets the base address of <see cref="T:System.Net.Http.HttpClient"/> instances created by calling
|
||||
<see cref="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateClient(Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryClientOptions)"/>.
|
||||
The default is <c>http://localhost</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryClientOptions.AllowAutoRedirect">
|
||||
<summary>
|
||||
Gets or sets whether or not <see cref="T:System.Net.Http.HttpClient"/> instances created by calling
|
||||
<see cref="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateClient(Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryClientOptions)"/>
|
||||
should automatically follow redirect responses.
|
||||
The default is <c>true</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryClientOptions.MaxAutomaticRedirections">
|
||||
<summary>
|
||||
Gets or sets the maximum number of redirect responses that <see cref="T:System.Net.Http.HttpClient"/> instances
|
||||
created by calling <see cref="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateClient(Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryClientOptions)"/>
|
||||
should follow.
|
||||
The default is <c>7</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryClientOptions.HandleCookies">
|
||||
<summary>
|
||||
Gets or sets whether <see cref="T:System.Net.Http.HttpClient"/> instances created by calling
|
||||
<see cref="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateClient(Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryClientOptions)"/>
|
||||
should handle cookies.
|
||||
The default is <c>true</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute">
|
||||
<summary>
|
||||
Metadata that <see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1"/> uses to find out the content
|
||||
root for the web application represented by <c>TEntryPoint</c>.
|
||||
<see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1"/> will iterate over all the instances of
|
||||
<see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute"/>, filter the instances whose
|
||||
<see cref="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute.Key"/> is equal to <c>TEntryPoint</c> <see cref="P:System.Reflection.Assembly.FullName"/>,
|
||||
order them by <see cref="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute.Priority"/> in ascending order.
|
||||
<see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1"/> will check for the existence of the marker
|
||||
in <c>Path.Combine(<see cref="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute.ContentRootPath"/>, Path.GetFileName(<see cref="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute.ContentRootTest"/>))"</c>
|
||||
and if the file exists it will set the content root to <see cref="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute.ContentRootPath"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute.#ctor(System.String,System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute"/>.
|
||||
</summary>
|
||||
<param name="key">
|
||||
The key of this <see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute"/>. This
|
||||
key is used by <see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1"/> to determine what of the
|
||||
<see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute"/> instances on the test assembly should be used
|
||||
to match a given TEntryPoint class.
|
||||
</param>
|
||||
<param name="contentRootPath">The path to the content root. This path can be either relative or absolute.
|
||||
In case the path is relative, the path will be combined with
|
||||
<see cref="M:System.IO.Directory.GetCurrentDirectory"/></param>
|
||||
<param name="contentRootTest">
|
||||
A file that will be use as a marker to determine that the content root path for the given context is correct.
|
||||
</param>
|
||||
<param name="priority">
|
||||
The priority of this content root attribute compared to other attributes. When
|
||||
multiple <see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute"/> instances are applied for the
|
||||
same key, they are processed with <see cref="M:System.Int32.Parse(System.String)"/>, ordered in ascending order and applied
|
||||
in priority until a match is found.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute.Key">
|
||||
<summary>
|
||||
Gets the key for the content root associated with this project. Typically <see cref="P:System.Reflection.Assembly.FullName"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute.ContentRootPath">
|
||||
<summary>
|
||||
Gets the content root path for a given project. This content root can be relative or absolute. If it is a
|
||||
relative path, it will be combined with <see cref="P:System.AppContext.BaseDirectory"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute.ContentRootTest">
|
||||
<summary>
|
||||
A marker file used to ensure that the path the content root is being set to is correct.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute.Priority">
|
||||
<summary>
|
||||
Gets a number for determining the probing order when multiple <see cref="T:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactoryContentRootAttribute"/>
|
||||
instances with the same key are present on the test <see cref="T:System.Reflection.Assembly"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.Resources.InvalidAssemblyEntryPoint">
|
||||
<summary>The provided Type '{0}' does not belong to an assembly with an entry point. A common cause for this error is providing a Type from a class library.</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.Resources.FormatInvalidAssemblyEntryPoint(System.Object)">
|
||||
<summary>The provided Type '{0}' does not belong to an assembly with an entry point. A common cause for this error is providing a Type from a class library.</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.Resources.MissingBuilderMethod">
|
||||
<summary>No method 'public static {0} CreateHostBuilder(string[] args)' or 'public static {1} CreateWebHostBuilder(string[] args)' found on '{2}'. Alternatively, {3} can be extended and '{4}' or '{5}' can be overridden to provide your own instance.</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.Resources.FormatMissingBuilderMethod(System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
|
||||
<summary>No method 'public static {0} CreateHostBuilder(string[] args)' or 'public static {1} CreateWebHostBuilder(string[] args)' found on '{2}'. Alternatively, {3} can be extended and '{4}' or '{5}' can be overridden to provide your own instance.</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.Resources.MissingDepsFile">
|
||||
<summary>Can't find '{0}'. This file is required for functional tests to run properly. There should be a copy of the file on your source project bin folder. If that is not the case, make sure that the property PreserveCompilationContext is set to true on your proje ...</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Mvc.Testing.Resources.FormatMissingDepsFile(System.Object,System.Object)">
|
||||
<summary>Can't find '{0}'. This file is required for functional tests to run properly. There should be a copy of the file on your source project bin folder. If that is not the case, make sure that the property PreserveCompilationContext is set to true on your proje ...</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.Resources.ServerNotInitialized">
|
||||
<summary>Server hasn't been initialized yet. Please initialize the server first before trying to create a client.</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.Resources.TestServerNotSupportedWhenUsingKestrel">
|
||||
<summary>Accessing the `Server` property isn't supported when using Kestrel server.</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Mvc.Testing.Resources.UseKestrelCanBeCalledBeforeInitialization">
|
||||
<summary>UseKestrel should be called before server initialization. Calling UseKestrel after the server was initialized will have no effect.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
150jFtUJTsLHjjknO5Ed8IFaP1mMLBk0pFXR41IsZFyza/Alzl+E30gPU6dZ+y0P7bJTZdWVzTY5V2sWfV9nlA==
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "50Egznb0tgVvITuuQQhhQ2fCQqKsy+I7Cy2QopLZziDw/IRhvM+L5ZKA7AdsEr4x/lmuB0HnZPKjD8eRjkbVog==",
|
||||
"source": "/mnt/e/dev/git.stella-ops.org/local-nugets"
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@@ -0,0 +1,26 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.AspNetCore.OpenApi</id>
|
||||
<version>10.0.0-rc.2.25502.107</version>
|
||||
<authors>Microsoft</authors>
|
||||
<requireLicenseAcceptance>true</requireLicenseAcceptance>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>Icon.png</icon>
|
||||
<readme>PACKAGE.md</readme>
|
||||
<projectUrl>https://asp.net/</projectUrl>
|
||||
<description>Provides APIs for annotating route handler endpoints in ASP.NET Core with OpenAPI annotations.
|
||||
|
||||
This package was built from the source code at https://github.com/dotnet/dotnet/tree/89c8f6a112d37d2ea8b77821e56d170a1bccdc5a</description>
|
||||
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
|
||||
<tags>aspnetcore openapi</tags>
|
||||
<serviceable>true</serviceable>
|
||||
<repository type="git" url="https://github.com/dotnet/dotnet" commit="89c8f6a112d37d2ea8b77821e56d170a1bccdc5a" />
|
||||
<dependencies>
|
||||
<group targetFramework="net10.0">
|
||||
<dependency id="Microsoft.OpenApi" version="2.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
<frameworkReferences><group targetFramework="net10.0"><frameworkReference name="Microsoft.AspNetCore.App" /></group></frameworkReferences></metadata>
|
||||
</package>
|
||||
@@ -0,0 +1,54 @@
|
||||
## About
|
||||
|
||||
Microsoft.AspNetCore.OpenApi is a NuGet package that provides built-in support for generating OpenAPI documents from minimal or controller-based APIs in ASP.NET Core.
|
||||
|
||||
## Key Features
|
||||
|
||||
* Supports viewing generated OpenAPI documents at runtime via a parameterized endpoint (`/openapi/{documentName}.json`)
|
||||
* Supports generating an OpenAPI document at build-time
|
||||
* Supports customizing the generated document via document transformers
|
||||
|
||||
## How to Use
|
||||
|
||||
To start using Microsoft.AspNetCore.OpenApi in your ASP.NET Core application, follow these steps:
|
||||
|
||||
### Installation
|
||||
|
||||
```sh
|
||||
dotnet add package Microsoft.AspNetCore.OpenApi
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
In your Program.cs file, register the services provided by this package in the DI container and map the provided OpenAPI document endpoint in the application.
|
||||
|
||||
```C#
|
||||
var builder = WebApplication.CreateBuilder();
|
||||
|
||||
// Registers the required services
|
||||
builder.Services.AddOpenApi();
|
||||
|
||||
var app = builder.Build();
|
||||
|
||||
// Adds the /openapi/{documentName}.json endpoint to the application
|
||||
app.MapOpenApi();
|
||||
|
||||
app.Run();
|
||||
```
|
||||
|
||||
For more information on configuring and using Microsoft.AspNetCore.OpenApi, refer to the [official documentation](https://learn.microsoft.com/aspnet/core/fundamentals/minimal-apis/openapi).
|
||||
|
||||
## Main Types
|
||||
|
||||
<!-- The main types provided in this library -->
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `OpenApiOptions`: Options for configuring OpenAPI document generation.
|
||||
* `IDocumentTransformer`: Transformer that modifies the OpenAPI document generated by the library.
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
<!-- How to provide feedback on this package and contribute to it -->
|
||||
|
||||
Microsoft.AspNetCore.OpenApi 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/aspnetcore).
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
Binary file not shown.
@@ -0,0 +1 @@
|
||||
soikExuo42OVUb3uhV1suhcb++wDgnFwY/EQebqb2UfviRtL+JzNFcPNjxEmHYeCyJga4dVtue7KqQMRIU42iw==
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "UcSjPsst+DfAdJGVDsu346FX0ci0ah+lw3WRtn18NUwEqRt70HaOQ7lI72vy3+1LxtqI3T5GWwV39rQSrCzAeg==",
|
||||
"source": "/mnt/e/dev/git.stella-ops.org/local-nugets"
|
||||
}
|
||||
BIN
local-nugets/microsoft.bcl.asyncinterfaces/6.0.0/.signature.p7s
Normal file
BIN
local-nugets/microsoft.bcl.asyncinterfaces/6.0.0/.signature.p7s
Normal file
Binary file not shown.
BIN
local-nugets/microsoft.bcl.asyncinterfaces/6.0.0/Icon.png
Normal file
BIN
local-nugets/microsoft.bcl.asyncinterfaces/6.0.0/Icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.8 KiB |
23
local-nugets/microsoft.bcl.asyncinterfaces/6.0.0/LICENSE.TXT
Normal file
23
local-nugets/microsoft.bcl.asyncinterfaces/6.0.0/LICENSE.TXT
Normal file
@@ -0,0 +1,23 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) .NET Foundation and Contributors
|
||||
|
||||
All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,31 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Bcl.AsyncInterfaces</id>
|
||||
<version>6.0.0</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>Provides the IAsyncEnumerable<T> and IAsyncDisposable interfaces and helper types for .NET Standard 2.0. This package is not required starting with .NET Standard 2.1 and .NET Core 3.0.
|
||||
|
||||
Commonly Used Types:
|
||||
System.IAsyncDisposable
|
||||
System.Collections.Generic.IAsyncEnumerable
|
||||
System.Collections.Generic.IAsyncEnumerator</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/runtime" commit="4822e3c3aa77eb82b2fb33c9321f923cf11ddde6" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.6.1">
|
||||
<dependency id="System.Threading.Tasks.Extensions" version="4.5.4" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="System.Threading.Tasks.Extensions" version="4.5.4" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.1" />
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
@@ -0,0 +1,939 @@
|
||||
.NET Runtime uses third-party libraries or other resources that may be
|
||||
distributed under licenses different than the .NET Runtime software.
|
||||
|
||||
In the event that we accidentally failed to list a required notice, please
|
||||
bring it to our attention. Post an issue or email us:
|
||||
|
||||
dotnet@microsoft.com
|
||||
|
||||
The attached notices are provided for information only.
|
||||
|
||||
License notice for ASP.NET
|
||||
-------------------------------
|
||||
|
||||
Copyright (c) .NET Foundation. All rights reserved.
|
||||
Licensed under the Apache License, Version 2.0.
|
||||
|
||||
Available at
|
||||
https://github.com/dotnet/aspnetcore/blob/main/LICENSE.txt
|
||||
|
||||
License notice for Slicing-by-8
|
||||
-------------------------------
|
||||
|
||||
http://sourceforge.net/projects/slicing-by-8/
|
||||
|
||||
Copyright (c) 2004-2006 Intel Corporation - All Rights Reserved
|
||||
|
||||
|
||||
This software program is licensed subject to the BSD License, available at
|
||||
http://www.opensource.org/licenses/bsd-license.html.
|
||||
|
||||
|
||||
License notice for Unicode data
|
||||
-------------------------------
|
||||
|
||||
https://www.unicode.org/license.html
|
||||
|
||||
Copyright © 1991-2020 Unicode, Inc. All rights reserved.
|
||||
Distributed under the Terms of Use in https://www.unicode.org/copyright.html.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of the Unicode data files and any associated documentation
|
||||
(the "Data Files") or Unicode software and any associated documentation
|
||||
(the "Software") to deal in the Data Files or Software
|
||||
without restriction, including without limitation the rights to use,
|
||||
copy, modify, merge, publish, distribute, and/or sell copies of
|
||||
the Data Files or Software, and to permit persons to whom the Data Files
|
||||
or Software are furnished to do so, provided that either
|
||||
(a) this copyright and permission notice appear with all copies
|
||||
of the Data Files or Software, or
|
||||
(b) this copyright and permission notice appear in associated
|
||||
Documentation.
|
||||
|
||||
THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF
|
||||
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
||||
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT OF THIRD PARTY RIGHTS.
|
||||
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS
|
||||
NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL
|
||||
DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
|
||||
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
|
||||
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||
PERFORMANCE OF THE DATA FILES OR SOFTWARE.
|
||||
|
||||
Except as contained in this notice, the name of a copyright holder
|
||||
shall not be used in advertising or otherwise to promote the sale,
|
||||
use or other dealings in these Data Files or Software without prior
|
||||
written authorization of the copyright holder.
|
||||
|
||||
License notice for Zlib
|
||||
-----------------------
|
||||
|
||||
https://github.com/madler/zlib
|
||||
http://zlib.net/zlib_license.html
|
||||
|
||||
/* zlib.h -- interface of the 'zlib' general purpose compression library
|
||||
version 1.2.11, January 15th, 2017
|
||||
|
||||
Copyright (C) 1995-2017 Jean-loup Gailly and Mark Adler
|
||||
|
||||
This software is provided 'as-is', without any express or implied
|
||||
warranty. In no event will the authors be held liable for any damages
|
||||
arising from the use of this software.
|
||||
|
||||
Permission is granted to anyone to use this software for any purpose,
|
||||
including commercial applications, and to alter it and redistribute it
|
||||
freely, subject to the following restrictions:
|
||||
|
||||
1. The origin of this software must not be misrepresented; you must not
|
||||
claim that you wrote the original software. If you use this software
|
||||
in a product, an acknowledgment in the product documentation would be
|
||||
appreciated but is not required.
|
||||
2. Altered source versions must be plainly marked as such, and must not be
|
||||
misrepresented as being the original software.
|
||||
3. This notice may not be removed or altered from any source distribution.
|
||||
|
||||
Jean-loup Gailly Mark Adler
|
||||
jloup@gzip.org madler@alumni.caltech.edu
|
||||
|
||||
*/
|
||||
|
||||
License notice for Mono
|
||||
-------------------------------
|
||||
|
||||
http://www.mono-project.com/docs/about-mono/
|
||||
|
||||
Copyright (c) .NET Foundation Contributors
|
||||
|
||||
MIT License
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the Software), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
License notice for International Organization for Standardization
|
||||
-----------------------------------------------------------------
|
||||
|
||||
Portions (C) International Organization for Standardization 1986:
|
||||
Permission to copy in any form is granted for use with
|
||||
conforming SGML systems and applications as defined in
|
||||
ISO 8879, provided this notice is included in all copies.
|
||||
|
||||
License notice for Intel
|
||||
------------------------
|
||||
|
||||
"Copyright (c) 2004-2006 Intel Corporation - All Rights Reserved
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
License notice for Xamarin and Novell
|
||||
-------------------------------------
|
||||
|
||||
Copyright (c) 2015 Xamarin, Inc (http://www.xamarin.com)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
Copyright (c) 2011 Novell, Inc (http://www.novell.com)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
Third party notice for W3C
|
||||
--------------------------
|
||||
|
||||
"W3C SOFTWARE AND DOCUMENT NOTICE AND LICENSE
|
||||
Status: This license takes effect 13 May, 2015.
|
||||
This work is being provided by the copyright holders under the following license.
|
||||
License
|
||||
By obtaining and/or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions.
|
||||
Permission to copy, modify, and distribute this work, with or without modification, for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the work or portions thereof, including modifications:
|
||||
The full text of this NOTICE in a location viewable to users of the redistributed or derivative work.
|
||||
Any pre-existing intellectual property disclaimers, notices, or terms and conditions. If none exist, the W3C Software and Document Short Notice should be included.
|
||||
Notice of any changes or modifications, through a copyright statement on the new code or document such as "This software or document includes material copied from or derived from [title and URI of the W3C document]. Copyright © [YEAR] W3C® (MIT, ERCIM, Keio, Beihang)."
|
||||
Disclaimers
|
||||
THIS WORK IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENT WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
|
||||
COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENT.
|
||||
The name and trademarks of copyright holders may NOT be used in advertising or publicity pertaining to the work without specific, written prior permission. Title to copyright in this work will at all times remain with copyright holders."
|
||||
|
||||
License notice for Bit Twiddling Hacks
|
||||
--------------------------------------
|
||||
|
||||
Bit Twiddling Hacks
|
||||
|
||||
By Sean Eron Anderson
|
||||
seander@cs.stanford.edu
|
||||
|
||||
Individually, the code snippets here are in the public domain (unless otherwise
|
||||
noted) — feel free to use them however you please. The aggregate collection and
|
||||
descriptions are © 1997-2005 Sean Eron Anderson. The code and descriptions are
|
||||
distributed in the hope that they will be useful, but WITHOUT ANY WARRANTY and
|
||||
without even the implied warranty of merchantability or fitness for a particular
|
||||
purpose.
|
||||
|
||||
License notice for Brotli
|
||||
--------------------------------------
|
||||
|
||||
Copyright (c) 2009, 2010, 2013-2016 by the Brotli Authors.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
compress_fragment.c:
|
||||
Copyright (c) 2011, Google Inc.
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above
|
||||
copyright notice, this list of conditions and the following disclaimer
|
||||
in the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
* Neither the name of Google Inc. nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
""AS IS"" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
decode_fuzzer.c:
|
||||
Copyright (c) 2015 The Chromium Authors. All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above
|
||||
copyright notice, this list of conditions and the following disclaimer
|
||||
in the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
* Neither the name of Google Inc. nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
""AS IS"" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
|
||||
|
||||
License notice for Json.NET
|
||||
-------------------------------
|
||||
|
||||
https://github.com/JamesNK/Newtonsoft.Json/blob/master/LICENSE.md
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2007 James Newton-King
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
License notice for vectorized base64 encoding / decoding
|
||||
--------------------------------------------------------
|
||||
|
||||
Copyright (c) 2005-2007, Nick Galbreath
|
||||
Copyright (c) 2013-2017, Alfred Klomp
|
||||
Copyright (c) 2015-2017, Wojciech Mula
|
||||
Copyright (c) 2016-2017, Matthieu Darbois
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
- Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimer.
|
||||
|
||||
- Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
|
||||
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
||||
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
|
||||
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
|
||||
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
||||
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
||||
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
||||
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
License notice for RFC 3492
|
||||
---------------------------
|
||||
|
||||
The punycode implementation is based on the sample code in RFC 3492
|
||||
|
||||
Copyright (C) The Internet Society (2003). All Rights Reserved.
|
||||
|
||||
This document and translations of it may be copied and furnished to
|
||||
others, and derivative works that comment on or otherwise explain it
|
||||
or assist in its implementation may be prepared, copied, published
|
||||
and distributed, in whole or in part, without restriction of any
|
||||
kind, provided that the above copyright notice and this paragraph are
|
||||
included on all such copies and derivative works. However, this
|
||||
document itself may not be modified in any way, such as by removing
|
||||
the copyright notice or references to the Internet Society or other
|
||||
Internet organizations, except as needed for the purpose of
|
||||
developing Internet standards in which case the procedures for
|
||||
copyrights defined in the Internet Standards process must be
|
||||
followed, or as required to translate it into languages other than
|
||||
English.
|
||||
|
||||
The limited permissions granted above are perpetual and will not be
|
||||
revoked by the Internet Society or its successors or assigns.
|
||||
|
||||
This document and the information contained herein is provided on an
|
||||
"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
|
||||
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
|
||||
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
|
||||
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
|
||||
|
||||
License notice for Algorithm from Internet Draft document "UUIDs and GUIDs"
|
||||
---------------------------------------------------------------------------
|
||||
|
||||
Copyright (c) 1990- 1993, 1996 Open Software Foundation, Inc.
|
||||
Copyright (c) 1989 by Hewlett-Packard Company, Palo Alto, Ca. &
|
||||
Digital Equipment Corporation, Maynard, Mass.
|
||||
To anyone who acknowledges that this file is provided "AS IS"
|
||||
without any express or implied warranty: permission to use, copy,
|
||||
modify, and distribute this file for any purpose is hereby
|
||||
granted without fee, provided that the above copyright notices and
|
||||
this notice appears in all source code copies, and that none of
|
||||
the names of Open Software Foundation, Inc., Hewlett-Packard
|
||||
Company, or Digital Equipment Corporation be used in advertising
|
||||
or publicity pertaining to distribution of the software without
|
||||
specific, written prior permission. Neither Open Software
|
||||
Foundation, Inc., Hewlett-Packard Company, Microsoft, nor Digital Equipment
|
||||
Corporation makes any representations about the suitability of
|
||||
this software for any purpose.
|
||||
|
||||
Copyright(C) The Internet Society 1997. All Rights Reserved.
|
||||
|
||||
This document and translations of it may be copied and furnished to others,
|
||||
and derivative works that comment on or otherwise explain it or assist in
|
||||
its implementation may be prepared, copied, published and distributed, in
|
||||
whole or in part, without restriction of any kind, provided that the above
|
||||
copyright notice and this paragraph are included on all such copies and
|
||||
derivative works.However, this document itself may not be modified in any
|
||||
way, such as by removing the copyright notice or references to the Internet
|
||||
Society or other Internet organizations, except as needed for the purpose of
|
||||
developing Internet standards in which case the procedures for copyrights
|
||||
defined in the Internet Standards process must be followed, or as required
|
||||
to translate it into languages other than English.
|
||||
|
||||
The limited permissions granted above are perpetual and will not be revoked
|
||||
by the Internet Society or its successors or assigns.
|
||||
|
||||
This document and the information contained herein is provided on an "AS IS"
|
||||
basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE
|
||||
DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
|
||||
ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY
|
||||
RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A
|
||||
PARTICULAR PURPOSE.
|
||||
|
||||
License notice for Algorithm from RFC 4122 -
|
||||
A Universally Unique IDentifier (UUID) URN Namespace
|
||||
----------------------------------------------------
|
||||
|
||||
Copyright (c) 1990- 1993, 1996 Open Software Foundation, Inc.
|
||||
Copyright (c) 1989 by Hewlett-Packard Company, Palo Alto, Ca. &
|
||||
Digital Equipment Corporation, Maynard, Mass.
|
||||
Copyright (c) 1998 Microsoft.
|
||||
To anyone who acknowledges that this file is provided "AS IS"
|
||||
without any express or implied warranty: permission to use, copy,
|
||||
modify, and distribute this file for any purpose is hereby
|
||||
granted without fee, provided that the above copyright notices and
|
||||
this notice appears in all source code copies, and that none of
|
||||
the names of Open Software Foundation, Inc., Hewlett-Packard
|
||||
Company, Microsoft, or Digital Equipment Corporation be used in
|
||||
advertising or publicity pertaining to distribution of the software
|
||||
without specific, written prior permission. Neither Open Software
|
||||
Foundation, Inc., Hewlett-Packard Company, Microsoft, nor Digital
|
||||
Equipment Corporation makes any representations about the
|
||||
suitability of this software for any purpose."
|
||||
|
||||
License notice for The LLVM Compiler Infrastructure
|
||||
---------------------------------------------------
|
||||
|
||||
Developed by:
|
||||
|
||||
LLVM Team
|
||||
|
||||
University of Illinois at Urbana-Champaign
|
||||
|
||||
http://llvm.org
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal with
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||
of the Software, and to permit persons to whom the Software is furnished to do
|
||||
so, subject to the following conditions:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimers.
|
||||
|
||||
* Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimers in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
|
||||
* Neither the names of the LLVM Team, University of Illinois at
|
||||
Urbana-Champaign, nor the names of its contributors may be used to
|
||||
endorse or promote products derived from this Software without specific
|
||||
prior written permission.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
|
||||
SOFTWARE.
|
||||
|
||||
License notice for Bob Jenkins
|
||||
------------------------------
|
||||
|
||||
By Bob Jenkins, 1996. bob_jenkins@burtleburtle.net. You may use this
|
||||
code any way you wish, private, educational, or commercial. It's free.
|
||||
|
||||
License notice for Greg Parker
|
||||
------------------------------
|
||||
|
||||
Greg Parker gparker@cs.stanford.edu December 2000
|
||||
This code is in the public domain and may be copied or modified without
|
||||
permission.
|
||||
|
||||
License notice for libunwind based code
|
||||
----------------------------------------
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
License notice for Printing Floating-Point Numbers (Dragon4)
|
||||
------------------------------------------------------------
|
||||
|
||||
/******************************************************************************
|
||||
Copyright (c) 2014 Ryan Juckett
|
||||
http://www.ryanjuckett.com/
|
||||
|
||||
This software is provided 'as-is', without any express or implied
|
||||
warranty. In no event will the authors be held liable for any damages
|
||||
arising from the use of this software.
|
||||
|
||||
Permission is granted to anyone to use this software for any purpose,
|
||||
including commercial applications, and to alter it and redistribute it
|
||||
freely, subject to the following restrictions:
|
||||
|
||||
1. The origin of this software must not be misrepresented; you must not
|
||||
claim that you wrote the original software. If you use this software
|
||||
in a product, an acknowledgment in the product documentation would be
|
||||
appreciated but is not required.
|
||||
|
||||
2. Altered source versions must be plainly marked as such, and must not be
|
||||
misrepresented as being the original software.
|
||||
|
||||
3. This notice may not be removed or altered from any source
|
||||
distribution.
|
||||
******************************************************************************/
|
||||
|
||||
License notice for Printing Floating-point Numbers (Grisu3)
|
||||
-----------------------------------------------------------
|
||||
|
||||
Copyright 2012 the V8 project authors. All rights reserved.
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above
|
||||
copyright notice, this list of conditions and the following
|
||||
disclaimer in the documentation and/or other materials provided
|
||||
with the distribution.
|
||||
* Neither the name of Google Inc. nor the names of its
|
||||
contributors may be used to endorse or promote products derived
|
||||
from this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
License notice for xxHash
|
||||
-------------------------
|
||||
|
||||
xxHash Library
|
||||
Copyright (c) 2012-2014, Yann Collet
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification,
|
||||
are permitted provided that the following conditions are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
* Redistributions in binary form must reproduce the above copyright notice, this
|
||||
list of conditions and the following disclaimer in the documentation and/or
|
||||
other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
|
||||
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
||||
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
License notice for Berkeley SoftFloat Release 3e
|
||||
------------------------------------------------
|
||||
|
||||
https://github.com/ucb-bar/berkeley-softfloat-3
|
||||
https://github.com/ucb-bar/berkeley-softfloat-3/blob/master/COPYING.txt
|
||||
|
||||
License for Berkeley SoftFloat Release 3e
|
||||
|
||||
John R. Hauser
|
||||
2018 January 20
|
||||
|
||||
The following applies to the whole of SoftFloat Release 3e as well as to
|
||||
each source file individually.
|
||||
|
||||
Copyright 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018 The Regents of the
|
||||
University of California. All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions, and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions, and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
|
||||
3. Neither the name of the University nor the names of its contributors
|
||||
may be used to endorse or promote products derived from this software
|
||||
without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS", AND ANY
|
||||
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
|
||||
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
||||
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
License notice for xoshiro RNGs
|
||||
--------------------------------
|
||||
|
||||
Written in 2018 by David Blackman and Sebastiano Vigna (vigna@acm.org)
|
||||
|
||||
To the extent possible under law, the author has dedicated all copyright
|
||||
and related and neighboring rights to this software to the public domain
|
||||
worldwide. This software is distributed without any warranty.
|
||||
|
||||
See <http://creativecommons.org/publicdomain/zero/1.0/>.
|
||||
|
||||
License for fastmod (https://github.com/lemire/fastmod) and ibm-fpgen (https://github.com/nigeltao/parse-number-fxx-test-data)
|
||||
--------------------------------------
|
||||
|
||||
Copyright 2018 Daniel Lemire
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
License notice for The C++ REST SDK
|
||||
-----------------------------------
|
||||
|
||||
C++ REST SDK
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) Microsoft Corporation
|
||||
|
||||
All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
License notice for MessagePack-CSharp
|
||||
-------------------------------------
|
||||
|
||||
MessagePack for C#
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2017 Yoshifumi Kawai
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
License notice for lz4net
|
||||
-------------------------------------
|
||||
|
||||
lz4net
|
||||
|
||||
Copyright (c) 2013-2017, Milosz Krajewski
|
||||
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||||
|
||||
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||||
|
||||
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
License notice for Nerdbank.Streams
|
||||
-----------------------------------
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) Andrew Arnott
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
License notice for RapidJSON
|
||||
----------------------------
|
||||
|
||||
Tencent is pleased to support the open source community by making RapidJSON available.
|
||||
|
||||
Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip. All rights reserved.
|
||||
|
||||
Licensed under the MIT License (the "License"); you may not use this file except
|
||||
in compliance with the License. You may obtain a copy of the License at
|
||||
|
||||
http://opensource.org/licenses/MIT
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software distributed
|
||||
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
|
||||
CONDITIONS OF ANY KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations under the License.
|
||||
|
||||
License notice for DirectX Math Library
|
||||
---------------------------------------
|
||||
|
||||
https://github.com/microsoft/DirectXMath/blob/master/LICENSE
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2011-2020 Microsoft Corp
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
||||
software and associated documentation files (the "Software"), to deal in the Software
|
||||
without restriction, including without limitation the rights to use, copy, modify,
|
||||
merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to the following
|
||||
conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies
|
||||
or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
|
||||
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
||||
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
|
||||
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
|
||||
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
License notice for ldap4net
|
||||
---------------------------
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2018 Alexander Chermyanin
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
License notice for vectorized sorting code
|
||||
------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020 Dan Shechter
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
License notice for musl
|
||||
-----------------------
|
||||
|
||||
musl as a whole is licensed under the following standard MIT license:
|
||||
|
||||
Copyright © 2005-2020 Rich Felker, et al.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
|
||||
License notice for "Faster Unsigned Division by Constants"
|
||||
------------------------------
|
||||
|
||||
Reference implementations of computing and using the "magic number" approach to dividing
|
||||
by constants, including codegen instructions. The unsigned division incorporates the
|
||||
"round down" optimization per ridiculous_fish.
|
||||
|
||||
This is free and unencumbered software. Any copyright is dedicated to the Public Domain.
|
||||
|
||||
|
||||
License notice for mimalloc
|
||||
-----------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2019 Microsoft Corporation, Daan Leijen
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,223 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Bcl.AsyncInterfaces</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1">
|
||||
<summary>Provides the core logic for implementing a manual-reset <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource"/> or <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource`1"/>.</summary>
|
||||
<typeparam name="TResult"></typeparam>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation">
|
||||
<summary>
|
||||
The callback to invoke when the operation completes if <see cref="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)"/> was called before the operation completed,
|
||||
or <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCoreShared.s_sentinel"/> if the operation completed before a callback was supplied,
|
||||
or null if a callback hasn't yet been provided and the operation hasn't yet completed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuationState">
|
||||
<summary>State to pass to <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation"/>.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext">
|
||||
<summary><see cref="T:System.Threading.ExecutionContext"/> to flow to the callback, or null if no flowing is required.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._capturedContext">
|
||||
<summary>
|
||||
A "captured" <see cref="T:System.Threading.SynchronizationContext"/> or <see cref="T:System.Threading.Tasks.TaskScheduler"/> with which to invoke the callback,
|
||||
or null if no special context is required.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._completed">
|
||||
<summary>Whether the current operation has completed.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._result">
|
||||
<summary>The result with which the operation succeeded, or the default value if it hasn't yet completed or failed.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._error">
|
||||
<summary>The exception with which the operation failed, or null if it hasn't yet completed or completed successfully.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._version">
|
||||
<summary>The current version of this value, used to help prevent misuse.</summary>
|
||||
</member>
|
||||
<member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.RunContinuationsAsynchronously">
|
||||
<summary>Gets or sets whether to force continuations to run asynchronously.</summary>
|
||||
<remarks>Continuations may run asynchronously if this is false, but they'll never run synchronously if this is true.</remarks>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Reset">
|
||||
<summary>Resets to prepare for the next operation.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetResult(`0)">
|
||||
<summary>Completes with a successful result.</summary>
|
||||
<param name="result">The result.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetException(System.Exception)">
|
||||
<summary>Complets with an error.</summary>
|
||||
<param name="error"></param>
|
||||
</member>
|
||||
<member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Version">
|
||||
<summary>Gets the operation version.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetStatus(System.Int16)">
|
||||
<summary>Gets the status of the operation.</summary>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetResult(System.Int16)">
|
||||
<summary>Gets the result of the operation.</summary>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)">
|
||||
<summary>Schedules the continuation action for this operation.</summary>
|
||||
<param name="continuation">The continuation to invoke when the operation has completed.</param>
|
||||
<param name="state">The state object to pass to <paramref name="continuation"/> when it's invoked.</param>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
<param name="flags">The flags describing the behavior of the continuation.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.ValidateToken(System.Int16)">
|
||||
<summary>Ensures that the specified token matches the current version.</summary>
|
||||
<param name="token">The token supplied by <see cref="T:System.Threading.Tasks.ValueTask"/>.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SignalCompletion">
|
||||
<summary>Signals that the operation has completed. Invoked after the result or error has been set.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.InvokeContinuation">
|
||||
<summary>
|
||||
Invokes the continuation with the appropriate captured context / scheduler.
|
||||
This assumes that if <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext"/> is not null we're already
|
||||
running within that <see cref="T:System.Threading.ExecutionContext"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Threading.Tasks.TaskAsyncEnumerableExtensions">
|
||||
<summary>Provides a set of static methods for configuring <see cref="T:System.Threading.Tasks.Task"/>-related behaviors on asynchronous enumerables and disposables.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait(System.IAsyncDisposable,System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async disposable will be performed.</summary>
|
||||
<param name="source">The source async disposable.</param>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured async disposable.</returns>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
|
||||
<typeparam name="T">The type of the objects being iterated.</typeparam>
|
||||
<param name="source">The source enumerable being iterated.</param>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.WithCancellation``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Threading.CancellationToken)">
|
||||
<summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
|
||||
<typeparam name="T">The type of the objects being iterated.</typeparam>
|
||||
<param name="source">The source enumerable being iterated.</param>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder">
|
||||
<summary>Represents a builder for asynchronous iterators.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Create">
|
||||
<summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder"/> struct.</summary>
|
||||
<returns>The initialized instance.</returns>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.MoveNext``1(``0@)">
|
||||
<summary>Invokes <see cref="M:System.Runtime.CompilerServices.IAsyncStateMachine.MoveNext"/> on the state machine while guarding the <see cref="T:System.Threading.ExecutionContext"/>.</summary>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="stateMachine">The state machine instance, passed by reference.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitOnCompleted``2(``0@,``1@)">
|
||||
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
|
||||
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="awaiter">The awaiter.</param>
|
||||
<param name="stateMachine">The state machine.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitUnsafeOnCompleted``2(``0@,``1@)">
|
||||
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
|
||||
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="awaiter">The awaiter.</param>
|
||||
<param name="stateMachine">The state machine.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Complete">
|
||||
<summary>Marks iteration as being completed, whether successfully or otherwise.</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.ObjectIdForDebugger">
|
||||
<summary>Gets an object that may be used to uniquely identify this builder to the debugger.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute">
|
||||
<summary>Indicates whether a method is an asynchronous iterator.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute.#ctor(System.Type)">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute"/> class.</summary>
|
||||
<param name="stateMachineType">The type object for the underlying state machine type that's used to implement a state machine method.</param>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredAsyncDisposable">
|
||||
<summary>Provides a type that can be used to configure how awaits on an <see cref="T:System.IAsyncDisposable"/> are performed.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1">
|
||||
<summary>Provides an awaitable async enumerable that enables cancelable iteration and configured awaits.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
<remarks>This will replace any previous value set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)"/> for this iteration.</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)">
|
||||
<summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
<remarks>This will replace any previous <see cref="T:System.Threading.CancellationToken"/> set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)"/> for this iteration.</remarks>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator">
|
||||
<summary>Provides an awaitable async enumerator that enables cancelable iteration and configured awaits.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.MoveNextAsync">
|
||||
<summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
|
||||
<returns>
|
||||
A <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1"/> that will complete with a result of <c>true</c>
|
||||
if the enumerator was successfully advanced to the next element, or <c>false</c> if the enumerator has
|
||||
passed the end of the collection.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.Current">
|
||||
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.DisposeAsync">
|
||||
<summary>
|
||||
Performs application-defined tasks associated with freeing, releasing, or
|
||||
resetting unmanaged resources asynchronously.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Collections.Generic.IAsyncEnumerable`1">
|
||||
<summary>Exposes an enumerator that provides asynchronous iteration over values of a specified type.</summary>
|
||||
<typeparam name="T">The type of values to enumerate.</typeparam>
|
||||
</member>
|
||||
<member name="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)">
|
||||
<summary>Returns an enumerator that iterates asynchronously through the collection.</summary>
|
||||
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that may be used to cancel the asynchronous iteration.</param>
|
||||
<returns>An enumerator that can be used to iterate asynchronously through the collection.</returns>
|
||||
</member>
|
||||
<member name="T:System.Collections.Generic.IAsyncEnumerator`1">
|
||||
<summary>Supports a simple asynchronous iteration over a generic collection.</summary>
|
||||
<typeparam name="T">The type of objects to enumerate.</typeparam>
|
||||
</member>
|
||||
<member name="M:System.Collections.Generic.IAsyncEnumerator`1.MoveNextAsync">
|
||||
<summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
|
||||
<returns>
|
||||
A <see cref="T:System.Threading.Tasks.ValueTask`1"/> that will complete with a result of <c>true</c> if the enumerator
|
||||
was successfully advanced to the next element, or <c>false</c> if the enumerator has passed the end
|
||||
of the collection.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="P:System.Collections.Generic.IAsyncEnumerator`1.Current">
|
||||
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
|
||||
</member>
|
||||
<member name="T:System.IAsyncDisposable">
|
||||
<summary>Provides a mechanism for releasing unmanaged resources asynchronously.</summary>
|
||||
</member>
|
||||
<member name="M:System.IAsyncDisposable.DisposeAsync">
|
||||
<summary>
|
||||
Performs application-defined tasks associated with freeing, releasing, or
|
||||
resetting unmanaged resources asynchronously.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,223 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Bcl.AsyncInterfaces</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1">
|
||||
<summary>Provides the core logic for implementing a manual-reset <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource"/> or <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource`1"/>.</summary>
|
||||
<typeparam name="TResult"></typeparam>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation">
|
||||
<summary>
|
||||
The callback to invoke when the operation completes if <see cref="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)"/> was called before the operation completed,
|
||||
or <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCoreShared.s_sentinel"/> if the operation completed before a callback was supplied,
|
||||
or null if a callback hasn't yet been provided and the operation hasn't yet completed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuationState">
|
||||
<summary>State to pass to <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation"/>.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext">
|
||||
<summary><see cref="T:System.Threading.ExecutionContext"/> to flow to the callback, or null if no flowing is required.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._capturedContext">
|
||||
<summary>
|
||||
A "captured" <see cref="T:System.Threading.SynchronizationContext"/> or <see cref="T:System.Threading.Tasks.TaskScheduler"/> with which to invoke the callback,
|
||||
or null if no special context is required.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._completed">
|
||||
<summary>Whether the current operation has completed.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._result">
|
||||
<summary>The result with which the operation succeeded, or the default value if it hasn't yet completed or failed.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._error">
|
||||
<summary>The exception with which the operation failed, or null if it hasn't yet completed or completed successfully.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._version">
|
||||
<summary>The current version of this value, used to help prevent misuse.</summary>
|
||||
</member>
|
||||
<member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.RunContinuationsAsynchronously">
|
||||
<summary>Gets or sets whether to force continuations to run asynchronously.</summary>
|
||||
<remarks>Continuations may run asynchronously if this is false, but they'll never run synchronously if this is true.</remarks>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Reset">
|
||||
<summary>Resets to prepare for the next operation.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetResult(`0)">
|
||||
<summary>Completes with a successful result.</summary>
|
||||
<param name="result">The result.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetException(System.Exception)">
|
||||
<summary>Complets with an error.</summary>
|
||||
<param name="error"></param>
|
||||
</member>
|
||||
<member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Version">
|
||||
<summary>Gets the operation version.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetStatus(System.Int16)">
|
||||
<summary>Gets the status of the operation.</summary>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetResult(System.Int16)">
|
||||
<summary>Gets the result of the operation.</summary>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)">
|
||||
<summary>Schedules the continuation action for this operation.</summary>
|
||||
<param name="continuation">The continuation to invoke when the operation has completed.</param>
|
||||
<param name="state">The state object to pass to <paramref name="continuation"/> when it's invoked.</param>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
<param name="flags">The flags describing the behavior of the continuation.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.ValidateToken(System.Int16)">
|
||||
<summary>Ensures that the specified token matches the current version.</summary>
|
||||
<param name="token">The token supplied by <see cref="T:System.Threading.Tasks.ValueTask"/>.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SignalCompletion">
|
||||
<summary>Signals that the operation has completed. Invoked after the result or error has been set.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.InvokeContinuation">
|
||||
<summary>
|
||||
Invokes the continuation with the appropriate captured context / scheduler.
|
||||
This assumes that if <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext"/> is not null we're already
|
||||
running within that <see cref="T:System.Threading.ExecutionContext"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Threading.Tasks.TaskAsyncEnumerableExtensions">
|
||||
<summary>Provides a set of static methods for configuring <see cref="T:System.Threading.Tasks.Task"/>-related behaviors on asynchronous enumerables and disposables.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait(System.IAsyncDisposable,System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async disposable will be performed.</summary>
|
||||
<param name="source">The source async disposable.</param>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured async disposable.</returns>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
|
||||
<typeparam name="T">The type of the objects being iterated.</typeparam>
|
||||
<param name="source">The source enumerable being iterated.</param>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.WithCancellation``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Threading.CancellationToken)">
|
||||
<summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
|
||||
<typeparam name="T">The type of the objects being iterated.</typeparam>
|
||||
<param name="source">The source enumerable being iterated.</param>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder">
|
||||
<summary>Represents a builder for asynchronous iterators.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Create">
|
||||
<summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder"/> struct.</summary>
|
||||
<returns>The initialized instance.</returns>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.MoveNext``1(``0@)">
|
||||
<summary>Invokes <see cref="M:System.Runtime.CompilerServices.IAsyncStateMachine.MoveNext"/> on the state machine while guarding the <see cref="T:System.Threading.ExecutionContext"/>.</summary>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="stateMachine">The state machine instance, passed by reference.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitOnCompleted``2(``0@,``1@)">
|
||||
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
|
||||
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="awaiter">The awaiter.</param>
|
||||
<param name="stateMachine">The state machine.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitUnsafeOnCompleted``2(``0@,``1@)">
|
||||
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
|
||||
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="awaiter">The awaiter.</param>
|
||||
<param name="stateMachine">The state machine.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Complete">
|
||||
<summary>Marks iteration as being completed, whether successfully or otherwise.</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.ObjectIdForDebugger">
|
||||
<summary>Gets an object that may be used to uniquely identify this builder to the debugger.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute">
|
||||
<summary>Indicates whether a method is an asynchronous iterator.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute.#ctor(System.Type)">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute"/> class.</summary>
|
||||
<param name="stateMachineType">The type object for the underlying state machine type that's used to implement a state machine method.</param>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredAsyncDisposable">
|
||||
<summary>Provides a type that can be used to configure how awaits on an <see cref="T:System.IAsyncDisposable"/> are performed.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1">
|
||||
<summary>Provides an awaitable async enumerable that enables cancelable iteration and configured awaits.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
<remarks>This will replace any previous value set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)"/> for this iteration.</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)">
|
||||
<summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
<remarks>This will replace any previous <see cref="T:System.Threading.CancellationToken"/> set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)"/> for this iteration.</remarks>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator">
|
||||
<summary>Provides an awaitable async enumerator that enables cancelable iteration and configured awaits.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.MoveNextAsync">
|
||||
<summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
|
||||
<returns>
|
||||
A <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1"/> that will complete with a result of <c>true</c>
|
||||
if the enumerator was successfully advanced to the next element, or <c>false</c> if the enumerator has
|
||||
passed the end of the collection.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.Current">
|
||||
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.DisposeAsync">
|
||||
<summary>
|
||||
Performs application-defined tasks associated with freeing, releasing, or
|
||||
resetting unmanaged resources asynchronously.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Collections.Generic.IAsyncEnumerable`1">
|
||||
<summary>Exposes an enumerator that provides asynchronous iteration over values of a specified type.</summary>
|
||||
<typeparam name="T">The type of values to enumerate.</typeparam>
|
||||
</member>
|
||||
<member name="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)">
|
||||
<summary>Returns an enumerator that iterates asynchronously through the collection.</summary>
|
||||
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that may be used to cancel the asynchronous iteration.</param>
|
||||
<returns>An enumerator that can be used to iterate asynchronously through the collection.</returns>
|
||||
</member>
|
||||
<member name="T:System.Collections.Generic.IAsyncEnumerator`1">
|
||||
<summary>Supports a simple asynchronous iteration over a generic collection.</summary>
|
||||
<typeparam name="T">The type of objects to enumerate.</typeparam>
|
||||
</member>
|
||||
<member name="M:System.Collections.Generic.IAsyncEnumerator`1.MoveNextAsync">
|
||||
<summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
|
||||
<returns>
|
||||
A <see cref="T:System.Threading.Tasks.ValueTask`1"/> that will complete with a result of <c>true</c> if the enumerator
|
||||
was successfully advanced to the next element, or <c>false</c> if the enumerator has passed the end
|
||||
of the collection.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="P:System.Collections.Generic.IAsyncEnumerator`1.Current">
|
||||
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
|
||||
</member>
|
||||
<member name="T:System.IAsyncDisposable">
|
||||
<summary>Provides a mechanism for releasing unmanaged resources asynchronously.</summary>
|
||||
</member>
|
||||
<member name="M:System.IAsyncDisposable.DisposeAsync">
|
||||
<summary>
|
||||
Performs application-defined tasks associated with freeing, releasing, or
|
||||
resetting unmanaged resources asynchronously.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,8 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Bcl.AsyncInterfaces</name>
|
||||
</assembly>
|
||||
<members>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
IhoFoMkQ96h7Yg2PODHtOStOuV0RK+4nTTXycAmtKiZEXenXzSNf5vtKA/JVCHS9o7493dlu2vnAhSqcI9ewmQ==
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "3WA9q9yVqJp222P3x1wYIGDAkpjAku0TMUaaQV22g6L67AI0LdOIrVS7Ht2vJfLHGSPVuqN94vIr15qn+HEkHw==",
|
||||
"source": "/mnt/e/dev/git.stella-ops.org/local-nugets"
|
||||
}
|
||||
BIN
local-nugets/microsoft.bcl.asyncinterfaces/8.0.0/.signature.p7s
Normal file
BIN
local-nugets/microsoft.bcl.asyncinterfaces/8.0.0/.signature.p7s
Normal file
Binary file not shown.
BIN
local-nugets/microsoft.bcl.asyncinterfaces/8.0.0/Icon.png
Normal file
BIN
local-nugets/microsoft.bcl.asyncinterfaces/8.0.0/Icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.8 KiB |
23
local-nugets/microsoft.bcl.asyncinterfaces/8.0.0/LICENSE.TXT
Normal file
23
local-nugets/microsoft.bcl.asyncinterfaces/8.0.0/LICENSE.TXT
Normal file
@@ -0,0 +1,23 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) .NET Foundation and Contributors
|
||||
|
||||
All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,32 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Bcl.AsyncInterfaces</id>
|
||||
<version>8.0.0</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 the IAsyncEnumerable<T> and IAsyncDisposable interfaces and helper types for .NET Standard 2.0. This package is not required starting with .NET Standard 2.1 and .NET Core 3.0.
|
||||
|
||||
Commonly Used Types:
|
||||
System.IAsyncDisposable
|
||||
System.Collections.Generic.IAsyncEnumerable
|
||||
System.Collections.Generic.IAsyncEnumerator</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/runtime" commit="5535e31a712343a63f5d7d796cd874e563e5ac14" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.6.2">
|
||||
<dependency id="System.Threading.Tasks.Extensions" version="4.5.4" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="System.Threading.Tasks.Extensions" version="4.5.4" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.1" />
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
64
local-nugets/microsoft.bcl.asyncinterfaces/8.0.0/PACKAGE.md
Normal file
64
local-nugets/microsoft.bcl.asyncinterfaces/8.0.0/PACKAGE.md
Normal file
@@ -0,0 +1,64 @@
|
||||
## About
|
||||
|
||||
As of C# 8, the C# language has support for producing and consuming asynchronous iterators. The library types in support of those features are available in .NET Core 3.0 and newer as well as in .NET Standard 2.1. This library provides the necessary definitions of those types to support these language features on .NET Framework and on .NET Standard 2.0. This library is not necessary nor recommended when targeting versions of .NET that include the relevant support.
|
||||
|
||||
## Key Features
|
||||
|
||||
<!-- The key features of this package -->
|
||||
|
||||
* Enables the use of C# async iterators on older .NET platforms
|
||||
|
||||
## 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 -->
|
||||
|
||||
```C#
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Threading.Tasks;
|
||||
|
||||
internal static class Program
|
||||
{
|
||||
private static async Task Main()
|
||||
{
|
||||
Console.WriteLine("Starting...");
|
||||
await foreach (var value in GetValuesAsync())
|
||||
{
|
||||
Console.WriteLine(value);
|
||||
}
|
||||
Console.WriteLine("Finished!");
|
||||
|
||||
static async IAsyncEnumerable<int> GetValuesAsync()
|
||||
{
|
||||
for (int i = 0; i < 10; i++)
|
||||
{
|
||||
await Task.Delay(TimeSpan.FromSeconds(1));
|
||||
yield return i;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Main Types
|
||||
|
||||
<!-- The main types provided in this library -->
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `IAsyncEnumerable<T>`
|
||||
* `IAsyncEnumerator<T>`
|
||||
* `IAsyncDisposable<T>`
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
|
||||
|
||||
* [C# Feature Specification](https://learn.microsoft.com/dotnet/csharp/language-reference/proposals/csharp-8.0/async-streams)
|
||||
* [Walkthrough article](https://learn.microsoft.com/archive/msdn-magazine/2019/november/csharp-iterating-with-async-enumerables-in-csharp-8)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
<!-- How to provide feedback on this package and contribute to it -->
|
||||
|
||||
Microsoft.Bcl.AsyncInterfaces is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Bcl_AsyncInterfaces_net462">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Bcl_AsyncInterfaces_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Bcl.AsyncInterfaces 8.0.0 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net462 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,417 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Bcl.AsyncInterfaces</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1">
|
||||
<summary>Provides the core logic for implementing a manual-reset <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource"/> or <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource`1"/>.</summary>
|
||||
<typeparam name="TResult"></typeparam>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation">
|
||||
<summary>
|
||||
The callback to invoke when the operation completes if <see cref="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)"/> was called before the operation completed,
|
||||
or <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCoreShared.s_sentinel"/> if the operation completed before a callback was supplied,
|
||||
or null if a callback hasn't yet been provided and the operation hasn't yet completed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuationState">
|
||||
<summary>State to pass to <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation"/>.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext">
|
||||
<summary><see cref="T:System.Threading.ExecutionContext"/> to flow to the callback, or null if no flowing is required.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._capturedContext">
|
||||
<summary>
|
||||
A "captured" <see cref="T:System.Threading.SynchronizationContext"/> or <see cref="T:System.Threading.Tasks.TaskScheduler"/> with which to invoke the callback,
|
||||
or null if no special context is required.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._completed">
|
||||
<summary>Whether the current operation has completed.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._result">
|
||||
<summary>The result with which the operation succeeded, or the default value if it hasn't yet completed or failed.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._error">
|
||||
<summary>The exception with which the operation failed, or null if it hasn't yet completed or completed successfully.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._version">
|
||||
<summary>The current version of this value, used to help prevent misuse.</summary>
|
||||
</member>
|
||||
<member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.RunContinuationsAsynchronously">
|
||||
<summary>Gets or sets whether to force continuations to run asynchronously.</summary>
|
||||
<remarks>Continuations may run asynchronously if this is false, but they'll never run synchronously if this is true.</remarks>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Reset">
|
||||
<summary>Resets to prepare for the next operation.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetResult(`0)">
|
||||
<summary>Completes with a successful result.</summary>
|
||||
<param name="result">The result.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetException(System.Exception)">
|
||||
<summary>Complets with an error.</summary>
|
||||
<param name="error"></param>
|
||||
</member>
|
||||
<member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Version">
|
||||
<summary>Gets the operation version.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetStatus(System.Int16)">
|
||||
<summary>Gets the status of the operation.</summary>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetResult(System.Int16)">
|
||||
<summary>Gets the result of the operation.</summary>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)">
|
||||
<summary>Schedules the continuation action for this operation.</summary>
|
||||
<param name="continuation">The continuation to invoke when the operation has completed.</param>
|
||||
<param name="state">The state object to pass to <paramref name="continuation"/> when it's invoked.</param>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
<param name="flags">The flags describing the behavior of the continuation.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.ValidateToken(System.Int16)">
|
||||
<summary>Ensures that the specified token matches the current version.</summary>
|
||||
<param name="token">The token supplied by <see cref="T:System.Threading.Tasks.ValueTask"/>.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SignalCompletion">
|
||||
<summary>Signals that the operation has completed. Invoked after the result or error has been set.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.InvokeContinuation">
|
||||
<summary>
|
||||
Invokes the continuation with the appropriate captured context / scheduler.
|
||||
This assumes that if <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext"/> is not null we're already
|
||||
running within that <see cref="T:System.Threading.ExecutionContext"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Threading.Tasks.TaskAsyncEnumerableExtensions">
|
||||
<summary>Provides a set of static methods for configuring <see cref="T:System.Threading.Tasks.Task"/>-related behaviors on asynchronous enumerables and disposables.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait(System.IAsyncDisposable,System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async disposable will be performed.</summary>
|
||||
<param name="source">The source async disposable.</param>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured async disposable.</returns>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
|
||||
<typeparam name="T">The type of the objects being iterated.</typeparam>
|
||||
<param name="source">The source enumerable being iterated.</param>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.WithCancellation``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Threading.CancellationToken)">
|
||||
<summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
|
||||
<typeparam name="T">The type of the objects being iterated.</typeparam>
|
||||
<param name="source">The source enumerable being iterated.</param>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder">
|
||||
<summary>Represents a builder for asynchronous iterators.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Create">
|
||||
<summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder"/> struct.</summary>
|
||||
<returns>The initialized instance.</returns>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.MoveNext``1(``0@)">
|
||||
<summary>Invokes <see cref="M:System.Runtime.CompilerServices.IAsyncStateMachine.MoveNext"/> on the state machine while guarding the <see cref="T:System.Threading.ExecutionContext"/>.</summary>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="stateMachine">The state machine instance, passed by reference.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitOnCompleted``2(``0@,``1@)">
|
||||
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
|
||||
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="awaiter">The awaiter.</param>
|
||||
<param name="stateMachine">The state machine.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitUnsafeOnCompleted``2(``0@,``1@)">
|
||||
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
|
||||
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="awaiter">The awaiter.</param>
|
||||
<param name="stateMachine">The state machine.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Complete">
|
||||
<summary>Marks iteration as being completed, whether successfully or otherwise.</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.ObjectIdForDebugger">
|
||||
<summary>Gets an object that may be used to uniquely identify this builder to the debugger.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute">
|
||||
<summary>Indicates whether a method is an asynchronous iterator.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute.#ctor(System.Type)">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute"/> class.</summary>
|
||||
<param name="stateMachineType">The type object for the underlying state machine type that's used to implement a state machine method.</param>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredAsyncDisposable">
|
||||
<summary>Provides a type that can be used to configure how awaits on an <see cref="T:System.IAsyncDisposable"/> are performed.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredAsyncDisposable.DisposeAsync">
|
||||
<summary>Asynchronously releases the unmanaged resources used by the <see cref="T:System.Runtime.CompilerServices.ConfiguredAsyncDisposable" />.</summary>
|
||||
<returns>A task that represents the asynchronous dispose operation.</returns>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1">
|
||||
<summary>Provides an awaitable async enumerable that enables cancelable iteration and configured awaits.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
<remarks>This will replace any previous value set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)"/> for this iteration.</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)">
|
||||
<summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
<remarks>This will replace any previous <see cref="T:System.Threading.CancellationToken"/> set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)"/> for this iteration.</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.GetAsyncEnumerator">
|
||||
<summary>Returns an enumerator that iterates asynchronously through collections that enables cancelable iteration and configured awaits.</summary>
|
||||
<returns>An enumerator for the <see cref="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1" /> class.</returns>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator">
|
||||
<summary>Provides an awaitable async enumerator that enables cancelable iteration and configured awaits.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.MoveNextAsync">
|
||||
<summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
|
||||
<returns>
|
||||
A <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1"/> that will complete with a result of <c>true</c>
|
||||
if the enumerator was successfully advanced to the next element, or <c>false</c> if the enumerator has
|
||||
passed the end of the collection.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.Current">
|
||||
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.DisposeAsync">
|
||||
<summary>
|
||||
Performs application-defined tasks associated with freeing, releasing, or
|
||||
resetting unmanaged resources asynchronously.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.EnumeratorCancellationAttribute">
|
||||
<summary>Allows users of async-enumerable methods to mark the parameter that should receive the cancellation token value from <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.EnumeratorCancellationAttribute.#ctor">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.EnumeratorCancellationAttribute" /> class.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is suppling 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.Collections.Generic.IAsyncEnumerable`1">
|
||||
<summary>Exposes an enumerator that provides asynchronous iteration over values of a specified type.</summary>
|
||||
<typeparam name="T">The type of values to enumerate.</typeparam>
|
||||
</member>
|
||||
<member name="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)">
|
||||
<summary>Returns an enumerator that iterates asynchronously through the collection.</summary>
|
||||
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that may be used to cancel the asynchronous iteration.</param>
|
||||
<returns>An enumerator that can be used to iterate asynchronously through the collection.</returns>
|
||||
</member>
|
||||
<member name="T:System.Collections.Generic.IAsyncEnumerator`1">
|
||||
<summary>Supports a simple asynchronous iteration over a generic collection.</summary>
|
||||
<typeparam name="T">The type of objects to enumerate.</typeparam>
|
||||
</member>
|
||||
<member name="M:System.Collections.Generic.IAsyncEnumerator`1.MoveNextAsync">
|
||||
<summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
|
||||
<returns>
|
||||
A <see cref="T:System.Threading.Tasks.ValueTask`1"/> that will complete with a result of <c>true</c> if the enumerator
|
||||
was successfully advanced to the next element, or <c>false</c> if the enumerator has passed the end
|
||||
of the collection.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="P:System.Collections.Generic.IAsyncEnumerator`1.Current">
|
||||
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
|
||||
</member>
|
||||
<member name="T:System.IAsyncDisposable">
|
||||
<summary>Provides a mechanism for releasing unmanaged resources asynchronously.</summary>
|
||||
</member>
|
||||
<member name="M:System.IAsyncDisposable.DisposeAsync">
|
||||
<summary>
|
||||
Performs application-defined tasks associated with freeing, releasing, or
|
||||
resetting unmanaged resources asynchronously.
|
||||
</summary>
|
||||
</member>
|
||||
<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 parameter 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 parameter 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>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,417 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Bcl.AsyncInterfaces</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1">
|
||||
<summary>Provides the core logic for implementing a manual-reset <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource"/> or <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource`1"/>.</summary>
|
||||
<typeparam name="TResult"></typeparam>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation">
|
||||
<summary>
|
||||
The callback to invoke when the operation completes if <see cref="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)"/> was called before the operation completed,
|
||||
or <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCoreShared.s_sentinel"/> if the operation completed before a callback was supplied,
|
||||
or null if a callback hasn't yet been provided and the operation hasn't yet completed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuationState">
|
||||
<summary>State to pass to <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation"/>.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext">
|
||||
<summary><see cref="T:System.Threading.ExecutionContext"/> to flow to the callback, or null if no flowing is required.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._capturedContext">
|
||||
<summary>
|
||||
A "captured" <see cref="T:System.Threading.SynchronizationContext"/> or <see cref="T:System.Threading.Tasks.TaskScheduler"/> with which to invoke the callback,
|
||||
or null if no special context is required.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._completed">
|
||||
<summary>Whether the current operation has completed.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._result">
|
||||
<summary>The result with which the operation succeeded, or the default value if it hasn't yet completed or failed.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._error">
|
||||
<summary>The exception with which the operation failed, or null if it hasn't yet completed or completed successfully.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._version">
|
||||
<summary>The current version of this value, used to help prevent misuse.</summary>
|
||||
</member>
|
||||
<member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.RunContinuationsAsynchronously">
|
||||
<summary>Gets or sets whether to force continuations to run asynchronously.</summary>
|
||||
<remarks>Continuations may run asynchronously if this is false, but they'll never run synchronously if this is true.</remarks>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Reset">
|
||||
<summary>Resets to prepare for the next operation.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetResult(`0)">
|
||||
<summary>Completes with a successful result.</summary>
|
||||
<param name="result">The result.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetException(System.Exception)">
|
||||
<summary>Complets with an error.</summary>
|
||||
<param name="error"></param>
|
||||
</member>
|
||||
<member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Version">
|
||||
<summary>Gets the operation version.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetStatus(System.Int16)">
|
||||
<summary>Gets the status of the operation.</summary>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetResult(System.Int16)">
|
||||
<summary>Gets the result of the operation.</summary>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)">
|
||||
<summary>Schedules the continuation action for this operation.</summary>
|
||||
<param name="continuation">The continuation to invoke when the operation has completed.</param>
|
||||
<param name="state">The state object to pass to <paramref name="continuation"/> when it's invoked.</param>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
<param name="flags">The flags describing the behavior of the continuation.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.ValidateToken(System.Int16)">
|
||||
<summary>Ensures that the specified token matches the current version.</summary>
|
||||
<param name="token">The token supplied by <see cref="T:System.Threading.Tasks.ValueTask"/>.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SignalCompletion">
|
||||
<summary>Signals that the operation has completed. Invoked after the result or error has been set.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.InvokeContinuation">
|
||||
<summary>
|
||||
Invokes the continuation with the appropriate captured context / scheduler.
|
||||
This assumes that if <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext"/> is not null we're already
|
||||
running within that <see cref="T:System.Threading.ExecutionContext"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Threading.Tasks.TaskAsyncEnumerableExtensions">
|
||||
<summary>Provides a set of static methods for configuring <see cref="T:System.Threading.Tasks.Task"/>-related behaviors on asynchronous enumerables and disposables.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait(System.IAsyncDisposable,System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async disposable will be performed.</summary>
|
||||
<param name="source">The source async disposable.</param>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured async disposable.</returns>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
|
||||
<typeparam name="T">The type of the objects being iterated.</typeparam>
|
||||
<param name="source">The source enumerable being iterated.</param>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.WithCancellation``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Threading.CancellationToken)">
|
||||
<summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
|
||||
<typeparam name="T">The type of the objects being iterated.</typeparam>
|
||||
<param name="source">The source enumerable being iterated.</param>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder">
|
||||
<summary>Represents a builder for asynchronous iterators.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Create">
|
||||
<summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder"/> struct.</summary>
|
||||
<returns>The initialized instance.</returns>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.MoveNext``1(``0@)">
|
||||
<summary>Invokes <see cref="M:System.Runtime.CompilerServices.IAsyncStateMachine.MoveNext"/> on the state machine while guarding the <see cref="T:System.Threading.ExecutionContext"/>.</summary>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="stateMachine">The state machine instance, passed by reference.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitOnCompleted``2(``0@,``1@)">
|
||||
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
|
||||
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="awaiter">The awaiter.</param>
|
||||
<param name="stateMachine">The state machine.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitUnsafeOnCompleted``2(``0@,``1@)">
|
||||
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
|
||||
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="awaiter">The awaiter.</param>
|
||||
<param name="stateMachine">The state machine.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Complete">
|
||||
<summary>Marks iteration as being completed, whether successfully or otherwise.</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.ObjectIdForDebugger">
|
||||
<summary>Gets an object that may be used to uniquely identify this builder to the debugger.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute">
|
||||
<summary>Indicates whether a method is an asynchronous iterator.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute.#ctor(System.Type)">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute"/> class.</summary>
|
||||
<param name="stateMachineType">The type object for the underlying state machine type that's used to implement a state machine method.</param>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredAsyncDisposable">
|
||||
<summary>Provides a type that can be used to configure how awaits on an <see cref="T:System.IAsyncDisposable"/> are performed.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredAsyncDisposable.DisposeAsync">
|
||||
<summary>Asynchronously releases the unmanaged resources used by the <see cref="T:System.Runtime.CompilerServices.ConfiguredAsyncDisposable" />.</summary>
|
||||
<returns>A task that represents the asynchronous dispose operation.</returns>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1">
|
||||
<summary>Provides an awaitable async enumerable that enables cancelable iteration and configured awaits.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
<remarks>This will replace any previous value set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)"/> for this iteration.</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)">
|
||||
<summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
<remarks>This will replace any previous <see cref="T:System.Threading.CancellationToken"/> set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)"/> for this iteration.</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.GetAsyncEnumerator">
|
||||
<summary>Returns an enumerator that iterates asynchronously through collections that enables cancelable iteration and configured awaits.</summary>
|
||||
<returns>An enumerator for the <see cref="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1" /> class.</returns>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator">
|
||||
<summary>Provides an awaitable async enumerator that enables cancelable iteration and configured awaits.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.MoveNextAsync">
|
||||
<summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
|
||||
<returns>
|
||||
A <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1"/> that will complete with a result of <c>true</c>
|
||||
if the enumerator was successfully advanced to the next element, or <c>false</c> if the enumerator has
|
||||
passed the end of the collection.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.Current">
|
||||
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.DisposeAsync">
|
||||
<summary>
|
||||
Performs application-defined tasks associated with freeing, releasing, or
|
||||
resetting unmanaged resources asynchronously.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.EnumeratorCancellationAttribute">
|
||||
<summary>Allows users of async-enumerable methods to mark the parameter that should receive the cancellation token value from <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.EnumeratorCancellationAttribute.#ctor">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.EnumeratorCancellationAttribute" /> class.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is suppling 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.Collections.Generic.IAsyncEnumerable`1">
|
||||
<summary>Exposes an enumerator that provides asynchronous iteration over values of a specified type.</summary>
|
||||
<typeparam name="T">The type of values to enumerate.</typeparam>
|
||||
</member>
|
||||
<member name="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)">
|
||||
<summary>Returns an enumerator that iterates asynchronously through the collection.</summary>
|
||||
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that may be used to cancel the asynchronous iteration.</param>
|
||||
<returns>An enumerator that can be used to iterate asynchronously through the collection.</returns>
|
||||
</member>
|
||||
<member name="T:System.Collections.Generic.IAsyncEnumerator`1">
|
||||
<summary>Supports a simple asynchronous iteration over a generic collection.</summary>
|
||||
<typeparam name="T">The type of objects to enumerate.</typeparam>
|
||||
</member>
|
||||
<member name="M:System.Collections.Generic.IAsyncEnumerator`1.MoveNextAsync">
|
||||
<summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
|
||||
<returns>
|
||||
A <see cref="T:System.Threading.Tasks.ValueTask`1"/> that will complete with a result of <c>true</c> if the enumerator
|
||||
was successfully advanced to the next element, or <c>false</c> if the enumerator has passed the end
|
||||
of the collection.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="P:System.Collections.Generic.IAsyncEnumerator`1.Current">
|
||||
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
|
||||
</member>
|
||||
<member name="T:System.IAsyncDisposable">
|
||||
<summary>Provides a mechanism for releasing unmanaged resources asynchronously.</summary>
|
||||
</member>
|
||||
<member name="M:System.IAsyncDisposable.DisposeAsync">
|
||||
<summary>
|
||||
Performs application-defined tasks associated with freeing, releasing, or
|
||||
resetting unmanaged resources asynchronously.
|
||||
</summary>
|
||||
</member>
|
||||
<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 parameter 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 parameter 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>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,124 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Bcl.AsyncInterfaces</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<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 suppling 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.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 parameter 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 parameter 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>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
ecsHc9lEZZJM7k5HHZA1PV2N+ELEarLFcssV2bn7XQIJoaiNZDkplTNcX+VKANfDGURAuEyVFCcRu7aFy16VUg==
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "aA6/V6lw1Gueyb1PqhHAl/i/qUUuv+Fusfk4oaMOzzOjspBkYtPpNHCmml/0t1x0/DnZoed+u2WwpP+mSwd8Dg==",
|
||||
"source": "/mnt/e/dev/git.stella-ops.org/local-nugets"
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@@ -0,0 +1,40 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Configuration.Binder</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 the functionality to bind an object to data in configuration providers for Microsoft.Extensions.Configuration. This package enables you to represent the configuration data as strongly-typed classes defined in the application code. To bind a configuration, use the Microsoft.Extensions.Configuration.ConfigurationBinder.Get extension method on the IConfiguration object. To use this package, you also need to install a package for the configuration provider, for example, Microsoft.Extensions.Configuration.Json for the JSON provider.</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.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Configuration" version="10.0.0-rc.2.25502.107" 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.Configuration" 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.Configuration" 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.Configuration" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Configuration" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
@@ -0,0 +1,138 @@
|
||||
## About
|
||||
|
||||
<!-- A description of the package and where one can find more documentation -->
|
||||
|
||||
Provides the functionality to bind an object to data in configuration providers for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to represent the configuration data as strongly-typed classes defined in the application code. To bind a configuration, use the [Microsoft.Extensions.Configuration.ConfigurationBinder.Get](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.configurationbinder.get) extension method on the `IConfiguration` object. To use this package, you also need to install a package for the [configuration provider](https://learn.microsoft.com/dotnet/core/extensions/configuration#configuration-providers), for example, [Microsoft.Extensions.Configuration.Json](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.Json/) for the JSON provider.
|
||||
|
||||
The types contained in this assembly use Reflection at runtime which is not friendly with linking or AOT. To better support linking and AOT as well as provide more efficient strongly-typed binding methods - this package also provides a source generator. This generator is enabled by default when a project sets `PublishAot` but can also be enabled using `<EnableConfigurationBindingGenerator>true</EnableConfigurationBindingGenerator>`.
|
||||
|
||||
## Key Features
|
||||
|
||||
<!-- The key features of this package -->
|
||||
|
||||
* Configuring existing type instances from a configuration section (Bind)
|
||||
* Constructing new configured type instances from a configuration section (Get & GetValue)
|
||||
* Generating source to bind objects from a configuration section without a runtime reflection dependency.
|
||||
|
||||
## 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 following example shows how to bind a JSON configuration section to .NET objects.
|
||||
|
||||
```cs
|
||||
using System;
|
||||
using Microsoft.Extensions.Configuration;
|
||||
|
||||
class Settings
|
||||
{
|
||||
public string Server { get; set; }
|
||||
public string Database { get; set; }
|
||||
public Endpoint[] Endpoints { get; set; }
|
||||
}
|
||||
|
||||
class Endpoint
|
||||
{
|
||||
public string IPAddress { get; set; }
|
||||
public int Port { get; set; }
|
||||
}
|
||||
|
||||
class Program
|
||||
{
|
||||
static void Main()
|
||||
{
|
||||
// Build a configuration object from JSON file
|
||||
IConfiguration config = new ConfigurationBuilder()
|
||||
.AddJsonFile("appsettings.json")
|
||||
.Build();
|
||||
|
||||
// Bind a configuration section to an instance of Settings class
|
||||
Settings settings = config.GetSection("Settings").Get<Settings>();
|
||||
|
||||
// Read simple values
|
||||
Console.WriteLine($"Server: {settings.Server}");
|
||||
Console.WriteLine($"Database: {settings.Database}");
|
||||
|
||||
// Read nested objects
|
||||
Console.WriteLine("Endpoints: ");
|
||||
|
||||
foreach (Endpoint endpoint in settings.Endpoints)
|
||||
{
|
||||
Console.WriteLine($"{endpoint.IPAddress}:{endpoint.Port}");
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
To run this example, include an `appsettings.json` file with the following content in your project:
|
||||
|
||||
```json
|
||||
{
|
||||
"Settings": {
|
||||
"Server": "example.com",
|
||||
"Database": "Northwind",
|
||||
"Endpoints": [
|
||||
{
|
||||
"IPAddress": "192.168.0.1",
|
||||
"Port": "80"
|
||||
},
|
||||
{
|
||||
"IPAddress": "192.168.10.1",
|
||||
"Port": "8080"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
You can include a configuration file using a code like this in your `.csproj` file:
|
||||
|
||||
```xml
|
||||
<ItemGroup>
|
||||
<Content Include="appsettings.json">
|
||||
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
|
||||
</Content>
|
||||
</ItemGroup>
|
||||
```
|
||||
|
||||
You can add the following property to enable the source generator. This requires a .NET 8.0 SDK or later.
|
||||
```xml
|
||||
<PropertyGroup>
|
||||
<EnableConfigurationBindingGenerator>true</EnableConfigurationBindingGenerator>
|
||||
</PropertyGroup>
|
||||
```
|
||||
|
||||
## Main Types
|
||||
|
||||
<!-- The main types provided in this library -->
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `Microsoft.Extensions.Configuration.ConfigurationBinder`
|
||||
* `Microsoft.Extensions.Configuration.BinderOptions`
|
||||
|
||||
## 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.Abstractions](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.Abstractions)
|
||||
* [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.Configuration.Binder is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,31 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Configuration_Binder">
|
||||
<PropertyGroup Condition="'$(EnableConfigurationBindingGenerator)' == 'true'">
|
||||
<!-- The configuration binding source generator uses a preview version of the compiler interceptors feature. Enable it implicitly when the generator is enabled. -->
|
||||
<InterceptorsPreviewNamespaces>$(InterceptorsPreviewNamespaces);Microsoft.Extensions.Configuration.Binder.SourceGeneration</InterceptorsPreviewNamespaces>
|
||||
</PropertyGroup>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_Configuration_Binder_RemoveAnalyzer"
|
||||
Condition="'$(EnableConfigurationBindingGenerator)' != 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets">
|
||||
|
||||
<ItemGroup>
|
||||
<Analyzer Remove="@(Analyzer->WithMetadataValue('NuGetPackageId', 'Microsoft.Extensions.Configuration.Binder'))" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Configuration_Binder"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<PropertyGroup>
|
||||
<_Microsoft_Extensions_Configuration_Binder_Compatible_TargetFramework
|
||||
Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'netcoreapp2.0')) AND
|
||||
!$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net8.0'))"
|
||||
>net8.0</_Microsoft_Extensions_Configuration_Binder_Compatible_TargetFramework>
|
||||
<_Microsoft_Extensions_Configuration_Binder_Compatible_TargetFramework
|
||||
Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net461')) AND
|
||||
!$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net462'))"
|
||||
>net462</_Microsoft_Extensions_Configuration_Binder_Compatible_TargetFramework>
|
||||
</PropertyGroup>
|
||||
<Warning Condition="'$(_Microsoft_Extensions_Configuration_Binder_Compatible_TargetFramework)' != ''"
|
||||
Text="Microsoft.Extensions.Configuration.Binder doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to $(_Microsoft_Extensions_Configuration_Binder_Compatible_TargetFramework) or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,202 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Binder</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.BinderOptions">
|
||||
<summary>
|
||||
Specifies options used by the <see cref="T:Microsoft.Extensions.Configuration.ConfigurationBinder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.BindNonPublicProperties">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether the binder attempts to set all properties or only public properties.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true" /> if the binder attempts to set all non-read-only properties; <see langword="false" /> if only public properties are set.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.ErrorOnUnknownConfiguration">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether exceptions are thrown when converting a value or when a configuration
|
||||
key is found for which the provided model object doesn't have an appropriate property that matches the key's name.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true" /> if an <see cref="T:System.InvalidOperationException"/> is thrown with a description; <see langword="false" /> if no exceptions are thrown. The default is <see langword="false" />.
|
||||
</value>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationBinder">
|
||||
<summary>
|
||||
Static helper class that allows binding strongly typed objects to configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="key">The key of the configuration section to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String,``0)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String,System.Object)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.ResetPropertyValue(System.Reflection.PropertyInfo,System.Object,Microsoft.Extensions.Configuration.BinderOptions)">
|
||||
<summary>
|
||||
Reset the property value to the value from the property getter. This is useful for properties that have a getter or setters that perform some logic changing the object state.
|
||||
</summary>
|
||||
<param name="property">The property to reset.</param>
|
||||
<param name="instance">The instance to reset the property on.</param>
|
||||
<param name="options">The binder options.</param>
|
||||
<remarks>
|
||||
This method doesn't do any configuration binding. It just resets the property value to the value from the property getter.
|
||||
This method called only when creating an instance using a primary constructor with parameters names match properties names.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.CreateInstance(System.Type,Microsoft.Extensions.Configuration.IConfiguration,Microsoft.Extensions.Configuration.BinderOptions,System.Reflection.ParameterInfo[]@)">
|
||||
<summary>
|
||||
Create an instance of the specified type.
|
||||
</summary>
|
||||
<param name="type">The type to create an instance of.</param>
|
||||
<param name="config">The configuration to bind to the instance.</param>
|
||||
<param name="options">The binder options.</param>
|
||||
<param name="constructorParameters">The parameters of the constructor used to create the instance.</param>
|
||||
<returns>The created instance.</returns>
|
||||
<exception cref="T:System.InvalidOperationException">If the type cannot be created.</exception>
|
||||
<remarks>
|
||||
constructorParameters will not be null only when using a constructor with a parameters which get their values from the configuration
|
||||
This happen when using types having properties match the constructor parameter names. `record` types are an example.
|
||||
In such cases we need to carry the parameters list to avoid binding the properties again during BindProperties.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotActivateAbstractOrInterface">
|
||||
<summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotBindToConstructorParameter">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters cannot be declared as in, out, or ref. Invalid parameters are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ConstructorParametersDoNotMatchProperties">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters must have corresponding properties. Fields are not supported. Missing properties are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedBinding">
|
||||
<summary>Failed to convert configuration value '{0}' at '{1}' to type '{2}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedToActivate">
|
||||
<summary>Failed to create instance of type '{0}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_GeneralErrorWhenBinding">
|
||||
<summary>'{0}' was set and binding has failed. The likely cause is an invalid configuration value.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingConfig">
|
||||
<summary>'{0}' was set on the provided {1}, but the following properties were not found on the instance of {2}: {3}</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingPublicInstanceConstructor">
|
||||
<summary>Cannot create instance of type '{0}' because it is missing a public instance constructor.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MultipleParameterizedConstructors">
|
||||
<summary>Cannot create instance of type '{0}' because it has multiple public parameterized constructors.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterBeingBoundToIsUnnamed">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters are unnamed.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterHasNoMatchingConfig">
|
||||
<summary>Cannot create instance of type '{0}' because parameter '{1}' has no matching config. Each parameter in the constructor that does not have a default value must have a corresponding config entry.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_UnsupportedMultidimensionalArray">
|
||||
<summary>Cannot create instance of type '{0}' because multidimensional arrays are not supported.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,739 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Binder</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.BinderOptions">
|
||||
<summary>
|
||||
Specifies options used by the <see cref="T:Microsoft.Extensions.Configuration.ConfigurationBinder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.BindNonPublicProperties">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether the binder attempts to set all properties or only public properties.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true" /> if the binder attempts to set all non-read-only properties; <see langword="false" /> if only public properties are set.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.ErrorOnUnknownConfiguration">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether exceptions are thrown when converting a value or when a configuration
|
||||
key is found for which the provided model object doesn't have an appropriate property that matches the key's name.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true" /> if an <see cref="T:System.InvalidOperationException"/> is thrown with a description; <see langword="false" /> if no exceptions are thrown. The default is <see langword="false" />.
|
||||
</value>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationBinder">
|
||||
<summary>
|
||||
Static helper class that allows binding strongly typed objects to configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="key">The key of the configuration section to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String,``0)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String,System.Object)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.ResetPropertyValue(System.Reflection.PropertyInfo,System.Object,Microsoft.Extensions.Configuration.BinderOptions)">
|
||||
<summary>
|
||||
Reset the property value to the value from the property getter. This is useful for properties that have a getter or setters that perform some logic changing the object state.
|
||||
</summary>
|
||||
<param name="property">The property to reset.</param>
|
||||
<param name="instance">The instance to reset the property on.</param>
|
||||
<param name="options">The binder options.</param>
|
||||
<remarks>
|
||||
This method doesn't do any configuration binding. It just resets the property value to the value from the property getter.
|
||||
This method called only when creating an instance using a primary constructor with parameters names match properties names.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.CreateInstance(System.Type,Microsoft.Extensions.Configuration.IConfiguration,Microsoft.Extensions.Configuration.BinderOptions,System.Reflection.ParameterInfo[]@)">
|
||||
<summary>
|
||||
Create an instance of the specified type.
|
||||
</summary>
|
||||
<param name="type">The type to create an instance of.</param>
|
||||
<param name="config">The configuration to bind to the instance.</param>
|
||||
<param name="options">The binder options.</param>
|
||||
<param name="constructorParameters">The parameters of the constructor used to create the instance.</param>
|
||||
<returns>The created instance.</returns>
|
||||
<exception cref="T:System.InvalidOperationException">If the type cannot be created.</exception>
|
||||
<remarks>
|
||||
constructorParameters will not be null only when using a constructor with a parameters which get their values from the configuration
|
||||
This happen when using types having properties match the constructor parameter names. `record` types are an example.
|
||||
In such cases we need to carry the parameters list to avoid binding the properties again during BindProperties.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute">
|
||||
<summary>
|
||||
Indicates that certain members on a specified <see cref="T:System.Type"/> are accessed dynamically,
|
||||
for example through <see cref="N:System.Reflection"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This allows tools to understand which members are being accessed during the execution
|
||||
of a program.
|
||||
|
||||
This attribute is valid on members whose type is <see cref="T:System.Type"/> or <see cref="T:System.String"/>.
|
||||
|
||||
When this attribute is applied to a location of type <see cref="T:System.String"/>, the assumption is
|
||||
that the string represents a fully qualified type name.
|
||||
|
||||
When this attribute is applied to a class, interface, or struct, the members specified
|
||||
can be accessed dynamically on <see cref="T:System.Type"/> instances returned from calling
|
||||
<see cref="M:System.Object.GetType"/> on instances of that class, interface, or struct.
|
||||
|
||||
If the attribute is applied to a method it's treated as a special case and it implies
|
||||
the attribute should be applied to the "this" parameter of the method. As such the attribute
|
||||
should only be used on instance methods of types assignable to System.Type (or string, but no methods
|
||||
will use it there).
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute"/> class
|
||||
with the specified member types.
|
||||
</summary>
|
||||
<param name="memberTypes">The types of members dynamically accessed.</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes">
|
||||
<summary>
|
||||
Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
|
||||
of members dynamically accessed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
|
||||
<summary>
|
||||
Specifies the types of members that are dynamically accessed.
|
||||
|
||||
This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a
|
||||
bitwise combination of its member values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
|
||||
<summary>
|
||||
Specifies no members.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
|
||||
<summary>
|
||||
Specifies the default, parameterless public constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
|
||||
<summary>
|
||||
Specifies all public constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
|
||||
<summary>
|
||||
Specifies all non-public constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
|
||||
<summary>
|
||||
Specifies all public methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
|
||||
<summary>
|
||||
Specifies all non-public methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
|
||||
<summary>
|
||||
Specifies all public fields.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
|
||||
<summary>
|
||||
Specifies all non-public fields.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
|
||||
<summary>
|
||||
Specifies all public nested types.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
|
||||
<summary>
|
||||
Specifies all non-public nested types.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
|
||||
<summary>
|
||||
Specifies all public properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
|
||||
<summary>
|
||||
Specifies all non-public properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
|
||||
<summary>
|
||||
Specifies all public events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
|
||||
<summary>
|
||||
Specifies all non-public events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
|
||||
<summary>
|
||||
Specifies all interfaces implemented by the type.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructorsWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public constructors, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethodsWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public methods, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFieldsWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public fields, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypesWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public nested types, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicPropertiesWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public properties, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEventsWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public events, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructorsWithInherited">
|
||||
<summary>
|
||||
Specifies all public constructors, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypesWithInherited">
|
||||
<summary>
|
||||
Specifies all public nested types, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllConstructors">
|
||||
<summary>
|
||||
Specifies all constructors, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllMethods">
|
||||
<summary>
|
||||
Specifies all methods, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllFields">
|
||||
<summary>
|
||||
Specifies all fields, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllNestedTypes">
|
||||
<summary>
|
||||
Specifies all nested types, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllProperties">
|
||||
<summary>
|
||||
Specifies all properties, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllEvents">
|
||||
<summary>
|
||||
Specifies all events, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
|
||||
<summary>
|
||||
Specifies all members.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute">
|
||||
<summary>
|
||||
Indicates that the specified method requires the ability to generate new code at runtime,
|
||||
for example through <see cref="N:System.Reflection"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This allows tools to understand which methods are unsafe to call when compiling ahead of time.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute"/> class
|
||||
with the specified message.
|
||||
</summary>
|
||||
<param name="message">
|
||||
A message that contains information about the usage of dynamic code.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.ExcludeStatics">
|
||||
<summary>
|
||||
When set to true, indicates that the annotation should not apply to static members.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Message">
|
||||
<summary>
|
||||
Gets a message that contains information about the usage of dynamic code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Url">
|
||||
<summary>
|
||||
Gets or sets an optional URL that contains more information about the method,
|
||||
why it requires dynamic code, and what options a consumer has to deal with it.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute">
|
||||
<summary>
|
||||
Indicates that the specified method requires dynamic access to code that is not referenced
|
||||
statically, for example through <see cref="N:System.Reflection"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This allows tools to understand which methods are unsafe to call when removing unreferenced
|
||||
code from an application.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute"/> class
|
||||
with the specified message.
|
||||
</summary>
|
||||
<param name="message">
|
||||
A message that contains information about the usage of unreferenced code.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.ExcludeStatics">
|
||||
<summary>
|
||||
When set to true, indicates that the annotation should not apply to static members.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Message">
|
||||
<summary>
|
||||
Gets a message that contains information about the usage of unreferenced code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Url">
|
||||
<summary>
|
||||
Gets or sets an optional URL that contains more information about the method,
|
||||
why it requires unreferenced code, and what options a consumer has to deal with it.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute">
|
||||
<summary>
|
||||
Suppresses reporting of a specific rule violation, allowing multiple suppressions on a
|
||||
single code artifact.
|
||||
</summary>
|
||||
<remarks>
|
||||
<see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> is different than
|
||||
<see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute"/> in that it doesn't have a
|
||||
<see cref="T:System.Diagnostics.ConditionalAttribute"/>. So it is always preserved in the compiled assembly.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.#ctor(System.String,System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/>
|
||||
class, specifying the category of the tool and the identifier for an analysis rule.
|
||||
</summary>
|
||||
<param name="category">The category for the attribute.</param>
|
||||
<param name="checkId">The identifier of the analysis rule the attribute applies to.</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category">
|
||||
<summary>
|
||||
Gets the category identifying the classification of the attribute.
|
||||
</summary>
|
||||
<remarks>
|
||||
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> property describes the tool or tool analysis category
|
||||
for which a message suppression attribute applies.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId">
|
||||
<summary>
|
||||
Gets the identifier of the analysis tool rule to be suppressed.
|
||||
</summary>
|
||||
<remarks>
|
||||
Concatenated together, the <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> and <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId"/>
|
||||
properties form a unique check identifier.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Scope">
|
||||
<summary>
|
||||
Gets or sets the scope of the code that is relevant for the attribute.
|
||||
</summary>
|
||||
<remarks>
|
||||
The Scope property is an optional argument that specifies the metadata scope for which
|
||||
the attribute is relevant.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target">
|
||||
<summary>
|
||||
Gets or sets a fully qualified path that represents the target of the attribute.
|
||||
</summary>
|
||||
<remarks>
|
||||
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target"/> property is an optional argument identifying the analysis target
|
||||
of the attribute. An example value is "System.IO.Stream.ctor():System.Void".
|
||||
Because it is fully qualified, it can be long, particularly for targets such as parameters.
|
||||
The analysis tool user interface should be capable of automatically formatting the parameter.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId">
|
||||
<summary>
|
||||
Gets or sets an optional argument expanding on exclusion criteria.
|
||||
</summary>
|
||||
<remarks>
|
||||
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId"/> property is an optional argument that specifies additional
|
||||
exclusion where the literal metadata target is not sufficiently precise. For example,
|
||||
the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> cannot be applied within a method,
|
||||
and it may be desirable to suppress a violation against a statement in the method that will
|
||||
give a rule violation, but not against all statements in the method.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Justification">
|
||||
<summary>
|
||||
Gets or sets the justification for suppressing the code analysis message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field or property member will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field and property members will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute">
|
||||
<summary>
|
||||
When applied to an attribute class, instructs the compiler to flow applications of that attribute,
|
||||
from source code down to compiler-generated symbols. This can help IL-based analysis tools.
|
||||
</summary>
|
||||
<remarks>
|
||||
One example where this attribute applies is in C# primary constructor parameters. If an attribute
|
||||
marked with <see cref="T:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute"/> gets applied to a primary constructor
|
||||
parameter, the attribute will also be applied to any compiler-generated fields storing that parameter.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotActivateAbstractOrInterface">
|
||||
<summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotBindToConstructorParameter">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters cannot be declared as in, out, or ref. Invalid parameters are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ConstructorParametersDoNotMatchProperties">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters must have corresponding properties. Fields are not supported. Missing properties are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedBinding">
|
||||
<summary>Failed to convert configuration value '{0}' at '{1}' to type '{2}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedToActivate">
|
||||
<summary>Failed to create instance of type '{0}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_GeneralErrorWhenBinding">
|
||||
<summary>'{0}' was set and binding has failed. The likely cause is an invalid configuration value.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingConfig">
|
||||
<summary>'{0}' was set on the provided {1}, but the following properties were not found on the instance of {2}: {3}</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingPublicInstanceConstructor">
|
||||
<summary>Cannot create instance of type '{0}' because it is missing a public instance constructor.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MultipleParameterizedConstructors">
|
||||
<summary>Cannot create instance of type '{0}' because it has multiple public parameterized constructors.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterBeingBoundToIsUnnamed">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters are unnamed.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterHasNoMatchingConfig">
|
||||
<summary>Cannot create instance of type '{0}' because parameter '{1}' has no matching config. Each parameter in the constructor that does not have a default value must have a corresponding config entry.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_UnsupportedMultidimensionalArray">
|
||||
<summary>Cannot create instance of type '{0}' because multidimensional arrays are not supported.</summary>
|
||||
</member>
|
||||
<member name="T:System.ExceptionPolyfills">
|
||||
<summary>Provides downlevel polyfills for static methods on Exception-derived types.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,202 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Binder</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.BinderOptions">
|
||||
<summary>
|
||||
Specifies options used by the <see cref="T:Microsoft.Extensions.Configuration.ConfigurationBinder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.BindNonPublicProperties">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether the binder attempts to set all properties or only public properties.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true" /> if the binder attempts to set all non-read-only properties; <see langword="false" /> if only public properties are set.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.ErrorOnUnknownConfiguration">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether exceptions are thrown when converting a value or when a configuration
|
||||
key is found for which the provided model object doesn't have an appropriate property that matches the key's name.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true" /> if an <see cref="T:System.InvalidOperationException"/> is thrown with a description; <see langword="false" /> if no exceptions are thrown. The default is <see langword="false" />.
|
||||
</value>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationBinder">
|
||||
<summary>
|
||||
Static helper class that allows binding strongly typed objects to configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="key">The key of the configuration section to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String,``0)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String,System.Object)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.ResetPropertyValue(System.Reflection.PropertyInfo,System.Object,Microsoft.Extensions.Configuration.BinderOptions)">
|
||||
<summary>
|
||||
Reset the property value to the value from the property getter. This is useful for properties that have a getter or setters that perform some logic changing the object state.
|
||||
</summary>
|
||||
<param name="property">The property to reset.</param>
|
||||
<param name="instance">The instance to reset the property on.</param>
|
||||
<param name="options">The binder options.</param>
|
||||
<remarks>
|
||||
This method doesn't do any configuration binding. It just resets the property value to the value from the property getter.
|
||||
This method called only when creating an instance using a primary constructor with parameters names match properties names.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.CreateInstance(System.Type,Microsoft.Extensions.Configuration.IConfiguration,Microsoft.Extensions.Configuration.BinderOptions,System.Reflection.ParameterInfo[]@)">
|
||||
<summary>
|
||||
Create an instance of the specified type.
|
||||
</summary>
|
||||
<param name="type">The type to create an instance of.</param>
|
||||
<param name="config">The configuration to bind to the instance.</param>
|
||||
<param name="options">The binder options.</param>
|
||||
<param name="constructorParameters">The parameters of the constructor used to create the instance.</param>
|
||||
<returns>The created instance.</returns>
|
||||
<exception cref="T:System.InvalidOperationException">If the type cannot be created.</exception>
|
||||
<remarks>
|
||||
constructorParameters will not be null only when using a constructor with a parameters which get their values from the configuration
|
||||
This happen when using types having properties match the constructor parameter names. `record` types are an example.
|
||||
In such cases we need to carry the parameters list to avoid binding the properties again during BindProperties.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotActivateAbstractOrInterface">
|
||||
<summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotBindToConstructorParameter">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters cannot be declared as in, out, or ref. Invalid parameters are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ConstructorParametersDoNotMatchProperties">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters must have corresponding properties. Fields are not supported. Missing properties are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedBinding">
|
||||
<summary>Failed to convert configuration value '{0}' at '{1}' to type '{2}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedToActivate">
|
||||
<summary>Failed to create instance of type '{0}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_GeneralErrorWhenBinding">
|
||||
<summary>'{0}' was set and binding has failed. The likely cause is an invalid configuration value.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingConfig">
|
||||
<summary>'{0}' was set on the provided {1}, but the following properties were not found on the instance of {2}: {3}</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingPublicInstanceConstructor">
|
||||
<summary>Cannot create instance of type '{0}' because it is missing a public instance constructor.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MultipleParameterizedConstructors">
|
||||
<summary>Cannot create instance of type '{0}' because it has multiple public parameterized constructors.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterBeingBoundToIsUnnamed">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters are unnamed.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterHasNoMatchingConfig">
|
||||
<summary>Cannot create instance of type '{0}' because parameter '{1}' has no matching config. Each parameter in the constructor that does not have a default value must have a corresponding config entry.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_UnsupportedMultidimensionalArray">
|
||||
<summary>Cannot create instance of type '{0}' because multidimensional arrays are not supported.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,202 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Binder</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.BinderOptions">
|
||||
<summary>
|
||||
Specifies options used by the <see cref="T:Microsoft.Extensions.Configuration.ConfigurationBinder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.BindNonPublicProperties">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether the binder attempts to set all properties or only public properties.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true" /> if the binder attempts to set all non-read-only properties; <see langword="false" /> if only public properties are set.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.ErrorOnUnknownConfiguration">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether exceptions are thrown when converting a value or when a configuration
|
||||
key is found for which the provided model object doesn't have an appropriate property that matches the key's name.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true" /> if an <see cref="T:System.InvalidOperationException"/> is thrown with a description; <see langword="false" /> if no exceptions are thrown. The default is <see langword="false" />.
|
||||
</value>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationBinder">
|
||||
<summary>
|
||||
Static helper class that allows binding strongly typed objects to configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="key">The key of the configuration section to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String,``0)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String,System.Object)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.ResetPropertyValue(System.Reflection.PropertyInfo,System.Object,Microsoft.Extensions.Configuration.BinderOptions)">
|
||||
<summary>
|
||||
Reset the property value to the value from the property getter. This is useful for properties that have a getter or setters that perform some logic changing the object state.
|
||||
</summary>
|
||||
<param name="property">The property to reset.</param>
|
||||
<param name="instance">The instance to reset the property on.</param>
|
||||
<param name="options">The binder options.</param>
|
||||
<remarks>
|
||||
This method doesn't do any configuration binding. It just resets the property value to the value from the property getter.
|
||||
This method called only when creating an instance using a primary constructor with parameters names match properties names.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.CreateInstance(System.Type,Microsoft.Extensions.Configuration.IConfiguration,Microsoft.Extensions.Configuration.BinderOptions,System.Reflection.ParameterInfo[]@)">
|
||||
<summary>
|
||||
Create an instance of the specified type.
|
||||
</summary>
|
||||
<param name="type">The type to create an instance of.</param>
|
||||
<param name="config">The configuration to bind to the instance.</param>
|
||||
<param name="options">The binder options.</param>
|
||||
<param name="constructorParameters">The parameters of the constructor used to create the instance.</param>
|
||||
<returns>The created instance.</returns>
|
||||
<exception cref="T:System.InvalidOperationException">If the type cannot be created.</exception>
|
||||
<remarks>
|
||||
constructorParameters will not be null only when using a constructor with a parameters which get their values from the configuration
|
||||
This happen when using types having properties match the constructor parameter names. `record` types are an example.
|
||||
In such cases we need to carry the parameters list to avoid binding the properties again during BindProperties.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotActivateAbstractOrInterface">
|
||||
<summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotBindToConstructorParameter">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters cannot be declared as in, out, or ref. Invalid parameters are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ConstructorParametersDoNotMatchProperties">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters must have corresponding properties. Fields are not supported. Missing properties are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedBinding">
|
||||
<summary>Failed to convert configuration value '{0}' at '{1}' to type '{2}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedToActivate">
|
||||
<summary>Failed to create instance of type '{0}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_GeneralErrorWhenBinding">
|
||||
<summary>'{0}' was set and binding has failed. The likely cause is an invalid configuration value.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingConfig">
|
||||
<summary>'{0}' was set on the provided {1}, but the following properties were not found on the instance of {2}: {3}</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingPublicInstanceConstructor">
|
||||
<summary>Cannot create instance of type '{0}' because it is missing a public instance constructor.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MultipleParameterizedConstructors">
|
||||
<summary>Cannot create instance of type '{0}' because it has multiple public parameterized constructors.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterBeingBoundToIsUnnamed">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters are unnamed.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterHasNoMatchingConfig">
|
||||
<summary>Cannot create instance of type '{0}' because parameter '{1}' has no matching config. Each parameter in the constructor that does not have a default value must have a corresponding config entry.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_UnsupportedMultidimensionalArray">
|
||||
<summary>Cannot create instance of type '{0}' because multidimensional arrays are not supported.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,739 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Binder</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.BinderOptions">
|
||||
<summary>
|
||||
Specifies options used by the <see cref="T:Microsoft.Extensions.Configuration.ConfigurationBinder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.BindNonPublicProperties">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether the binder attempts to set all properties or only public properties.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true" /> if the binder attempts to set all non-read-only properties; <see langword="false" /> if only public properties are set.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.ErrorOnUnknownConfiguration">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether exceptions are thrown when converting a value or when a configuration
|
||||
key is found for which the provided model object doesn't have an appropriate property that matches the key's name.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true" /> if an <see cref="T:System.InvalidOperationException"/> is thrown with a description; <see langword="false" /> if no exceptions are thrown. The default is <see langword="false" />.
|
||||
</value>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationBinder">
|
||||
<summary>
|
||||
Static helper class that allows binding strongly typed objects to configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="key">The key of the configuration section to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String,``0)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String,System.Object)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.ResetPropertyValue(System.Reflection.PropertyInfo,System.Object,Microsoft.Extensions.Configuration.BinderOptions)">
|
||||
<summary>
|
||||
Reset the property value to the value from the property getter. This is useful for properties that have a getter or setters that perform some logic changing the object state.
|
||||
</summary>
|
||||
<param name="property">The property to reset.</param>
|
||||
<param name="instance">The instance to reset the property on.</param>
|
||||
<param name="options">The binder options.</param>
|
||||
<remarks>
|
||||
This method doesn't do any configuration binding. It just resets the property value to the value from the property getter.
|
||||
This method called only when creating an instance using a primary constructor with parameters names match properties names.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.CreateInstance(System.Type,Microsoft.Extensions.Configuration.IConfiguration,Microsoft.Extensions.Configuration.BinderOptions,System.Reflection.ParameterInfo[]@)">
|
||||
<summary>
|
||||
Create an instance of the specified type.
|
||||
</summary>
|
||||
<param name="type">The type to create an instance of.</param>
|
||||
<param name="config">The configuration to bind to the instance.</param>
|
||||
<param name="options">The binder options.</param>
|
||||
<param name="constructorParameters">The parameters of the constructor used to create the instance.</param>
|
||||
<returns>The created instance.</returns>
|
||||
<exception cref="T:System.InvalidOperationException">If the type cannot be created.</exception>
|
||||
<remarks>
|
||||
constructorParameters will not be null only when using a constructor with a parameters which get their values from the configuration
|
||||
This happen when using types having properties match the constructor parameter names. `record` types are an example.
|
||||
In such cases we need to carry the parameters list to avoid binding the properties again during BindProperties.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute">
|
||||
<summary>
|
||||
Indicates that certain members on a specified <see cref="T:System.Type"/> are accessed dynamically,
|
||||
for example through <see cref="N:System.Reflection"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This allows tools to understand which members are being accessed during the execution
|
||||
of a program.
|
||||
|
||||
This attribute is valid on members whose type is <see cref="T:System.Type"/> or <see cref="T:System.String"/>.
|
||||
|
||||
When this attribute is applied to a location of type <see cref="T:System.String"/>, the assumption is
|
||||
that the string represents a fully qualified type name.
|
||||
|
||||
When this attribute is applied to a class, interface, or struct, the members specified
|
||||
can be accessed dynamically on <see cref="T:System.Type"/> instances returned from calling
|
||||
<see cref="M:System.Object.GetType"/> on instances of that class, interface, or struct.
|
||||
|
||||
If the attribute is applied to a method it's treated as a special case and it implies
|
||||
the attribute should be applied to the "this" parameter of the method. As such the attribute
|
||||
should only be used on instance methods of types assignable to System.Type (or string, but no methods
|
||||
will use it there).
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute"/> class
|
||||
with the specified member types.
|
||||
</summary>
|
||||
<param name="memberTypes">The types of members dynamically accessed.</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes">
|
||||
<summary>
|
||||
Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
|
||||
of members dynamically accessed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
|
||||
<summary>
|
||||
Specifies the types of members that are dynamically accessed.
|
||||
|
||||
This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a
|
||||
bitwise combination of its member values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
|
||||
<summary>
|
||||
Specifies no members.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
|
||||
<summary>
|
||||
Specifies the default, parameterless public constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
|
||||
<summary>
|
||||
Specifies all public constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
|
||||
<summary>
|
||||
Specifies all non-public constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
|
||||
<summary>
|
||||
Specifies all public methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
|
||||
<summary>
|
||||
Specifies all non-public methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
|
||||
<summary>
|
||||
Specifies all public fields.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
|
||||
<summary>
|
||||
Specifies all non-public fields.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
|
||||
<summary>
|
||||
Specifies all public nested types.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
|
||||
<summary>
|
||||
Specifies all non-public nested types.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
|
||||
<summary>
|
||||
Specifies all public properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
|
||||
<summary>
|
||||
Specifies all non-public properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
|
||||
<summary>
|
||||
Specifies all public events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
|
||||
<summary>
|
||||
Specifies all non-public events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
|
||||
<summary>
|
||||
Specifies all interfaces implemented by the type.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructorsWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public constructors, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethodsWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public methods, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFieldsWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public fields, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypesWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public nested types, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicPropertiesWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public properties, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEventsWithInherited">
|
||||
<summary>
|
||||
Specifies all non-public events, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructorsWithInherited">
|
||||
<summary>
|
||||
Specifies all public constructors, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypesWithInherited">
|
||||
<summary>
|
||||
Specifies all public nested types, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllConstructors">
|
||||
<summary>
|
||||
Specifies all constructors, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllMethods">
|
||||
<summary>
|
||||
Specifies all methods, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllFields">
|
||||
<summary>
|
||||
Specifies all fields, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllNestedTypes">
|
||||
<summary>
|
||||
Specifies all nested types, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllProperties">
|
||||
<summary>
|
||||
Specifies all properties, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.AllEvents">
|
||||
<summary>
|
||||
Specifies all events, including those inherited from base classes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
|
||||
<summary>
|
||||
Specifies all members.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute">
|
||||
<summary>
|
||||
Indicates that the specified method requires the ability to generate new code at runtime,
|
||||
for example through <see cref="N:System.Reflection"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This allows tools to understand which methods are unsafe to call when compiling ahead of time.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute"/> class
|
||||
with the specified message.
|
||||
</summary>
|
||||
<param name="message">
|
||||
A message that contains information about the usage of dynamic code.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.ExcludeStatics">
|
||||
<summary>
|
||||
When set to true, indicates that the annotation should not apply to static members.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Message">
|
||||
<summary>
|
||||
Gets a message that contains information about the usage of dynamic code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Url">
|
||||
<summary>
|
||||
Gets or sets an optional URL that contains more information about the method,
|
||||
why it requires dynamic code, and what options a consumer has to deal with it.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute">
|
||||
<summary>
|
||||
Indicates that the specified method requires dynamic access to code that is not referenced
|
||||
statically, for example through <see cref="N:System.Reflection"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This allows tools to understand which methods are unsafe to call when removing unreferenced
|
||||
code from an application.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute"/> class
|
||||
with the specified message.
|
||||
</summary>
|
||||
<param name="message">
|
||||
A message that contains information about the usage of unreferenced code.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.ExcludeStatics">
|
||||
<summary>
|
||||
When set to true, indicates that the annotation should not apply to static members.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Message">
|
||||
<summary>
|
||||
Gets a message that contains information about the usage of unreferenced code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Url">
|
||||
<summary>
|
||||
Gets or sets an optional URL that contains more information about the method,
|
||||
why it requires unreferenced code, and what options a consumer has to deal with it.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute">
|
||||
<summary>
|
||||
Suppresses reporting of a specific rule violation, allowing multiple suppressions on a
|
||||
single code artifact.
|
||||
</summary>
|
||||
<remarks>
|
||||
<see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> is different than
|
||||
<see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute"/> in that it doesn't have a
|
||||
<see cref="T:System.Diagnostics.ConditionalAttribute"/>. So it is always preserved in the compiled assembly.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.#ctor(System.String,System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/>
|
||||
class, specifying the category of the tool and the identifier for an analysis rule.
|
||||
</summary>
|
||||
<param name="category">The category for the attribute.</param>
|
||||
<param name="checkId">The identifier of the analysis rule the attribute applies to.</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category">
|
||||
<summary>
|
||||
Gets the category identifying the classification of the attribute.
|
||||
</summary>
|
||||
<remarks>
|
||||
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> property describes the tool or tool analysis category
|
||||
for which a message suppression attribute applies.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId">
|
||||
<summary>
|
||||
Gets the identifier of the analysis tool rule to be suppressed.
|
||||
</summary>
|
||||
<remarks>
|
||||
Concatenated together, the <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> and <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId"/>
|
||||
properties form a unique check identifier.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Scope">
|
||||
<summary>
|
||||
Gets or sets the scope of the code that is relevant for the attribute.
|
||||
</summary>
|
||||
<remarks>
|
||||
The Scope property is an optional argument that specifies the metadata scope for which
|
||||
the attribute is relevant.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target">
|
||||
<summary>
|
||||
Gets or sets a fully qualified path that represents the target of the attribute.
|
||||
</summary>
|
||||
<remarks>
|
||||
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target"/> property is an optional argument identifying the analysis target
|
||||
of the attribute. An example value is "System.IO.Stream.ctor():System.Void".
|
||||
Because it is fully qualified, it can be long, particularly for targets such as parameters.
|
||||
The analysis tool user interface should be capable of automatically formatting the parameter.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId">
|
||||
<summary>
|
||||
Gets or sets an optional argument expanding on exclusion criteria.
|
||||
</summary>
|
||||
<remarks>
|
||||
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId"/> property is an optional argument that specifies additional
|
||||
exclusion where the literal metadata target is not sufficiently precise. For example,
|
||||
the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> cannot be applied within a method,
|
||||
and it may be desirable to suppress a violation against a statement in the method that will
|
||||
give a rule violation, but not against all statements in the method.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Justification">
|
||||
<summary>
|
||||
Gets or sets the justification for suppressing the code analysis message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field or property member will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field and property members will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute">
|
||||
<summary>
|
||||
When applied to an attribute class, instructs the compiler to flow applications of that attribute,
|
||||
from source code down to compiler-generated symbols. This can help IL-based analysis tools.
|
||||
</summary>
|
||||
<remarks>
|
||||
One example where this attribute applies is in C# primary constructor parameters. If an attribute
|
||||
marked with <see cref="T:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute"/> gets applied to a primary constructor
|
||||
parameter, the attribute will also be applied to any compiler-generated fields storing that parameter.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotActivateAbstractOrInterface">
|
||||
<summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotBindToConstructorParameter">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters cannot be declared as in, out, or ref. Invalid parameters are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ConstructorParametersDoNotMatchProperties">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters must have corresponding properties. Fields are not supported. Missing properties are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedBinding">
|
||||
<summary>Failed to convert configuration value '{0}' at '{1}' to type '{2}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedToActivate">
|
||||
<summary>Failed to create instance of type '{0}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_GeneralErrorWhenBinding">
|
||||
<summary>'{0}' was set and binding has failed. The likely cause is an invalid configuration value.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingConfig">
|
||||
<summary>'{0}' was set on the provided {1}, but the following properties were not found on the instance of {2}: {3}</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingPublicInstanceConstructor">
|
||||
<summary>Cannot create instance of type '{0}' because it is missing a public instance constructor.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MultipleParameterizedConstructors">
|
||||
<summary>Cannot create instance of type '{0}' because it has multiple public parameterized constructors.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterBeingBoundToIsUnnamed">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters are unnamed.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterHasNoMatchingConfig">
|
||||
<summary>Cannot create instance of type '{0}' because parameter '{1}' has no matching config. Each parameter in the constructor that does not have a default value must have a corresponding config entry.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_UnsupportedMultidimensionalArray">
|
||||
<summary>Cannot create instance of type '{0}' because multidimensional arrays are not supported.</summary>
|
||||
</member>
|
||||
<member name="T:System.ExceptionPolyfills">
|
||||
<summary>Provides downlevel polyfills for static methods on Exception-derived types.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
PdAeMXXVgGOOpX4JcSb9FV38sE57sUq4EubErTT8fTxUxBdBg9d8ba8aBvOsnCwjDslvtn+aH/2BFr+22UDeaw==
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "sNsznxpgL7oNki7Q1AbaCD6PQcXBBeeasQNze76GZ4PfXEpKrEeWHdMxt1oRK7N+sz1vryDHSLo8cunH9zAaJQ==",
|
||||
"source": "/mnt/e/dev/git.stella-ops.org/local-nugets"
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@@ -0,0 +1,40 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Configuration.CommandLine</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>Command line configuration provider implementation for Microsoft.Extensions.Configuration. This package enables you to read configuration parameters from the command line arguments of your application. You can use CommandLineConfigurationExtensions.AddCommandLine extension method on IConfigurationBuilder to add the command line configuration provider to the configuration builder.</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.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Configuration" version="10.0.0-rc.2.25502.107" 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.Configuration" 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.Configuration" 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.Configuration" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Configuration" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
@@ -0,0 +1,44 @@
|
||||
## About
|
||||
|
||||
<!-- A description of the package and where one can find more documentation -->
|
||||
|
||||
Command line configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read configuration parameters from the command line arguments of your application. You can use [CommandLineConfigurationExtensions.AddCommandLine](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.commandlineconfigurationextensions.addcommandline) extension method on `IConfigurationBuilder` to add the command line configuration provider to the configuration builder.
|
||||
|
||||
## 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 following example shows how to read application configuration from the command line. You can use a command like `dotnet run --InputPath "c:\fizz" --OutputPath "c:\buzz"` to run it.
|
||||
|
||||
```C#
|
||||
using System;
|
||||
using Microsoft.Extensions.Configuration;
|
||||
|
||||
class Program
|
||||
{
|
||||
static void Main(string[] args)
|
||||
{
|
||||
// Build a configuration object from command line
|
||||
IConfiguration config = new ConfigurationBuilder()
|
||||
.AddCommandLine(args)
|
||||
.Build();
|
||||
|
||||
// Read configuration values
|
||||
Console.WriteLine($"InputPath: {config["InputPath"]}");
|
||||
Console.WriteLine($"OutputPath: {config["OutputPath"]}");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
<!-- Links to further documentation -->
|
||||
|
||||
* [Command-line configuration provider](https://learn.microsoft.com/dotnet/core/extensions/configuration-providers#command-line-configuration-provider)
|
||||
* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.commandline)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
<!-- How to provide feedback on this package and contribute to it -->
|
||||
|
||||
Microsoft.Extensions.Configuration.CommandLine is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Configuration_CommandLine_net462">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Configuration_CommandLine_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Configuration.CommandLine 10.0.0-rc.2.25502.107 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net462 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Configuration_CommandLine_net8_0">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Configuration_CommandLine_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Configuration.CommandLine 10.0.0-rc.2.25502.107 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net8.0 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,210 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.CommandLine</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions">
|
||||
<summary>
|
||||
Extension methods for registering <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> with <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String[])">
|
||||
<summary>
|
||||
Adds a <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>
|
||||
that reads configuration values from the command line.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="args">The command line args.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
The values passed on the command line, in the <c>args</c> string array, should be a set
|
||||
of keys prefixed with two dashes ("--") and then values, separate by either the
|
||||
equals sign ("=") or a space (" ").
|
||||
</para>
|
||||
<para>
|
||||
A forward slash ("/") can be used as an alternative prefix, with either equals or space, and when using
|
||||
an equals sign the prefix can be left out altogether.
|
||||
</para>
|
||||
<para>
|
||||
There are five basic alternative formats for arguments:
|
||||
<c>key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5</c>.
|
||||
</para>
|
||||
</remarks>
|
||||
<example>
|
||||
A simple console application that has five values.
|
||||
<code>
|
||||
// dotnet run key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5
|
||||
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using System;
|
||||
|
||||
namespace CommandLineSample
|
||||
{
|
||||
public class Program
|
||||
{
|
||||
public static void Main(string[] args)
|
||||
{
|
||||
var builder = new ConfigurationBuilder();
|
||||
builder.AddCommandLine(args);
|
||||
|
||||
var config = builder.Build();
|
||||
|
||||
Console.WriteLine($"Key1: '{config["Key1"]}'");
|
||||
Console.WriteLine($"Key2: '{config["Key2"]}'");
|
||||
Console.WriteLine($"Key3: '{config["Key3"]}'");
|
||||
Console.WriteLine($"Key4: '{config["Key4"]}'");
|
||||
Console.WriteLine($"Key5: '{config["Key5"]}'");
|
||||
}
|
||||
}
|
||||
}
|
||||
</code>
|
||||
</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String[],System.Collections.Generic.IDictionary{System.String,System.String})">
|
||||
<summary>
|
||||
Adds a <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads
|
||||
configuration values from the command line using the specified switch mappings.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="args">The command line args.</param>
|
||||
<param name="switchMappings">
|
||||
The switch mappings. A dictionary of short (with prefix "-") and
|
||||
alias keys (with prefix "--"), mapped to the configuration key (no prefix).
|
||||
</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
The <c>switchMappings</c> allows additional formats for alternative short and alias keys
|
||||
to be used from the command line. Also see the basic version of <c>AddCommandLine</c> for
|
||||
the standard formats supported.
|
||||
</para>
|
||||
<para>
|
||||
Short keys start with a single dash ("-") and are mapped to the main key name (without
|
||||
prefix), and can be used with either equals or space. The single dash mappings are intended
|
||||
to be used for shorter alternative switches.
|
||||
</para>
|
||||
<para>
|
||||
Note that a single dash switch cannot be accessed directly, but must have a switch mapping
|
||||
defined and accessed using the full key. Passing an undefined single dash argument will
|
||||
cause as <c>FormatException</c>.
|
||||
</para>
|
||||
<para>
|
||||
There are two formats for short arguments:
|
||||
<c>-k1=value1 -k2 value2</c>.
|
||||
</para>
|
||||
<para>
|
||||
Alias key definitions start with two dashes ("--") and are mapped to the main key name (without
|
||||
prefix), and can be used in place of the normal key. They also work when a forward slash prefix
|
||||
is used in the command line (but not with the no prefix equals format).
|
||||
</para>
|
||||
<para>
|
||||
There are only four formats for aliased arguments:
|
||||
<c>--alt3=value3 /alt4=value4 --alt5 value5 /alt6 value6</c>.
|
||||
</para>
|
||||
</remarks>
|
||||
<example>
|
||||
A simple console application that has two short and four alias switch mappings defined.
|
||||
<code>
|
||||
// dotnet run -k1=value1 -k2 value2 --alt3=value2 /alt4=value3 --alt5 value5 /alt6 value6
|
||||
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
|
||||
namespace CommandLineSample
|
||||
{
|
||||
public class Program
|
||||
{
|
||||
public static void Main(string[] args)
|
||||
{
|
||||
var switchMappings = new Dictionary<string, string>()
|
||||
{
|
||||
{ "-k1", "key1" },
|
||||
{ "-k2", "key2" },
|
||||
{ "--alt3", "key3" },
|
||||
{ "--alt4", "key4" },
|
||||
{ "--alt5", "key5" },
|
||||
{ "--alt6", "key6" },
|
||||
};
|
||||
var builder = new ConfigurationBuilder();
|
||||
builder.AddCommandLine(args, switchMappings);
|
||||
|
||||
var config = builder.Build();
|
||||
|
||||
Console.WriteLine($"Key1: '{config["Key1"]}'");
|
||||
Console.WriteLine($"Key2: '{config["Key2"]}'");
|
||||
Console.WriteLine($"Key3: '{config["Key3"]}'");
|
||||
Console.WriteLine($"Key4: '{config["Key4"]}'");
|
||||
Console.WriteLine($"Key5: '{config["Key5"]}'");
|
||||
Console.WriteLine($"Key6: '{config["Key6"]}'");
|
||||
}
|
||||
}
|
||||
}
|
||||
</code>
|
||||
</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource})">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from the command line.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="configureSource">Configures the source.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider">
|
||||
<summary>
|
||||
Provides configuration key-value pairs that are obtained from the command line.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IDictionary{System.String,System.String})">
|
||||
<summary>
|
||||
Initializes a new instance.
|
||||
</summary>
|
||||
<param name="args">The command line args.</param>
|
||||
<param name="switchMappings">The switch mappings.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.Args">
|
||||
<summary>
|
||||
Gets the command-line arguments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads the configuration data from the command-line arguments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource">
|
||||
<summary>
|
||||
Represents command-line arguments as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.SwitchMappings">
|
||||
<summary>
|
||||
Gets or sets the switch mappings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.Args">
|
||||
<summary>
|
||||
Gets or sets the command line arguments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/>.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_DuplicatedKeyInSwitchMappings">
|
||||
<summary>Keys in switch mappings are case-insensitive. A duplicated key '{0}' was found.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_InvalidSwitchMapping">
|
||||
<summary>The switch mappings contain an invalid switch '{0}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ShortSwitchNotDefined">
|
||||
<summary>The short switch '{0}' is not defined in the switch mappings.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,393 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.CommandLine</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions">
|
||||
<summary>
|
||||
Extension methods for registering <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> with <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String[])">
|
||||
<summary>
|
||||
Adds a <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>
|
||||
that reads configuration values from the command line.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="args">The command line args.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
The values passed on the command line, in the <c>args</c> string array, should be a set
|
||||
of keys prefixed with two dashes ("--") and then values, separate by either the
|
||||
equals sign ("=") or a space (" ").
|
||||
</para>
|
||||
<para>
|
||||
A forward slash ("/") can be used as an alternative prefix, with either equals or space, and when using
|
||||
an equals sign the prefix can be left out altogether.
|
||||
</para>
|
||||
<para>
|
||||
There are five basic alternative formats for arguments:
|
||||
<c>key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5</c>.
|
||||
</para>
|
||||
</remarks>
|
||||
<example>
|
||||
A simple console application that has five values.
|
||||
<code>
|
||||
// dotnet run key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5
|
||||
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using System;
|
||||
|
||||
namespace CommandLineSample
|
||||
{
|
||||
public class Program
|
||||
{
|
||||
public static void Main(string[] args)
|
||||
{
|
||||
var builder = new ConfigurationBuilder();
|
||||
builder.AddCommandLine(args);
|
||||
|
||||
var config = builder.Build();
|
||||
|
||||
Console.WriteLine($"Key1: '{config["Key1"]}'");
|
||||
Console.WriteLine($"Key2: '{config["Key2"]}'");
|
||||
Console.WriteLine($"Key3: '{config["Key3"]}'");
|
||||
Console.WriteLine($"Key4: '{config["Key4"]}'");
|
||||
Console.WriteLine($"Key5: '{config["Key5"]}'");
|
||||
}
|
||||
}
|
||||
}
|
||||
</code>
|
||||
</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String[],System.Collections.Generic.IDictionary{System.String,System.String})">
|
||||
<summary>
|
||||
Adds a <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads
|
||||
configuration values from the command line using the specified switch mappings.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="args">The command line args.</param>
|
||||
<param name="switchMappings">
|
||||
The switch mappings. A dictionary of short (with prefix "-") and
|
||||
alias keys (with prefix "--"), mapped to the configuration key (no prefix).
|
||||
</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
The <c>switchMappings</c> allows additional formats for alternative short and alias keys
|
||||
to be used from the command line. Also see the basic version of <c>AddCommandLine</c> for
|
||||
the standard formats supported.
|
||||
</para>
|
||||
<para>
|
||||
Short keys start with a single dash ("-") and are mapped to the main key name (without
|
||||
prefix), and can be used with either equals or space. The single dash mappings are intended
|
||||
to be used for shorter alternative switches.
|
||||
</para>
|
||||
<para>
|
||||
Note that a single dash switch cannot be accessed directly, but must have a switch mapping
|
||||
defined and accessed using the full key. Passing an undefined single dash argument will
|
||||
cause as <c>FormatException</c>.
|
||||
</para>
|
||||
<para>
|
||||
There are two formats for short arguments:
|
||||
<c>-k1=value1 -k2 value2</c>.
|
||||
</para>
|
||||
<para>
|
||||
Alias key definitions start with two dashes ("--") and are mapped to the main key name (without
|
||||
prefix), and can be used in place of the normal key. They also work when a forward slash prefix
|
||||
is used in the command line (but not with the no prefix equals format).
|
||||
</para>
|
||||
<para>
|
||||
There are only four formats for aliased arguments:
|
||||
<c>--alt3=value3 /alt4=value4 --alt5 value5 /alt6 value6</c>.
|
||||
</para>
|
||||
</remarks>
|
||||
<example>
|
||||
A simple console application that has two short and four alias switch mappings defined.
|
||||
<code>
|
||||
// dotnet run -k1=value1 -k2 value2 --alt3=value2 /alt4=value3 --alt5 value5 /alt6 value6
|
||||
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
|
||||
namespace CommandLineSample
|
||||
{
|
||||
public class Program
|
||||
{
|
||||
public static void Main(string[] args)
|
||||
{
|
||||
var switchMappings = new Dictionary<string, string>()
|
||||
{
|
||||
{ "-k1", "key1" },
|
||||
{ "-k2", "key2" },
|
||||
{ "--alt3", "key3" },
|
||||
{ "--alt4", "key4" },
|
||||
{ "--alt5", "key5" },
|
||||
{ "--alt6", "key6" },
|
||||
};
|
||||
var builder = new ConfigurationBuilder();
|
||||
builder.AddCommandLine(args, switchMappings);
|
||||
|
||||
var config = builder.Build();
|
||||
|
||||
Console.WriteLine($"Key1: '{config["Key1"]}'");
|
||||
Console.WriteLine($"Key2: '{config["Key2"]}'");
|
||||
Console.WriteLine($"Key3: '{config["Key3"]}'");
|
||||
Console.WriteLine($"Key4: '{config["Key4"]}'");
|
||||
Console.WriteLine($"Key5: '{config["Key5"]}'");
|
||||
Console.WriteLine($"Key6: '{config["Key6"]}'");
|
||||
}
|
||||
}
|
||||
}
|
||||
</code>
|
||||
</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource})">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from the command line.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="configureSource">Configures the source.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider">
|
||||
<summary>
|
||||
Provides configuration key-value pairs that are obtained from the command line.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IDictionary{System.String,System.String})">
|
||||
<summary>
|
||||
Initializes a new instance.
|
||||
</summary>
|
||||
<param name="args">The command line args.</param>
|
||||
<param name="switchMappings">The switch mappings.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.Args">
|
||||
<summary>
|
||||
Gets the command-line arguments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads the configuration data from the command-line arguments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource">
|
||||
<summary>
|
||||
Represents command-line arguments as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.SwitchMappings">
|
||||
<summary>
|
||||
Gets or sets the switch mappings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.Args">
|
||||
<summary>
|
||||
Gets or sets the command line arguments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/>.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_DuplicatedKeyInSwitchMappings">
|
||||
<summary>Keys in switch mappings are case-insensitive. A duplicated key '{0}' was found.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_InvalidSwitchMapping">
|
||||
<summary>The switch mappings contain an invalid switch '{0}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ShortSwitchNotDefined">
|
||||
<summary>The short switch '{0}' is not defined in the switch mappings.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field or property member will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field and property members will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.ExceptionPolyfills">
|
||||
<summary>Provides downlevel polyfills for static methods on Exception-derived types.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,210 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.CommandLine</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions">
|
||||
<summary>
|
||||
Extension methods for registering <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> with <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String[])">
|
||||
<summary>
|
||||
Adds a <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>
|
||||
that reads configuration values from the command line.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="args">The command line args.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
The values passed on the command line, in the <c>args</c> string array, should be a set
|
||||
of keys prefixed with two dashes ("--") and then values, separate by either the
|
||||
equals sign ("=") or a space (" ").
|
||||
</para>
|
||||
<para>
|
||||
A forward slash ("/") can be used as an alternative prefix, with either equals or space, and when using
|
||||
an equals sign the prefix can be left out altogether.
|
||||
</para>
|
||||
<para>
|
||||
There are five basic alternative formats for arguments:
|
||||
<c>key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5</c>.
|
||||
</para>
|
||||
</remarks>
|
||||
<example>
|
||||
A simple console application that has five values.
|
||||
<code>
|
||||
// dotnet run key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5
|
||||
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using System;
|
||||
|
||||
namespace CommandLineSample
|
||||
{
|
||||
public class Program
|
||||
{
|
||||
public static void Main(string[] args)
|
||||
{
|
||||
var builder = new ConfigurationBuilder();
|
||||
builder.AddCommandLine(args);
|
||||
|
||||
var config = builder.Build();
|
||||
|
||||
Console.WriteLine($"Key1: '{config["Key1"]}'");
|
||||
Console.WriteLine($"Key2: '{config["Key2"]}'");
|
||||
Console.WriteLine($"Key3: '{config["Key3"]}'");
|
||||
Console.WriteLine($"Key4: '{config["Key4"]}'");
|
||||
Console.WriteLine($"Key5: '{config["Key5"]}'");
|
||||
}
|
||||
}
|
||||
}
|
||||
</code>
|
||||
</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String[],System.Collections.Generic.IDictionary{System.String,System.String})">
|
||||
<summary>
|
||||
Adds a <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads
|
||||
configuration values from the command line using the specified switch mappings.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="args">The command line args.</param>
|
||||
<param name="switchMappings">
|
||||
The switch mappings. A dictionary of short (with prefix "-") and
|
||||
alias keys (with prefix "--"), mapped to the configuration key (no prefix).
|
||||
</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
The <c>switchMappings</c> allows additional formats for alternative short and alias keys
|
||||
to be used from the command line. Also see the basic version of <c>AddCommandLine</c> for
|
||||
the standard formats supported.
|
||||
</para>
|
||||
<para>
|
||||
Short keys start with a single dash ("-") and are mapped to the main key name (without
|
||||
prefix), and can be used with either equals or space. The single dash mappings are intended
|
||||
to be used for shorter alternative switches.
|
||||
</para>
|
||||
<para>
|
||||
Note that a single dash switch cannot be accessed directly, but must have a switch mapping
|
||||
defined and accessed using the full key. Passing an undefined single dash argument will
|
||||
cause as <c>FormatException</c>.
|
||||
</para>
|
||||
<para>
|
||||
There are two formats for short arguments:
|
||||
<c>-k1=value1 -k2 value2</c>.
|
||||
</para>
|
||||
<para>
|
||||
Alias key definitions start with two dashes ("--") and are mapped to the main key name (without
|
||||
prefix), and can be used in place of the normal key. They also work when a forward slash prefix
|
||||
is used in the command line (but not with the no prefix equals format).
|
||||
</para>
|
||||
<para>
|
||||
There are only four formats for aliased arguments:
|
||||
<c>--alt3=value3 /alt4=value4 --alt5 value5 /alt6 value6</c>.
|
||||
</para>
|
||||
</remarks>
|
||||
<example>
|
||||
A simple console application that has two short and four alias switch mappings defined.
|
||||
<code>
|
||||
// dotnet run -k1=value1 -k2 value2 --alt3=value2 /alt4=value3 --alt5 value5 /alt6 value6
|
||||
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
|
||||
namespace CommandLineSample
|
||||
{
|
||||
public class Program
|
||||
{
|
||||
public static void Main(string[] args)
|
||||
{
|
||||
var switchMappings = new Dictionary<string, string>()
|
||||
{
|
||||
{ "-k1", "key1" },
|
||||
{ "-k2", "key2" },
|
||||
{ "--alt3", "key3" },
|
||||
{ "--alt4", "key4" },
|
||||
{ "--alt5", "key5" },
|
||||
{ "--alt6", "key6" },
|
||||
};
|
||||
var builder = new ConfigurationBuilder();
|
||||
builder.AddCommandLine(args, switchMappings);
|
||||
|
||||
var config = builder.Build();
|
||||
|
||||
Console.WriteLine($"Key1: '{config["Key1"]}'");
|
||||
Console.WriteLine($"Key2: '{config["Key2"]}'");
|
||||
Console.WriteLine($"Key3: '{config["Key3"]}'");
|
||||
Console.WriteLine($"Key4: '{config["Key4"]}'");
|
||||
Console.WriteLine($"Key5: '{config["Key5"]}'");
|
||||
Console.WriteLine($"Key6: '{config["Key6"]}'");
|
||||
}
|
||||
}
|
||||
}
|
||||
</code>
|
||||
</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource})">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from the command line.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="configureSource">Configures the source.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider">
|
||||
<summary>
|
||||
Provides configuration key-value pairs that are obtained from the command line.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IDictionary{System.String,System.String})">
|
||||
<summary>
|
||||
Initializes a new instance.
|
||||
</summary>
|
||||
<param name="args">The command line args.</param>
|
||||
<param name="switchMappings">The switch mappings.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.Args">
|
||||
<summary>
|
||||
Gets the command-line arguments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads the configuration data from the command-line arguments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource">
|
||||
<summary>
|
||||
Represents command-line arguments as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.SwitchMappings">
|
||||
<summary>
|
||||
Gets or sets the switch mappings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.Args">
|
||||
<summary>
|
||||
Gets or sets the command line arguments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/>.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_DuplicatedKeyInSwitchMappings">
|
||||
<summary>Keys in switch mappings are case-insensitive. A duplicated key '{0}' was found.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_InvalidSwitchMapping">
|
||||
<summary>The switch mappings contain an invalid switch '{0}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ShortSwitchNotDefined">
|
||||
<summary>The short switch '{0}' is not defined in the switch mappings.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,210 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.CommandLine</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions">
|
||||
<summary>
|
||||
Extension methods for registering <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> with <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String[])">
|
||||
<summary>
|
||||
Adds a <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>
|
||||
that reads configuration values from the command line.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="args">The command line args.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
The values passed on the command line, in the <c>args</c> string array, should be a set
|
||||
of keys prefixed with two dashes ("--") and then values, separate by either the
|
||||
equals sign ("=") or a space (" ").
|
||||
</para>
|
||||
<para>
|
||||
A forward slash ("/") can be used as an alternative prefix, with either equals or space, and when using
|
||||
an equals sign the prefix can be left out altogether.
|
||||
</para>
|
||||
<para>
|
||||
There are five basic alternative formats for arguments:
|
||||
<c>key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5</c>.
|
||||
</para>
|
||||
</remarks>
|
||||
<example>
|
||||
A simple console application that has five values.
|
||||
<code>
|
||||
// dotnet run key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5
|
||||
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using System;
|
||||
|
||||
namespace CommandLineSample
|
||||
{
|
||||
public class Program
|
||||
{
|
||||
public static void Main(string[] args)
|
||||
{
|
||||
var builder = new ConfigurationBuilder();
|
||||
builder.AddCommandLine(args);
|
||||
|
||||
var config = builder.Build();
|
||||
|
||||
Console.WriteLine($"Key1: '{config["Key1"]}'");
|
||||
Console.WriteLine($"Key2: '{config["Key2"]}'");
|
||||
Console.WriteLine($"Key3: '{config["Key3"]}'");
|
||||
Console.WriteLine($"Key4: '{config["Key4"]}'");
|
||||
Console.WriteLine($"Key5: '{config["Key5"]}'");
|
||||
}
|
||||
}
|
||||
}
|
||||
</code>
|
||||
</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String[],System.Collections.Generic.IDictionary{System.String,System.String})">
|
||||
<summary>
|
||||
Adds a <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads
|
||||
configuration values from the command line using the specified switch mappings.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="args">The command line args.</param>
|
||||
<param name="switchMappings">
|
||||
The switch mappings. A dictionary of short (with prefix "-") and
|
||||
alias keys (with prefix "--"), mapped to the configuration key (no prefix).
|
||||
</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
The <c>switchMappings</c> allows additional formats for alternative short and alias keys
|
||||
to be used from the command line. Also see the basic version of <c>AddCommandLine</c> for
|
||||
the standard formats supported.
|
||||
</para>
|
||||
<para>
|
||||
Short keys start with a single dash ("-") and are mapped to the main key name (without
|
||||
prefix), and can be used with either equals or space. The single dash mappings are intended
|
||||
to be used for shorter alternative switches.
|
||||
</para>
|
||||
<para>
|
||||
Note that a single dash switch cannot be accessed directly, but must have a switch mapping
|
||||
defined and accessed using the full key. Passing an undefined single dash argument will
|
||||
cause as <c>FormatException</c>.
|
||||
</para>
|
||||
<para>
|
||||
There are two formats for short arguments:
|
||||
<c>-k1=value1 -k2 value2</c>.
|
||||
</para>
|
||||
<para>
|
||||
Alias key definitions start with two dashes ("--") and are mapped to the main key name (without
|
||||
prefix), and can be used in place of the normal key. They also work when a forward slash prefix
|
||||
is used in the command line (but not with the no prefix equals format).
|
||||
</para>
|
||||
<para>
|
||||
There are only four formats for aliased arguments:
|
||||
<c>--alt3=value3 /alt4=value4 --alt5 value5 /alt6 value6</c>.
|
||||
</para>
|
||||
</remarks>
|
||||
<example>
|
||||
A simple console application that has two short and four alias switch mappings defined.
|
||||
<code>
|
||||
// dotnet run -k1=value1 -k2 value2 --alt3=value2 /alt4=value3 --alt5 value5 /alt6 value6
|
||||
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
|
||||
namespace CommandLineSample
|
||||
{
|
||||
public class Program
|
||||
{
|
||||
public static void Main(string[] args)
|
||||
{
|
||||
var switchMappings = new Dictionary<string, string>()
|
||||
{
|
||||
{ "-k1", "key1" },
|
||||
{ "-k2", "key2" },
|
||||
{ "--alt3", "key3" },
|
||||
{ "--alt4", "key4" },
|
||||
{ "--alt5", "key5" },
|
||||
{ "--alt6", "key6" },
|
||||
};
|
||||
var builder = new ConfigurationBuilder();
|
||||
builder.AddCommandLine(args, switchMappings);
|
||||
|
||||
var config = builder.Build();
|
||||
|
||||
Console.WriteLine($"Key1: '{config["Key1"]}'");
|
||||
Console.WriteLine($"Key2: '{config["Key2"]}'");
|
||||
Console.WriteLine($"Key3: '{config["Key3"]}'");
|
||||
Console.WriteLine($"Key4: '{config["Key4"]}'");
|
||||
Console.WriteLine($"Key5: '{config["Key5"]}'");
|
||||
Console.WriteLine($"Key6: '{config["Key6"]}'");
|
||||
}
|
||||
}
|
||||
}
|
||||
</code>
|
||||
</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource})">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from the command line.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="configureSource">Configures the source.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider">
|
||||
<summary>
|
||||
Provides configuration key-value pairs that are obtained from the command line.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IDictionary{System.String,System.String})">
|
||||
<summary>
|
||||
Initializes a new instance.
|
||||
</summary>
|
||||
<param name="args">The command line args.</param>
|
||||
<param name="switchMappings">The switch mappings.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.Args">
|
||||
<summary>
|
||||
Gets the command-line arguments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads the configuration data from the command-line arguments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource">
|
||||
<summary>
|
||||
Represents command-line arguments as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.SwitchMappings">
|
||||
<summary>
|
||||
Gets or sets the switch mappings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.Args">
|
||||
<summary>
|
||||
Gets or sets the command line arguments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/>.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_DuplicatedKeyInSwitchMappings">
|
||||
<summary>Keys in switch mappings are case-insensitive. A duplicated key '{0}' was found.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_InvalidSwitchMapping">
|
||||
<summary>The switch mappings contain an invalid switch '{0}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ShortSwitchNotDefined">
|
||||
<summary>The short switch '{0}' is not defined in the switch mappings.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,393 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.CommandLine</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions">
|
||||
<summary>
|
||||
Extension methods for registering <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> with <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String[])">
|
||||
<summary>
|
||||
Adds a <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>
|
||||
that reads configuration values from the command line.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="args">The command line args.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
The values passed on the command line, in the <c>args</c> string array, should be a set
|
||||
of keys prefixed with two dashes ("--") and then values, separate by either the
|
||||
equals sign ("=") or a space (" ").
|
||||
</para>
|
||||
<para>
|
||||
A forward slash ("/") can be used as an alternative prefix, with either equals or space, and when using
|
||||
an equals sign the prefix can be left out altogether.
|
||||
</para>
|
||||
<para>
|
||||
There are five basic alternative formats for arguments:
|
||||
<c>key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5</c>.
|
||||
</para>
|
||||
</remarks>
|
||||
<example>
|
||||
A simple console application that has five values.
|
||||
<code>
|
||||
// dotnet run key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5
|
||||
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using System;
|
||||
|
||||
namespace CommandLineSample
|
||||
{
|
||||
public class Program
|
||||
{
|
||||
public static void Main(string[] args)
|
||||
{
|
||||
var builder = new ConfigurationBuilder();
|
||||
builder.AddCommandLine(args);
|
||||
|
||||
var config = builder.Build();
|
||||
|
||||
Console.WriteLine($"Key1: '{config["Key1"]}'");
|
||||
Console.WriteLine($"Key2: '{config["Key2"]}'");
|
||||
Console.WriteLine($"Key3: '{config["Key3"]}'");
|
||||
Console.WriteLine($"Key4: '{config["Key4"]}'");
|
||||
Console.WriteLine($"Key5: '{config["Key5"]}'");
|
||||
}
|
||||
}
|
||||
}
|
||||
</code>
|
||||
</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String[],System.Collections.Generic.IDictionary{System.String,System.String})">
|
||||
<summary>
|
||||
Adds a <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads
|
||||
configuration values from the command line using the specified switch mappings.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="args">The command line args.</param>
|
||||
<param name="switchMappings">
|
||||
The switch mappings. A dictionary of short (with prefix "-") and
|
||||
alias keys (with prefix "--"), mapped to the configuration key (no prefix).
|
||||
</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
The <c>switchMappings</c> allows additional formats for alternative short and alias keys
|
||||
to be used from the command line. Also see the basic version of <c>AddCommandLine</c> for
|
||||
the standard formats supported.
|
||||
</para>
|
||||
<para>
|
||||
Short keys start with a single dash ("-") and are mapped to the main key name (without
|
||||
prefix), and can be used with either equals or space. The single dash mappings are intended
|
||||
to be used for shorter alternative switches.
|
||||
</para>
|
||||
<para>
|
||||
Note that a single dash switch cannot be accessed directly, but must have a switch mapping
|
||||
defined and accessed using the full key. Passing an undefined single dash argument will
|
||||
cause as <c>FormatException</c>.
|
||||
</para>
|
||||
<para>
|
||||
There are two formats for short arguments:
|
||||
<c>-k1=value1 -k2 value2</c>.
|
||||
</para>
|
||||
<para>
|
||||
Alias key definitions start with two dashes ("--") and are mapped to the main key name (without
|
||||
prefix), and can be used in place of the normal key. They also work when a forward slash prefix
|
||||
is used in the command line (but not with the no prefix equals format).
|
||||
</para>
|
||||
<para>
|
||||
There are only four formats for aliased arguments:
|
||||
<c>--alt3=value3 /alt4=value4 --alt5 value5 /alt6 value6</c>.
|
||||
</para>
|
||||
</remarks>
|
||||
<example>
|
||||
A simple console application that has two short and four alias switch mappings defined.
|
||||
<code>
|
||||
// dotnet run -k1=value1 -k2 value2 --alt3=value2 /alt4=value3 --alt5 value5 /alt6 value6
|
||||
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
|
||||
namespace CommandLineSample
|
||||
{
|
||||
public class Program
|
||||
{
|
||||
public static void Main(string[] args)
|
||||
{
|
||||
var switchMappings = new Dictionary<string, string>()
|
||||
{
|
||||
{ "-k1", "key1" },
|
||||
{ "-k2", "key2" },
|
||||
{ "--alt3", "key3" },
|
||||
{ "--alt4", "key4" },
|
||||
{ "--alt5", "key5" },
|
||||
{ "--alt6", "key6" },
|
||||
};
|
||||
var builder = new ConfigurationBuilder();
|
||||
builder.AddCommandLine(args, switchMappings);
|
||||
|
||||
var config = builder.Build();
|
||||
|
||||
Console.WriteLine($"Key1: '{config["Key1"]}'");
|
||||
Console.WriteLine($"Key2: '{config["Key2"]}'");
|
||||
Console.WriteLine($"Key3: '{config["Key3"]}'");
|
||||
Console.WriteLine($"Key4: '{config["Key4"]}'");
|
||||
Console.WriteLine($"Key5: '{config["Key5"]}'");
|
||||
Console.WriteLine($"Key6: '{config["Key6"]}'");
|
||||
}
|
||||
}
|
||||
}
|
||||
</code>
|
||||
</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource})">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from the command line.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="configureSource">Configures the source.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider">
|
||||
<summary>
|
||||
Provides configuration key-value pairs that are obtained from the command line.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IDictionary{System.String,System.String})">
|
||||
<summary>
|
||||
Initializes a new instance.
|
||||
</summary>
|
||||
<param name="args">The command line args.</param>
|
||||
<param name="switchMappings">The switch mappings.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.Args">
|
||||
<summary>
|
||||
Gets the command-line arguments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads the configuration data from the command-line arguments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource">
|
||||
<summary>
|
||||
Represents command-line arguments as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.SwitchMappings">
|
||||
<summary>
|
||||
Gets or sets the switch mappings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.Args">
|
||||
<summary>
|
||||
Gets or sets the command line arguments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/>.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_DuplicatedKeyInSwitchMappings">
|
||||
<summary>Keys in switch mappings are case-insensitive. A duplicated key '{0}' was found.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_InvalidSwitchMapping">
|
||||
<summary>The switch mappings contain an invalid switch '{0}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ShortSwitchNotDefined">
|
||||
<summary>The short switch '{0}' is not defined in the switch mappings.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field or property member will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field and property members will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.ExceptionPolyfills">
|
||||
<summary>Provides downlevel polyfills for static methods on Exception-derived types.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
lBUHH+L39V/PWt/qtSwpu1iSifo7PRRf9MEdeuy/wsBp6rHoYsnX7xbP4GJf7diCztWK8krG5qQb7ZjtjpaDLg==
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "2SV60IUAWfluZv2YHNZ+nUOljYHGIsy96FpJs+N9/bgKDYs9qr6DdzPeIhiHrz+XvRzbybvcwtTBf5dKrYN4oA==",
|
||||
"source": "/mnt/e/dev/git.stella-ops.org/local-nugets"
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@@ -0,0 +1,40 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Configuration.EnvironmentVariables</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>Environment variables configuration provider implementation for Microsoft.Extensions.Configuration. This package enables you to read configuration parameters from environment variables. You can use EnvironmentVariablesExtensions.AddEnvironmentVariables extension method on IConfigurationBuilder to add the environment variables configuration provider to the configuration builder.</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.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Configuration" version="10.0.0-rc.2.25502.107" 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.Configuration" 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.Configuration" 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.Configuration" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Configuration" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
@@ -0,0 +1,44 @@
|
||||
## About
|
||||
|
||||
<!-- A description of the package and where one can find more documentation -->
|
||||
|
||||
Environment variables configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read configuration parameters from environment variables. You can use [EnvironmentVariablesExtensions.AddEnvironmentVariables](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.environmentvariablesextensions.addenvironmentvariables) extension method on `IConfigurationBuilder` to add the environment variables configuration provider to the configuration builder.
|
||||
|
||||
## 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 following example shows how to read application configuration from environment variables.
|
||||
|
||||
```cs
|
||||
using System;
|
||||
using Microsoft.Extensions.Configuration;
|
||||
|
||||
class Program
|
||||
{
|
||||
static void Main()
|
||||
{
|
||||
// Build a configuration object from environment variables
|
||||
IConfiguration config = new ConfigurationBuilder()
|
||||
.AddEnvironmentVariables()
|
||||
.Build();
|
||||
|
||||
// Read configuration values
|
||||
Console.WriteLine($"Server: {config["Server"]}");
|
||||
Console.WriteLine($"Database: {config["Database"]}");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
<!-- Links to further documentation -->
|
||||
|
||||
* [Environment variable configuration provider](https://learn.microsoft.com/dotnet/core/extensions/configuration-providers#environment-variable-configuration-provider)
|
||||
* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.environmentvariables)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
<!-- How to provide feedback on this package and contribute to it -->
|
||||
|
||||
Microsoft.Extensions.Configuration.EnvironmentVariables is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Configuration_EnvironmentVariables_net462">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Configuration_EnvironmentVariables_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Configuration.EnvironmentVariables 10.0.0-rc.2.25502.107 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net462 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Configuration_EnvironmentVariables_net8_0">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Configuration_EnvironmentVariables_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Configuration.EnvironmentVariables 10.0.0-rc.2.25502.107 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net8.0 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,81 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.EnvironmentVariables</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider">
|
||||
<summary>
|
||||
Provides configuration key-value pairs that are obtained from environment variables.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance with the specified prefix.
|
||||
</summary>
|
||||
<param name="prefix">A prefix used to filter the environment variables.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads the environment variables.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.ToString">
|
||||
<summary>
|
||||
Generates a string representing this provider name and relevant details.
|
||||
</summary>
|
||||
<returns>The configuration name.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource">
|
||||
<summary>
|
||||
Represents environment variables as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource.Prefix">
|
||||
<summary>
|
||||
A prefix used to filter environment variables.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions">
|
||||
<summary>
|
||||
Provides extension methods for registering <see cref="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider"/> with <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions.AddEnvironmentVariables(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from environment variables.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions.AddEnvironmentVariables(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from environment variables
|
||||
with a specified prefix.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="prefix">The prefix that environment variable names must start with. The prefix will be removed from the environment variable names.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions.AddEnvironmentVariables(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource})">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from environment variables.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="configureSource">The action that configures the source.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,264 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.EnvironmentVariables</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider">
|
||||
<summary>
|
||||
Provides configuration key-value pairs that are obtained from environment variables.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance with the specified prefix.
|
||||
</summary>
|
||||
<param name="prefix">A prefix used to filter the environment variables.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads the environment variables.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.ToString">
|
||||
<summary>
|
||||
Generates a string representing this provider name and relevant details.
|
||||
</summary>
|
||||
<returns>The configuration name.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource">
|
||||
<summary>
|
||||
Represents environment variables as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource.Prefix">
|
||||
<summary>
|
||||
A prefix used to filter environment variables.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions">
|
||||
<summary>
|
||||
Provides extension methods for registering <see cref="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider"/> with <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions.AddEnvironmentVariables(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from environment variables.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions.AddEnvironmentVariables(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from environment variables
|
||||
with a specified prefix.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="prefix">The prefix that environment variable names must start with. The prefix will be removed from the environment variable names.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions.AddEnvironmentVariables(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource})">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from environment variables.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="configureSource">The action that configures the source.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</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>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user