nuget updates
This commit is contained in:
StellaOps Bot
@@ -0,0 +1,725 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Serilog.Settings.Configuration</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Serilog.ConfigurationLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Extends <see cref="T:Serilog.LoggerConfiguration"/> with support for System.Configuration appSettings elements.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.ConfigurationLoggerConfigurationExtensions.DefaultSectionName">
|
||||
<summary>
|
||||
Configuration section name required by this package.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.String,Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the provided section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="sectionName">A section name for section which contains a Serilog section.</param>
|
||||
<param name="dependencyContext">The dependency context from which sink/enricher packages can be located. If not supplied, the platform
|
||||
default will be used.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the default section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="dependencyContext">The dependency context from which sink/enricher packages can be located. If not supplied, the platform
|
||||
default will be used.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.ConfigurationSection(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfigurationSection,Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration section. Generally it is preferable to use the other
|
||||
extension method that takes the full configuration object.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configSection">The Serilog configuration section</param>
|
||||
<param name="dependencyContext">The dependency context from which sink/enricher packages can be located. If not supplied, the platform
|
||||
default will be used.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.String,Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the provided section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="sectionName">A section name for section which contains a Serilog section.</param>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the default section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.ConfigurationSection(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfigurationSection,Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration section. Generally it is preferable to use the other
|
||||
extension method that takes the full configuration object.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configSection">The Serilog configuration section</param>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Reflection.Assembly[])">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the provided section name.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="sectionName">A section name for section which contains a Serilog section.</param>
|
||||
<param name="assemblies">A collection of assemblies that contains sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.Reflection.Assembly[])">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the default section name.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="assemblies">A collection of assemblies that contains sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,Serilog.Settings.Configuration.ConfigurationReaderOptions)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the specified context.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="readerOptions">Options to adjust how the configuration object is processed.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ConfigurationAssemblySource">
|
||||
<summary>
|
||||
Defines how the package will identify the assemblies which are scanned for sinks and other Type information.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Settings.Configuration.ConfigurationAssemblySource.UseLoadedAssemblies">
|
||||
<summary>
|
||||
Try to scan the assemblies already in memory. This is the default. If GetEntryAssembly is null, fallback to DLL scanning.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Settings.Configuration.ConfigurationAssemblySource.AlwaysScanDllFiles">
|
||||
<summary>
|
||||
Scan for assemblies in DLLs from the working directory. This is the fallback when GetEntryAssembly is null.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ConfigurationReaderOptions">
|
||||
<summary>
|
||||
Options to adjust how the configuration object is processed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<param name="assemblies">A collection of assemblies that contains sinks and other types.</param>
|
||||
<exception cref="T:System.ArgumentNullException">The <paramref name="assemblies"/> argument is null.</exception>
|
||||
<exception cref="T:System.ArgumentException">The <paramref name="assemblies"/> argument is empty.</exception>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<remarks>Prefer the constructor taking explicit assemblies: <see cref="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])"/>. It's the only one supporting single-file publishing.</remarks>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<param name="dependencyContext">
|
||||
The dependency context from which sink/enricher packages can be located. If <see langword="null"/>, the platform default will be used.
|
||||
</param>
|
||||
<remarks>Prefer the constructor taking explicit assemblies: <see cref="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])"/>. It's the only one supporting single-file publishing.</remarks>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<remarks>Prefer the constructor taking explicit assemblies: <see cref="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])"/>. It's the only one supporting single-file publishing.</remarks>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.SectionName">
|
||||
<summary>
|
||||
The section name for section which contains a Serilog section. Defaults to <c>Serilog</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.FormatProvider">
|
||||
<summary>
|
||||
The <see cref="T:System.IFormatProvider"/> used when converting strings to other object types. Defaults to the invariant culture.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.AllowInternalTypes">
|
||||
<summary>
|
||||
Allows to use internal types for extension methods for sink configuration. Defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.AllowInternalMethods">
|
||||
<summary>
|
||||
Allows to use internal extension methods for sink configuration. Defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.OnLevelSwitchCreated">
|
||||
<summary>
|
||||
Called when a log level switch is created while reading the configuration.
|
||||
Log level switches are created either from the <c>Serilog:LevelSwitches</c> section (declared switches) or the <c>Serilog:MinimumLevel:Override</c> section (minimum level override switches).
|
||||
<list type="bullet">
|
||||
<item>For declared switches, the switch name includes the leading <c>$</c> character.</item>
|
||||
<item>For minimum level override switches, the switch name is the (partial) namespace or type name of the override.</item>
|
||||
</list>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.OnFilterSwitchCreated">
|
||||
<summary>
|
||||
Called when a log filter switch is created while reading the <c>Serilog:FilterSwitches</c> section of the configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ILoggingFilterSwitch">
|
||||
<summary>
|
||||
A log event filter that can be modified at runtime.
|
||||
</summary>
|
||||
<remarks>
|
||||
Under the hood, the logging filter switch is either a <c>Serilog.Expressions.LoggingFilterSwitch</c> or a <c>Serilog.Filters.Expressions.LoggingFilterSwitch</c> instance.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ILoggingFilterSwitch.Expression">
|
||||
<summary>
|
||||
A filter expression against which log events will be tested.
|
||||
Only expressions that evaluate to <c>true</c> are included by the filter. A <c>null</c> expression will accept all events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ResolutionContext">
|
||||
<summary>
|
||||
Keeps track of available elements that are useful when resolving values in the settings system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ResolutionContext.LookUpLevelSwitchByName(System.String)">
|
||||
<summary>
|
||||
Looks up a switch in the declared LoggingLevelSwitches
|
||||
</summary>
|
||||
<param name="switchName">the name of a switch to look up</param>
|
||||
<returns>the LoggingLevelSwitch registered with the name</returns>
|
||||
<exception cref="T:System.InvalidOperationException">if no switch has been registered with <paramref name="switchName"/></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.SurrogateConfigurationMethods">
|
||||
<summary>
|
||||
Contains "fake extension" methods for the Serilog configuration API.
|
||||
By default the settings know how to find extension methods, but some configuration
|
||||
are actually "regular" method calls and would not be found otherwise.
|
||||
|
||||
This static class contains internal methods that can be used instead.
|
||||
|
||||
</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.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.MaybeNullAttribute">
|
||||
<summary>
|
||||
Specifies that an output may be null even if the corresponding type disallows it.
|
||||
</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.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>
|
||||
<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.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.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.SetsRequiredMembersAttribute">
|
||||
<summary>
|
||||
Specifies that this constructor sets all required members for the current type,
|
||||
and callers do not need to set any required members themselves.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute">
|
||||
<summary>
|
||||
Specifies the syntax used in a string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes the <see cref="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute"/> with the identifier of the syntax used.
|
||||
</summary>
|
||||
<param name="syntax">The syntax identifier.</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.#ctor(System.String,System.Object[])">
|
||||
<summary>Initializes the <see cref="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute"/> with the identifier of the syntax used.</summary>
|
||||
<param name="syntax">The syntax identifier.</param>
|
||||
<param name="arguments">Optional arguments associated with the specific syntax employed.</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Syntax">
|
||||
<summary>Gets the identifier of the syntax used.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Arguments">
|
||||
<summary>Optional arguments associated with the specific syntax employed.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.CompositeFormat">
|
||||
<summary>The syntax identifier for strings containing composite formats for string formatting.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.DateOnlyFormat">
|
||||
<summary>The syntax identifier for strings containing date format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.DateTimeFormat">
|
||||
<summary>The syntax identifier for strings containing date and time format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.EnumFormat">
|
||||
<summary>The syntax identifier for strings containing <see cref="T:System.Enum"/> format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat">
|
||||
<summary>The syntax identifier for strings containing <see cref="T:System.Guid"/> format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Json">
|
||||
<summary>The syntax identifier for strings containing JavaScript Object Notation (JSON).</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat">
|
||||
<summary>The syntax identifier for strings containing numeric format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Regex">
|
||||
<summary>The syntax identifier for strings containing regular expressions.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.TimeOnlyFormat">
|
||||
<summary>The syntax identifier for strings containing time format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.TimeSpanFormat">
|
||||
<summary>The syntax identifier for strings containing <see cref="T:System.TimeSpan"/> format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Uri">
|
||||
<summary>The syntax identifier for strings containing URIs.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Xml">
|
||||
<summary>The syntax identifier for strings containing XML.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.UnscopedRefAttribute">
|
||||
<summary>
|
||||
Used to indicate a byref escapes and is not scoped.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
There are several cases where the C# compiler treats a <see langword="ref"/> as implicitly
|
||||
<see langword="scoped"/> - where the compiler does not allow the <see langword="ref"/> to escape the method.
|
||||
</para>
|
||||
<para>
|
||||
For example:
|
||||
<list type="number">
|
||||
<item><see langword="this"/> for <see langword="struct"/> instance methods.</item>
|
||||
<item><see langword="ref"/> parameters that refer to <see langword="ref"/> <see langword="struct"/> types.</item>
|
||||
<item><see langword="out"/> parameters.</item>
|
||||
</list>
|
||||
</para>
|
||||
<para>
|
||||
This attribute is used in those instances where the <see langword="ref"/> should be allowed to escape.
|
||||
</para>
|
||||
<para>
|
||||
Applying this attribute, in any form, has impact on consumers of the applicable API. It is necessary for
|
||||
API authors to understand the lifetime implications of applying this attribute and how it may impact their users.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:System.Index">
|
||||
<summary>Represent a type can be used to index a collection either from the start or the end.</summary>
|
||||
<remarks>
|
||||
Index is used by the C# compiler to support the new index syntax
|
||||
<code>
|
||||
int[] someArray = new int[5] { 1, 2, 3, 4, 5 } ;
|
||||
int lastElement = someArray[^1]; // lastElement = 5
|
||||
</code>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Index.#ctor(System.Int32,System.Boolean)">
|
||||
<summary>Construct an Index using a value and indicating if the index is from the start or from the end.</summary>
|
||||
<param name="value">The index value. it has to be zero or positive number.</param>
|
||||
<param name="fromEnd">Indicating if the index is from the start or from the end.</param>
|
||||
<remarks>
|
||||
If the Index constructed from the end, index value 1 means pointing at the last element and index value 0 means pointing at beyond last element.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Index.Start">
|
||||
<summary>Create an Index pointing at first element.</summary>
|
||||
</member>
|
||||
<member name="P:System.Index.End">
|
||||
<summary>Create an Index pointing at beyond last element.</summary>
|
||||
</member>
|
||||
<member name="M:System.Index.FromStart(System.Int32)">
|
||||
<summary>Create an Index from the start at the position indicated by the value.</summary>
|
||||
<param name="value">The index value from the start.</param>
|
||||
</member>
|
||||
<member name="M:System.Index.FromEnd(System.Int32)">
|
||||
<summary>Create an Index from the end at the position indicated by the value.</summary>
|
||||
<param name="value">The index value from the end.</param>
|
||||
</member>
|
||||
<member name="P:System.Index.Value">
|
||||
<summary>Returns the index value.</summary>
|
||||
</member>
|
||||
<member name="P:System.Index.IsFromEnd">
|
||||
<summary>Indicates whether the index is from the start or the end.</summary>
|
||||
</member>
|
||||
<member name="M:System.Index.GetOffset(System.Int32)">
|
||||
<summary>Calculate the offset from the start using the giving collection length.</summary>
|
||||
<param name="length">The length of the collection that the Index will be used with. length has to be a positive value</param>
|
||||
<remarks>
|
||||
For performance reason, we don't validate the input length parameter and the returned offset value against negative values.
|
||||
we don't validate either the returned offset is greater than the input length.
|
||||
It is expected Index will be used with collections which always have non negative length/count. If the returned offset is negative and
|
||||
then used to index a collection will get out of range exception which will be same affect as the validation.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Index.Equals(System.Object)">
|
||||
<summary>Indicates whether the current Index object is equal to another object of the same type.</summary>
|
||||
<param name="value">An object to compare with this object</param>
|
||||
</member>
|
||||
<member name="M:System.Index.Equals(System.Index)">
|
||||
<summary>Indicates whether the current Index object is equal to another Index object.</summary>
|
||||
<param name="other">An object to compare with this object</param>
|
||||
</member>
|
||||
<member name="M:System.Index.GetHashCode">
|
||||
<summary>Returns the hash code for this instance.</summary>
|
||||
</member>
|
||||
<member name="M:System.Index.op_Implicit(System.Int32)~System.Index">
|
||||
<summary>Converts integer number to an Index.</summary>
|
||||
</member>
|
||||
<member name="M:System.Index.ToString">
|
||||
<summary>Converts the value of the current Index object to its equivalent string representation.</summary>
|
||||
</member>
|
||||
<member name="T:System.Range">
|
||||
<summary>Represent a range has start and end indexes.</summary>
|
||||
<remarks>
|
||||
Range is used by the C# compiler to support the range syntax.
|
||||
<code>
|
||||
int[] someArray = new int[5] { 1, 2, 3, 4, 5 };
|
||||
int[] subArray1 = someArray[0..2]; // { 1, 2 }
|
||||
int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 }
|
||||
</code>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Range.Start">
|
||||
<summary>Represent the inclusive start index of the Range.</summary>
|
||||
</member>
|
||||
<member name="P:System.Range.End">
|
||||
<summary>Represent the exclusive end index of the Range.</summary>
|
||||
</member>
|
||||
<member name="M:System.Range.#ctor(System.Index,System.Index)">
|
||||
<summary>Construct a Range object using the start and end indexes.</summary>
|
||||
<param name="start">Represent the inclusive start index of the range.</param>
|
||||
<param name="end">Represent the exclusive end index of the range.</param>
|
||||
</member>
|
||||
<member name="M:System.Range.Equals(System.Object)">
|
||||
<summary>Indicates whether the current Range object is equal to another object of the same type.</summary>
|
||||
<param name="value">An object to compare with this object</param>
|
||||
</member>
|
||||
<member name="M:System.Range.Equals(System.Range)">
|
||||
<summary>Indicates whether the current Range object is equal to another Range object.</summary>
|
||||
<param name="other">An object to compare with this object</param>
|
||||
</member>
|
||||
<member name="M:System.Range.GetHashCode">
|
||||
<summary>Returns the hash code for this instance.</summary>
|
||||
</member>
|
||||
<member name="M:System.Range.ToString">
|
||||
<summary>Converts the value of the current Range object to its equivalent string representation.</summary>
|
||||
</member>
|
||||
<member name="M:System.Range.StartAt(System.Index)">
|
||||
<summary>Create a Range object starting from start index to the end of the collection.</summary>
|
||||
</member>
|
||||
<member name="M:System.Range.EndAt(System.Index)">
|
||||
<summary>Create a Range object starting from first element in the collection to the end Index.</summary>
|
||||
</member>
|
||||
<member name="P:System.Range.All">
|
||||
<summary>Create a Range object starting from first element to the end.</summary>
|
||||
</member>
|
||||
<member name="M:System.Range.GetOffsetAndLength(System.Int32)">
|
||||
<summary>Calculate the start offset and length of range object using a collection length.</summary>
|
||||
<param name="length">The length of the collection that the range will be used with. length has to be a positive value.</param>
|
||||
<remarks>
|
||||
For performance reason, we don't validate the input length parameter against negative values.
|
||||
It is expected Range will be used with collections which always have non negative length/count.
|
||||
We validate the range is inside the length scope though.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute">
|
||||
<summary>
|
||||
An attribute that allows parameters to receive the expression of other parameters.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute"/> class.
|
||||
</summary>
|
||||
<param name="parameterName">The condition parameter value.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute.ParameterName">
|
||||
<summary>
|
||||
Gets the parameter name the expression is retrieved from.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute">
|
||||
<summary>
|
||||
Indicates that compiler support for a particular feature is required for the location where this attribute is applied.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Creates a new instance of the <see cref="T:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute"/> type.
|
||||
</summary>
|
||||
<param name="featureName">The name of the feature to indicate.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName">
|
||||
<summary>
|
||||
The name of the compiler feature.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.IsOptional">
|
||||
<summary>
|
||||
If true, the compiler can choose to allow access to the location where this attribute is applied if it does not understand <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.RefStructs">
|
||||
<summary>
|
||||
The <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/> used for the ref structs C# feature.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.RequiredMembers">
|
||||
<summary>
|
||||
The <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/> used for the required members C# feature.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute">
|
||||
<summary>
|
||||
Indicates which arguments to a method involving an interpolated string handler should be passed to that handler.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute"/> class.
|
||||
</summary>
|
||||
<param name="argument">The name of the argument that should be passed to the handler.</param>
|
||||
<remarks><see langword="null"/> may be used as the name of the receiver in an instance method.</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute.#ctor(System.String[])">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute"/> class.
|
||||
</summary>
|
||||
<param name="arguments">The names of the arguments that should be passed to the handler.</param>
|
||||
<remarks><see langword="null"/> may be used as the name of the receiver in an instance method.</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute.Arguments">
|
||||
<summary>
|
||||
Gets the names of the arguments that should be passed to the handler.
|
||||
</summary>
|
||||
<remarks><see langword="null"/> may be used as the name of the receiver in an instance method.</remarks>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.InterpolatedStringHandlerAttribute">
|
||||
<summary>
|
||||
Indicates the attributed type is to be used as an interpolated string handler.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.IsExternalInit">
|
||||
<summary>
|
||||
Reserved to be used by the compiler for tracking metadata.
|
||||
This class should not be used by developers in source code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ModuleInitializerAttribute">
|
||||
<summary>
|
||||
Used to indicate to the compiler that a method should be called
|
||||
in its containing module's initializer.
|
||||
</summary>
|
||||
<remarks>
|
||||
When one or more valid methods
|
||||
with this attribute are found in a compilation, the compiler will
|
||||
emit a module initializer which calls each of the attributed methods.
|
||||
|
||||
Certain requirements are imposed on any method targeted with this attribute:
|
||||
- The method must be `static`.
|
||||
- The method must be an ordinary member method, as opposed to a property accessor, constructor, local function, etc.
|
||||
- The method must be parameterless.
|
||||
- The method must return `void`.
|
||||
- The method must not be generic or be contained in a generic type.
|
||||
- The method's effective accessibility must be `internal` or `public`.
|
||||
|
||||
The specification for module initializers in the .NET runtime can be found here:
|
||||
https://github.com/dotnet/runtime/blob/main/docs/design/specs/Ecma-335-Augments.md#module-initializer
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.RequiredMemberAttribute">
|
||||
<summary>
|
||||
Specifies that a type has required members or that a member is required.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.SkipLocalsInitAttribute">
|
||||
<summary>
|
||||
Used to indicate to the compiler that the <c>.locals init</c> flag should not be set in method headers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute"/> class with the specified message.
|
||||
</summary>
|
||||
<param name="message">An optional message associated with this attribute instance.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.Message">
|
||||
<summary>
|
||||
Returns the optional message associated with this attribute instance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.Url">
|
||||
<summary>
|
||||
Returns the optional URL associated with this attribute instance.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,363 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Serilog.Settings.Configuration</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Serilog.ConfigurationLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Extends <see cref="T:Serilog.LoggerConfiguration"/> with support for System.Configuration appSettings elements.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.ConfigurationLoggerConfigurationExtensions.DefaultSectionName">
|
||||
<summary>
|
||||
Configuration section name required by this package.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.String,Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the provided section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="sectionName">A section name for section which contains a Serilog section.</param>
|
||||
<param name="dependencyContext">The dependency context from which sink/enricher packages can be located. If not supplied, the platform
|
||||
default will be used.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the default section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="dependencyContext">The dependency context from which sink/enricher packages can be located. If not supplied, the platform
|
||||
default will be used.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.ConfigurationSection(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfigurationSection,Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration section. Generally it is preferable to use the other
|
||||
extension method that takes the full configuration object.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configSection">The Serilog configuration section</param>
|
||||
<param name="dependencyContext">The dependency context from which sink/enricher packages can be located. If not supplied, the platform
|
||||
default will be used.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.String,Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the provided section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="sectionName">A section name for section which contains a Serilog section.</param>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the default section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.ConfigurationSection(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfigurationSection,Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration section. Generally it is preferable to use the other
|
||||
extension method that takes the full configuration object.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configSection">The Serilog configuration section</param>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Reflection.Assembly[])">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the provided section name.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="sectionName">A section name for section which contains a Serilog section.</param>
|
||||
<param name="assemblies">A collection of assemblies that contains sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.Reflection.Assembly[])">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the default section name.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="assemblies">A collection of assemblies that contains sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,Serilog.Settings.Configuration.ConfigurationReaderOptions)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the specified context.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="readerOptions">Options to adjust how the configuration object is processed.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ConfigurationAssemblySource">
|
||||
<summary>
|
||||
Defines how the package will identify the assemblies which are scanned for sinks and other Type information.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Settings.Configuration.ConfigurationAssemblySource.UseLoadedAssemblies">
|
||||
<summary>
|
||||
Try to scan the assemblies already in memory. This is the default. If GetEntryAssembly is null, fallback to DLL scanning.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Settings.Configuration.ConfigurationAssemblySource.AlwaysScanDllFiles">
|
||||
<summary>
|
||||
Scan for assemblies in DLLs from the working directory. This is the fallback when GetEntryAssembly is null.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ConfigurationReaderOptions">
|
||||
<summary>
|
||||
Options to adjust how the configuration object is processed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<param name="assemblies">A collection of assemblies that contains sinks and other types.</param>
|
||||
<exception cref="T:System.ArgumentNullException">The <paramref name="assemblies"/> argument is null.</exception>
|
||||
<exception cref="T:System.ArgumentException">The <paramref name="assemblies"/> argument is empty.</exception>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<remarks>Prefer the constructor taking explicit assemblies: <see cref="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])"/>. It's the only one supporting single-file publishing.</remarks>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<param name="dependencyContext">
|
||||
The dependency context from which sink/enricher packages can be located. If <see langword="null"/>, the platform default will be used.
|
||||
</param>
|
||||
<remarks>Prefer the constructor taking explicit assemblies: <see cref="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])"/>. It's the only one supporting single-file publishing.</remarks>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<remarks>Prefer the constructor taking explicit assemblies: <see cref="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])"/>. It's the only one supporting single-file publishing.</remarks>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.SectionName">
|
||||
<summary>
|
||||
The section name for section which contains a Serilog section. Defaults to <c>Serilog</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.FormatProvider">
|
||||
<summary>
|
||||
The <see cref="T:System.IFormatProvider"/> used when converting strings to other object types. Defaults to the invariant culture.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.AllowInternalTypes">
|
||||
<summary>
|
||||
Allows to use internal types for extension methods for sink configuration. Defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.AllowInternalMethods">
|
||||
<summary>
|
||||
Allows to use internal extension methods for sink configuration. Defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.OnLevelSwitchCreated">
|
||||
<summary>
|
||||
Called when a log level switch is created while reading the configuration.
|
||||
Log level switches are created either from the <c>Serilog:LevelSwitches</c> section (declared switches) or the <c>Serilog:MinimumLevel:Override</c> section (minimum level override switches).
|
||||
<list type="bullet">
|
||||
<item>For declared switches, the switch name includes the leading <c>$</c> character.</item>
|
||||
<item>For minimum level override switches, the switch name is the (partial) namespace or type name of the override.</item>
|
||||
</list>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.OnFilterSwitchCreated">
|
||||
<summary>
|
||||
Called when a log filter switch is created while reading the <c>Serilog:FilterSwitches</c> section of the configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ILoggingFilterSwitch">
|
||||
<summary>
|
||||
A log event filter that can be modified at runtime.
|
||||
</summary>
|
||||
<remarks>
|
||||
Under the hood, the logging filter switch is either a <c>Serilog.Expressions.LoggingFilterSwitch</c> or a <c>Serilog.Filters.Expressions.LoggingFilterSwitch</c> instance.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ILoggingFilterSwitch.Expression">
|
||||
<summary>
|
||||
A filter expression against which log events will be tested.
|
||||
Only expressions that evaluate to <c>true</c> are included by the filter. A <c>null</c> expression will accept all events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ResolutionContext">
|
||||
<summary>
|
||||
Keeps track of available elements that are useful when resolving values in the settings system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ResolutionContext.LookUpLevelSwitchByName(System.String)">
|
||||
<summary>
|
||||
Looks up a switch in the declared LoggingLevelSwitches
|
||||
</summary>
|
||||
<param name="switchName">the name of a switch to look up</param>
|
||||
<returns>the LoggingLevelSwitch registered with the name</returns>
|
||||
<exception cref="T:System.InvalidOperationException">if no switch has been registered with <paramref name="switchName"/></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.SurrogateConfigurationMethods">
|
||||
<summary>
|
||||
Contains "fake extension" methods for the Serilog configuration API.
|
||||
By default the settings know how to find extension methods, but some configuration
|
||||
are actually "regular" method calls and would not be found otherwise.
|
||||
|
||||
This static class contains internal methods that can be used instead.
|
||||
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.SetsRequiredMembersAttribute">
|
||||
<summary>
|
||||
Specifies that this constructor sets all required members for the current type,
|
||||
and callers do not need to set any required members themselves.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute">
|
||||
<summary>
|
||||
Specifies the syntax used in a string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes the <see cref="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute"/> with the identifier of the syntax used.
|
||||
</summary>
|
||||
<param name="syntax">The syntax identifier.</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.#ctor(System.String,System.Object[])">
|
||||
<summary>Initializes the <see cref="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute"/> with the identifier of the syntax used.</summary>
|
||||
<param name="syntax">The syntax identifier.</param>
|
||||
<param name="arguments">Optional arguments associated with the specific syntax employed.</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Syntax">
|
||||
<summary>Gets the identifier of the syntax used.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Arguments">
|
||||
<summary>Optional arguments associated with the specific syntax employed.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.CompositeFormat">
|
||||
<summary>The syntax identifier for strings containing composite formats for string formatting.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.DateOnlyFormat">
|
||||
<summary>The syntax identifier for strings containing date format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.DateTimeFormat">
|
||||
<summary>The syntax identifier for strings containing date and time format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.EnumFormat">
|
||||
<summary>The syntax identifier for strings containing <see cref="T:System.Enum"/> format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat">
|
||||
<summary>The syntax identifier for strings containing <see cref="T:System.Guid"/> format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Json">
|
||||
<summary>The syntax identifier for strings containing JavaScript Object Notation (JSON).</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat">
|
||||
<summary>The syntax identifier for strings containing numeric format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Regex">
|
||||
<summary>The syntax identifier for strings containing regular expressions.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.TimeOnlyFormat">
|
||||
<summary>The syntax identifier for strings containing time format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.TimeSpanFormat">
|
||||
<summary>The syntax identifier for strings containing <see cref="T:System.TimeSpan"/> format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Uri">
|
||||
<summary>The syntax identifier for strings containing URIs.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Xml">
|
||||
<summary>The syntax identifier for strings containing XML.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.UnscopedRefAttribute">
|
||||
<summary>
|
||||
Used to indicate a byref escapes and is not scoped.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
There are several cases where the C# compiler treats a <see langword="ref"/> as implicitly
|
||||
<see langword="scoped"/> - where the compiler does not allow the <see langword="ref"/> to escape the method.
|
||||
</para>
|
||||
<para>
|
||||
For example:
|
||||
<list type="number">
|
||||
<item><see langword="this"/> for <see langword="struct"/> instance methods.</item>
|
||||
<item><see langword="ref"/> parameters that refer to <see langword="ref"/> <see langword="struct"/> types.</item>
|
||||
<item><see langword="out"/> parameters.</item>
|
||||
</list>
|
||||
</para>
|
||||
<para>
|
||||
This attribute is used in those instances where the <see langword="ref"/> should be allowed to escape.
|
||||
</para>
|
||||
<para>
|
||||
Applying this attribute, in any form, has impact on consumers of the applicable API. It is necessary for
|
||||
API authors to understand the lifetime implications of applying this attribute and how it may impact their users.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute">
|
||||
<summary>
|
||||
Indicates that compiler support for a particular feature is required for the location where this attribute is applied.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Creates a new instance of the <see cref="T:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute"/> type.
|
||||
</summary>
|
||||
<param name="featureName">The name of the feature to indicate.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName">
|
||||
<summary>
|
||||
The name of the compiler feature.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.IsOptional">
|
||||
<summary>
|
||||
If true, the compiler can choose to allow access to the location where this attribute is applied if it does not understand <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.RefStructs">
|
||||
<summary>
|
||||
The <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/> used for the ref structs C# feature.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.RequiredMembers">
|
||||
<summary>
|
||||
The <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/> used for the required members C# feature.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.RequiredMemberAttribute">
|
||||
<summary>
|
||||
Specifies that a type has required members or that a member is required.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,237 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Serilog.Settings.Configuration</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Serilog.ConfigurationLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Extends <see cref="T:Serilog.LoggerConfiguration"/> with support for System.Configuration appSettings elements.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.ConfigurationLoggerConfigurationExtensions.DefaultSectionName">
|
||||
<summary>
|
||||
Configuration section name required by this package.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.String,Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the provided section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="sectionName">A section name for section which contains a Serilog section.</param>
|
||||
<param name="dependencyContext">The dependency context from which sink/enricher packages can be located. If not supplied, the platform
|
||||
default will be used.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the default section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="dependencyContext">The dependency context from which sink/enricher packages can be located. If not supplied, the platform
|
||||
default will be used.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.ConfigurationSection(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfigurationSection,Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration section. Generally it is preferable to use the other
|
||||
extension method that takes the full configuration object.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configSection">The Serilog configuration section</param>
|
||||
<param name="dependencyContext">The dependency context from which sink/enricher packages can be located. If not supplied, the platform
|
||||
default will be used.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.String,Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the provided section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="sectionName">A section name for section which contains a Serilog section.</param>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the default section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.ConfigurationSection(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfigurationSection,Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration section. Generally it is preferable to use the other
|
||||
extension method that takes the full configuration object.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configSection">The Serilog configuration section</param>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Reflection.Assembly[])">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the provided section name.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="sectionName">A section name for section which contains a Serilog section.</param>
|
||||
<param name="assemblies">A collection of assemblies that contains sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.Reflection.Assembly[])">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the default section name.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="assemblies">A collection of assemblies that contains sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,Serilog.Settings.Configuration.ConfigurationReaderOptions)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the specified context.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="readerOptions">Options to adjust how the configuration object is processed.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ConfigurationAssemblySource">
|
||||
<summary>
|
||||
Defines how the package will identify the assemblies which are scanned for sinks and other Type information.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Settings.Configuration.ConfigurationAssemblySource.UseLoadedAssemblies">
|
||||
<summary>
|
||||
Try to scan the assemblies already in memory. This is the default. If GetEntryAssembly is null, fallback to DLL scanning.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Settings.Configuration.ConfigurationAssemblySource.AlwaysScanDllFiles">
|
||||
<summary>
|
||||
Scan for assemblies in DLLs from the working directory. This is the fallback when GetEntryAssembly is null.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ConfigurationReaderOptions">
|
||||
<summary>
|
||||
Options to adjust how the configuration object is processed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<param name="assemblies">A collection of assemblies that contains sinks and other types.</param>
|
||||
<exception cref="T:System.ArgumentNullException">The <paramref name="assemblies"/> argument is null.</exception>
|
||||
<exception cref="T:System.ArgumentException">The <paramref name="assemblies"/> argument is empty.</exception>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<remarks>Prefer the constructor taking explicit assemblies: <see cref="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])"/>. It's the only one supporting single-file publishing.</remarks>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<param name="dependencyContext">
|
||||
The dependency context from which sink/enricher packages can be located. If <see langword="null"/>, the platform default will be used.
|
||||
</param>
|
||||
<remarks>Prefer the constructor taking explicit assemblies: <see cref="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])"/>. It's the only one supporting single-file publishing.</remarks>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<remarks>Prefer the constructor taking explicit assemblies: <see cref="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])"/>. It's the only one supporting single-file publishing.</remarks>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.SectionName">
|
||||
<summary>
|
||||
The section name for section which contains a Serilog section. Defaults to <c>Serilog</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.FormatProvider">
|
||||
<summary>
|
||||
The <see cref="T:System.IFormatProvider"/> used when converting strings to other object types. Defaults to the invariant culture.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.AllowInternalTypes">
|
||||
<summary>
|
||||
Allows to use internal types for extension methods for sink configuration. Defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.AllowInternalMethods">
|
||||
<summary>
|
||||
Allows to use internal extension methods for sink configuration. Defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.OnLevelSwitchCreated">
|
||||
<summary>
|
||||
Called when a log level switch is created while reading the configuration.
|
||||
Log level switches are created either from the <c>Serilog:LevelSwitches</c> section (declared switches) or the <c>Serilog:MinimumLevel:Override</c> section (minimum level override switches).
|
||||
<list type="bullet">
|
||||
<item>For declared switches, the switch name includes the leading <c>$</c> character.</item>
|
||||
<item>For minimum level override switches, the switch name is the (partial) namespace or type name of the override.</item>
|
||||
</list>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.OnFilterSwitchCreated">
|
||||
<summary>
|
||||
Called when a log filter switch is created while reading the <c>Serilog:FilterSwitches</c> section of the configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ILoggingFilterSwitch">
|
||||
<summary>
|
||||
A log event filter that can be modified at runtime.
|
||||
</summary>
|
||||
<remarks>
|
||||
Under the hood, the logging filter switch is either a <c>Serilog.Expressions.LoggingFilterSwitch</c> or a <c>Serilog.Filters.Expressions.LoggingFilterSwitch</c> instance.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ILoggingFilterSwitch.Expression">
|
||||
<summary>
|
||||
A filter expression against which log events will be tested.
|
||||
Only expressions that evaluate to <c>true</c> are included by the filter. A <c>null</c> expression will accept all events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ResolutionContext">
|
||||
<summary>
|
||||
Keeps track of available elements that are useful when resolving values in the settings system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ResolutionContext.LookUpLevelSwitchByName(System.String)">
|
||||
<summary>
|
||||
Looks up a switch in the declared LoggingLevelSwitches
|
||||
</summary>
|
||||
<param name="switchName">the name of a switch to look up</param>
|
||||
<returns>the LoggingLevelSwitch registered with the name</returns>
|
||||
<exception cref="T:System.InvalidOperationException">if no switch has been registered with <paramref name="switchName"/></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.SurrogateConfigurationMethods">
|
||||
<summary>
|
||||
Contains "fake extension" methods for the Serilog configuration API.
|
||||
By default the settings know how to find extension methods, but some configuration
|
||||
are actually "regular" method calls and would not be found otherwise.
|
||||
|
||||
This static class contains internal methods that can be used instead.
|
||||
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,237 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Serilog.Settings.Configuration</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Serilog.ConfigurationLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Extends <see cref="T:Serilog.LoggerConfiguration"/> with support for System.Configuration appSettings elements.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.ConfigurationLoggerConfigurationExtensions.DefaultSectionName">
|
||||
<summary>
|
||||
Configuration section name required by this package.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.String,Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the provided section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="sectionName">A section name for section which contains a Serilog section.</param>
|
||||
<param name="dependencyContext">The dependency context from which sink/enricher packages can be located. If not supplied, the platform
|
||||
default will be used.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the default section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="dependencyContext">The dependency context from which sink/enricher packages can be located. If not supplied, the platform
|
||||
default will be used.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.ConfigurationSection(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfigurationSection,Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration section. Generally it is preferable to use the other
|
||||
extension method that takes the full configuration object.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configSection">The Serilog configuration section</param>
|
||||
<param name="dependencyContext">The dependency context from which sink/enricher packages can be located. If not supplied, the platform
|
||||
default will be used.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.String,Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the provided section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="sectionName">A section name for section which contains a Serilog section.</param>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the default section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.ConfigurationSection(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfigurationSection,Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration section. Generally it is preferable to use the other
|
||||
extension method that takes the full configuration object.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configSection">The Serilog configuration section</param>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Reflection.Assembly[])">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the provided section name.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="sectionName">A section name for section which contains a Serilog section.</param>
|
||||
<param name="assemblies">A collection of assemblies that contains sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.Reflection.Assembly[])">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the default section name.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="assemblies">A collection of assemblies that contains sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,Serilog.Settings.Configuration.ConfigurationReaderOptions)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the specified context.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="readerOptions">Options to adjust how the configuration object is processed.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ConfigurationAssemblySource">
|
||||
<summary>
|
||||
Defines how the package will identify the assemblies which are scanned for sinks and other Type information.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Settings.Configuration.ConfigurationAssemblySource.UseLoadedAssemblies">
|
||||
<summary>
|
||||
Try to scan the assemblies already in memory. This is the default. If GetEntryAssembly is null, fallback to DLL scanning.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Settings.Configuration.ConfigurationAssemblySource.AlwaysScanDllFiles">
|
||||
<summary>
|
||||
Scan for assemblies in DLLs from the working directory. This is the fallback when GetEntryAssembly is null.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ConfigurationReaderOptions">
|
||||
<summary>
|
||||
Options to adjust how the configuration object is processed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<param name="assemblies">A collection of assemblies that contains sinks and other types.</param>
|
||||
<exception cref="T:System.ArgumentNullException">The <paramref name="assemblies"/> argument is null.</exception>
|
||||
<exception cref="T:System.ArgumentException">The <paramref name="assemblies"/> argument is empty.</exception>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<remarks>Prefer the constructor taking explicit assemblies: <see cref="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])"/>. It's the only one supporting single-file publishing.</remarks>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<param name="dependencyContext">
|
||||
The dependency context from which sink/enricher packages can be located. If <see langword="null"/>, the platform default will be used.
|
||||
</param>
|
||||
<remarks>Prefer the constructor taking explicit assemblies: <see cref="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])"/>. It's the only one supporting single-file publishing.</remarks>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<remarks>Prefer the constructor taking explicit assemblies: <see cref="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])"/>. It's the only one supporting single-file publishing.</remarks>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.SectionName">
|
||||
<summary>
|
||||
The section name for section which contains a Serilog section. Defaults to <c>Serilog</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.FormatProvider">
|
||||
<summary>
|
||||
The <see cref="T:System.IFormatProvider"/> used when converting strings to other object types. Defaults to the invariant culture.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.AllowInternalTypes">
|
||||
<summary>
|
||||
Allows to use internal types for extension methods for sink configuration. Defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.AllowInternalMethods">
|
||||
<summary>
|
||||
Allows to use internal extension methods for sink configuration. Defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.OnLevelSwitchCreated">
|
||||
<summary>
|
||||
Called when a log level switch is created while reading the configuration.
|
||||
Log level switches are created either from the <c>Serilog:LevelSwitches</c> section (declared switches) or the <c>Serilog:MinimumLevel:Override</c> section (minimum level override switches).
|
||||
<list type="bullet">
|
||||
<item>For declared switches, the switch name includes the leading <c>$</c> character.</item>
|
||||
<item>For minimum level override switches, the switch name is the (partial) namespace or type name of the override.</item>
|
||||
</list>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.OnFilterSwitchCreated">
|
||||
<summary>
|
||||
Called when a log filter switch is created while reading the <c>Serilog:FilterSwitches</c> section of the configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ILoggingFilterSwitch">
|
||||
<summary>
|
||||
A log event filter that can be modified at runtime.
|
||||
</summary>
|
||||
<remarks>
|
||||
Under the hood, the logging filter switch is either a <c>Serilog.Expressions.LoggingFilterSwitch</c> or a <c>Serilog.Filters.Expressions.LoggingFilterSwitch</c> instance.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ILoggingFilterSwitch.Expression">
|
||||
<summary>
|
||||
A filter expression against which log events will be tested.
|
||||
Only expressions that evaluate to <c>true</c> are included by the filter. A <c>null</c> expression will accept all events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ResolutionContext">
|
||||
<summary>
|
||||
Keeps track of available elements that are useful when resolving values in the settings system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ResolutionContext.LookUpLevelSwitchByName(System.String)">
|
||||
<summary>
|
||||
Looks up a switch in the declared LoggingLevelSwitches
|
||||
</summary>
|
||||
<param name="switchName">the name of a switch to look up</param>
|
||||
<returns>the LoggingLevelSwitch registered with the name</returns>
|
||||
<exception cref="T:System.InvalidOperationException">if no switch has been registered with <paramref name="switchName"/></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.SurrogateConfigurationMethods">
|
||||
<summary>
|
||||
Contains "fake extension" methods for the Serilog configuration API.
|
||||
By default the settings know how to find extension methods, but some configuration
|
||||
are actually "regular" method calls and would not be found otherwise.
|
||||
|
||||
This static class contains internal methods that can be used instead.
|
||||
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,725 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Serilog.Settings.Configuration</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Serilog.ConfigurationLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Extends <see cref="T:Serilog.LoggerConfiguration"/> with support for System.Configuration appSettings elements.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.ConfigurationLoggerConfigurationExtensions.DefaultSectionName">
|
||||
<summary>
|
||||
Configuration section name required by this package.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.String,Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the provided section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="sectionName">A section name for section which contains a Serilog section.</param>
|
||||
<param name="dependencyContext">The dependency context from which sink/enricher packages can be located. If not supplied, the platform
|
||||
default will be used.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the default section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="dependencyContext">The dependency context from which sink/enricher packages can be located. If not supplied, the platform
|
||||
default will be used.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.ConfigurationSection(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfigurationSection,Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration section. Generally it is preferable to use the other
|
||||
extension method that takes the full configuration object.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configSection">The Serilog configuration section</param>
|
||||
<param name="dependencyContext">The dependency context from which sink/enricher packages can be located. If not supplied, the platform
|
||||
default will be used.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.String,Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the provided section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="sectionName">A section name for section which contains a Serilog section.</param>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the default section name. Generally this
|
||||
is preferable over the other method that takes a configuration section. Only this version will populate
|
||||
IConfiguration parameters on target methods.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.ConfigurationSection(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfigurationSection,Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration section. Generally it is preferable to use the other
|
||||
extension method that takes the full configuration object.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configSection">The Serilog configuration section</param>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Reflection.Assembly[])">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the provided section name.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="sectionName">A section name for section which contains a Serilog section.</param>
|
||||
<param name="assemblies">A collection of assemblies that contains sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,System.Reflection.Assembly[])">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the default section name.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="assemblies">A collection of assemblies that contains sinks and other types.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.ConfigurationLoggerConfigurationExtensions.Configuration(Serilog.Configuration.LoggerSettingsConfiguration,Microsoft.Extensions.Configuration.IConfiguration,Serilog.Settings.Configuration.ConfigurationReaderOptions)">
|
||||
<summary>
|
||||
Reads logger settings from the provided configuration object using the specified context.
|
||||
</summary>
|
||||
<param name="settingConfiguration">Logger setting configuration.</param>
|
||||
<param name="configuration">A configuration object which contains a Serilog section.</param>
|
||||
<param name="readerOptions">Options to adjust how the configuration object is processed.</param>
|
||||
<returns>An object allowing configuration to continue.</returns>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ConfigurationAssemblySource">
|
||||
<summary>
|
||||
Defines how the package will identify the assemblies which are scanned for sinks and other Type information.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Settings.Configuration.ConfigurationAssemblySource.UseLoadedAssemblies">
|
||||
<summary>
|
||||
Try to scan the assemblies already in memory. This is the default. If GetEntryAssembly is null, fallback to DLL scanning.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Settings.Configuration.ConfigurationAssemblySource.AlwaysScanDllFiles">
|
||||
<summary>
|
||||
Scan for assemblies in DLLs from the working directory. This is the fallback when GetEntryAssembly is null.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ConfigurationReaderOptions">
|
||||
<summary>
|
||||
Options to adjust how the configuration object is processed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<param name="assemblies">A collection of assemblies that contains sinks and other types.</param>
|
||||
<exception cref="T:System.ArgumentNullException">The <paramref name="assemblies"/> argument is null.</exception>
|
||||
<exception cref="T:System.ArgumentException">The <paramref name="assemblies"/> argument is empty.</exception>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<remarks>Prefer the constructor taking explicit assemblies: <see cref="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])"/>. It's the only one supporting single-file publishing.</remarks>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(Microsoft.Extensions.DependencyModel.DependencyContext)">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<param name="dependencyContext">
|
||||
The dependency context from which sink/enricher packages can be located. If <see langword="null"/>, the platform default will be used.
|
||||
</param>
|
||||
<remarks>Prefer the constructor taking explicit assemblies: <see cref="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])"/>. It's the only one supporting single-file publishing.</remarks>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(Serilog.Settings.Configuration.ConfigurationAssemblySource)">
|
||||
<summary>
|
||||
Initialize a new instance of the <see cref="T:Serilog.Settings.Configuration.ConfigurationReaderOptions"/> class.
|
||||
</summary>
|
||||
<param name="configurationAssemblySource">Defines how the package identifies assemblies to scan for sinks and other types.</param>
|
||||
<remarks>Prefer the constructor taking explicit assemblies: <see cref="M:Serilog.Settings.Configuration.ConfigurationReaderOptions.#ctor(System.Reflection.Assembly[])"/>. It's the only one supporting single-file publishing.</remarks>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.SectionName">
|
||||
<summary>
|
||||
The section name for section which contains a Serilog section. Defaults to <c>Serilog</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.FormatProvider">
|
||||
<summary>
|
||||
The <see cref="T:System.IFormatProvider"/> used when converting strings to other object types. Defaults to the invariant culture.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.AllowInternalTypes">
|
||||
<summary>
|
||||
Allows to use internal types for extension methods for sink configuration. Defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.AllowInternalMethods">
|
||||
<summary>
|
||||
Allows to use internal extension methods for sink configuration. Defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.OnLevelSwitchCreated">
|
||||
<summary>
|
||||
Called when a log level switch is created while reading the configuration.
|
||||
Log level switches are created either from the <c>Serilog:LevelSwitches</c> section (declared switches) or the <c>Serilog:MinimumLevel:Override</c> section (minimum level override switches).
|
||||
<list type="bullet">
|
||||
<item>For declared switches, the switch name includes the leading <c>$</c> character.</item>
|
||||
<item>For minimum level override switches, the switch name is the (partial) namespace or type name of the override.</item>
|
||||
</list>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ConfigurationReaderOptions.OnFilterSwitchCreated">
|
||||
<summary>
|
||||
Called when a log filter switch is created while reading the <c>Serilog:FilterSwitches</c> section of the configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ILoggingFilterSwitch">
|
||||
<summary>
|
||||
A log event filter that can be modified at runtime.
|
||||
</summary>
|
||||
<remarks>
|
||||
Under the hood, the logging filter switch is either a <c>Serilog.Expressions.LoggingFilterSwitch</c> or a <c>Serilog.Filters.Expressions.LoggingFilterSwitch</c> instance.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Serilog.Settings.Configuration.ILoggingFilterSwitch.Expression">
|
||||
<summary>
|
||||
A filter expression against which log events will be tested.
|
||||
Only expressions that evaluate to <c>true</c> are included by the filter. A <c>null</c> expression will accept all events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.ResolutionContext">
|
||||
<summary>
|
||||
Keeps track of available elements that are useful when resolving values in the settings system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Settings.Configuration.ResolutionContext.LookUpLevelSwitchByName(System.String)">
|
||||
<summary>
|
||||
Looks up a switch in the declared LoggingLevelSwitches
|
||||
</summary>
|
||||
<param name="switchName">the name of a switch to look up</param>
|
||||
<returns>the LoggingLevelSwitch registered with the name</returns>
|
||||
<exception cref="T:System.InvalidOperationException">if no switch has been registered with <paramref name="switchName"/></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.Settings.Configuration.SurrogateConfigurationMethods">
|
||||
<summary>
|
||||
Contains "fake extension" methods for the Serilog configuration API.
|
||||
By default the settings know how to find extension methods, but some configuration
|
||||
are actually "regular" method calls and would not be found otherwise.
|
||||
|
||||
This static class contains internal methods that can be used instead.
|
||||
|
||||
</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.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.MaybeNullAttribute">
|
||||
<summary>
|
||||
Specifies that an output may be null even if the corresponding type disallows it.
|
||||
</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.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>
|
||||
<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.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.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.SetsRequiredMembersAttribute">
|
||||
<summary>
|
||||
Specifies that this constructor sets all required members for the current type,
|
||||
and callers do not need to set any required members themselves.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute">
|
||||
<summary>
|
||||
Specifies the syntax used in a string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes the <see cref="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute"/> with the identifier of the syntax used.
|
||||
</summary>
|
||||
<param name="syntax">The syntax identifier.</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.#ctor(System.String,System.Object[])">
|
||||
<summary>Initializes the <see cref="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute"/> with the identifier of the syntax used.</summary>
|
||||
<param name="syntax">The syntax identifier.</param>
|
||||
<param name="arguments">Optional arguments associated with the specific syntax employed.</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Syntax">
|
||||
<summary>Gets the identifier of the syntax used.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Arguments">
|
||||
<summary>Optional arguments associated with the specific syntax employed.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.CompositeFormat">
|
||||
<summary>The syntax identifier for strings containing composite formats for string formatting.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.DateOnlyFormat">
|
||||
<summary>The syntax identifier for strings containing date format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.DateTimeFormat">
|
||||
<summary>The syntax identifier for strings containing date and time format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.EnumFormat">
|
||||
<summary>The syntax identifier for strings containing <see cref="T:System.Enum"/> format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat">
|
||||
<summary>The syntax identifier for strings containing <see cref="T:System.Guid"/> format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Json">
|
||||
<summary>The syntax identifier for strings containing JavaScript Object Notation (JSON).</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat">
|
||||
<summary>The syntax identifier for strings containing numeric format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Regex">
|
||||
<summary>The syntax identifier for strings containing regular expressions.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.TimeOnlyFormat">
|
||||
<summary>The syntax identifier for strings containing time format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.TimeSpanFormat">
|
||||
<summary>The syntax identifier for strings containing <see cref="T:System.TimeSpan"/> format specifiers.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Uri">
|
||||
<summary>The syntax identifier for strings containing URIs.</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Xml">
|
||||
<summary>The syntax identifier for strings containing XML.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.UnscopedRefAttribute">
|
||||
<summary>
|
||||
Used to indicate a byref escapes and is not scoped.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
There are several cases where the C# compiler treats a <see langword="ref"/> as implicitly
|
||||
<see langword="scoped"/> - where the compiler does not allow the <see langword="ref"/> to escape the method.
|
||||
</para>
|
||||
<para>
|
||||
For example:
|
||||
<list type="number">
|
||||
<item><see langword="this"/> for <see langword="struct"/> instance methods.</item>
|
||||
<item><see langword="ref"/> parameters that refer to <see langword="ref"/> <see langword="struct"/> types.</item>
|
||||
<item><see langword="out"/> parameters.</item>
|
||||
</list>
|
||||
</para>
|
||||
<para>
|
||||
This attribute is used in those instances where the <see langword="ref"/> should be allowed to escape.
|
||||
</para>
|
||||
<para>
|
||||
Applying this attribute, in any form, has impact on consumers of the applicable API. It is necessary for
|
||||
API authors to understand the lifetime implications of applying this attribute and how it may impact their users.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:System.Index">
|
||||
<summary>Represent a type can be used to index a collection either from the start or the end.</summary>
|
||||
<remarks>
|
||||
Index is used by the C# compiler to support the new index syntax
|
||||
<code>
|
||||
int[] someArray = new int[5] { 1, 2, 3, 4, 5 } ;
|
||||
int lastElement = someArray[^1]; // lastElement = 5
|
||||
</code>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Index.#ctor(System.Int32,System.Boolean)">
|
||||
<summary>Construct an Index using a value and indicating if the index is from the start or from the end.</summary>
|
||||
<param name="value">The index value. it has to be zero or positive number.</param>
|
||||
<param name="fromEnd">Indicating if the index is from the start or from the end.</param>
|
||||
<remarks>
|
||||
If the Index constructed from the end, index value 1 means pointing at the last element and index value 0 means pointing at beyond last element.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Index.Start">
|
||||
<summary>Create an Index pointing at first element.</summary>
|
||||
</member>
|
||||
<member name="P:System.Index.End">
|
||||
<summary>Create an Index pointing at beyond last element.</summary>
|
||||
</member>
|
||||
<member name="M:System.Index.FromStart(System.Int32)">
|
||||
<summary>Create an Index from the start at the position indicated by the value.</summary>
|
||||
<param name="value">The index value from the start.</param>
|
||||
</member>
|
||||
<member name="M:System.Index.FromEnd(System.Int32)">
|
||||
<summary>Create an Index from the end at the position indicated by the value.</summary>
|
||||
<param name="value">The index value from the end.</param>
|
||||
</member>
|
||||
<member name="P:System.Index.Value">
|
||||
<summary>Returns the index value.</summary>
|
||||
</member>
|
||||
<member name="P:System.Index.IsFromEnd">
|
||||
<summary>Indicates whether the index is from the start or the end.</summary>
|
||||
</member>
|
||||
<member name="M:System.Index.GetOffset(System.Int32)">
|
||||
<summary>Calculate the offset from the start using the giving collection length.</summary>
|
||||
<param name="length">The length of the collection that the Index will be used with. length has to be a positive value</param>
|
||||
<remarks>
|
||||
For performance reason, we don't validate the input length parameter and the returned offset value against negative values.
|
||||
we don't validate either the returned offset is greater than the input length.
|
||||
It is expected Index will be used with collections which always have non negative length/count. If the returned offset is negative and
|
||||
then used to index a collection will get out of range exception which will be same affect as the validation.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Index.Equals(System.Object)">
|
||||
<summary>Indicates whether the current Index object is equal to another object of the same type.</summary>
|
||||
<param name="value">An object to compare with this object</param>
|
||||
</member>
|
||||
<member name="M:System.Index.Equals(System.Index)">
|
||||
<summary>Indicates whether the current Index object is equal to another Index object.</summary>
|
||||
<param name="other">An object to compare with this object</param>
|
||||
</member>
|
||||
<member name="M:System.Index.GetHashCode">
|
||||
<summary>Returns the hash code for this instance.</summary>
|
||||
</member>
|
||||
<member name="M:System.Index.op_Implicit(System.Int32)~System.Index">
|
||||
<summary>Converts integer number to an Index.</summary>
|
||||
</member>
|
||||
<member name="M:System.Index.ToString">
|
||||
<summary>Converts the value of the current Index object to its equivalent string representation.</summary>
|
||||
</member>
|
||||
<member name="T:System.Range">
|
||||
<summary>Represent a range has start and end indexes.</summary>
|
||||
<remarks>
|
||||
Range is used by the C# compiler to support the range syntax.
|
||||
<code>
|
||||
int[] someArray = new int[5] { 1, 2, 3, 4, 5 };
|
||||
int[] subArray1 = someArray[0..2]; // { 1, 2 }
|
||||
int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 }
|
||||
</code>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Range.Start">
|
||||
<summary>Represent the inclusive start index of the Range.</summary>
|
||||
</member>
|
||||
<member name="P:System.Range.End">
|
||||
<summary>Represent the exclusive end index of the Range.</summary>
|
||||
</member>
|
||||
<member name="M:System.Range.#ctor(System.Index,System.Index)">
|
||||
<summary>Construct a Range object using the start and end indexes.</summary>
|
||||
<param name="start">Represent the inclusive start index of the range.</param>
|
||||
<param name="end">Represent the exclusive end index of the range.</param>
|
||||
</member>
|
||||
<member name="M:System.Range.Equals(System.Object)">
|
||||
<summary>Indicates whether the current Range object is equal to another object of the same type.</summary>
|
||||
<param name="value">An object to compare with this object</param>
|
||||
</member>
|
||||
<member name="M:System.Range.Equals(System.Range)">
|
||||
<summary>Indicates whether the current Range object is equal to another Range object.</summary>
|
||||
<param name="other">An object to compare with this object</param>
|
||||
</member>
|
||||
<member name="M:System.Range.GetHashCode">
|
||||
<summary>Returns the hash code for this instance.</summary>
|
||||
</member>
|
||||
<member name="M:System.Range.ToString">
|
||||
<summary>Converts the value of the current Range object to its equivalent string representation.</summary>
|
||||
</member>
|
||||
<member name="M:System.Range.StartAt(System.Index)">
|
||||
<summary>Create a Range object starting from start index to the end of the collection.</summary>
|
||||
</member>
|
||||
<member name="M:System.Range.EndAt(System.Index)">
|
||||
<summary>Create a Range object starting from first element in the collection to the end Index.</summary>
|
||||
</member>
|
||||
<member name="P:System.Range.All">
|
||||
<summary>Create a Range object starting from first element to the end.</summary>
|
||||
</member>
|
||||
<member name="M:System.Range.GetOffsetAndLength(System.Int32)">
|
||||
<summary>Calculate the start offset and length of range object using a collection length.</summary>
|
||||
<param name="length">The length of the collection that the range will be used with. length has to be a positive value.</param>
|
||||
<remarks>
|
||||
For performance reason, we don't validate the input length parameter against negative values.
|
||||
It is expected Range will be used with collections which always have non negative length/count.
|
||||
We validate the range is inside the length scope though.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute">
|
||||
<summary>
|
||||
An attribute that allows parameters to receive the expression of other parameters.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute"/> class.
|
||||
</summary>
|
||||
<param name="parameterName">The condition parameter value.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute.ParameterName">
|
||||
<summary>
|
||||
Gets the parameter name the expression is retrieved from.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute">
|
||||
<summary>
|
||||
Indicates that compiler support for a particular feature is required for the location where this attribute is applied.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Creates a new instance of the <see cref="T:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute"/> type.
|
||||
</summary>
|
||||
<param name="featureName">The name of the feature to indicate.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName">
|
||||
<summary>
|
||||
The name of the compiler feature.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.IsOptional">
|
||||
<summary>
|
||||
If true, the compiler can choose to allow access to the location where this attribute is applied if it does not understand <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.RefStructs">
|
||||
<summary>
|
||||
The <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/> used for the ref structs C# feature.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.RequiredMembers">
|
||||
<summary>
|
||||
The <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/> used for the required members C# feature.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute">
|
||||
<summary>
|
||||
Indicates which arguments to a method involving an interpolated string handler should be passed to that handler.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute"/> class.
|
||||
</summary>
|
||||
<param name="argument">The name of the argument that should be passed to the handler.</param>
|
||||
<remarks><see langword="null"/> may be used as the name of the receiver in an instance method.</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute.#ctor(System.String[])">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute"/> class.
|
||||
</summary>
|
||||
<param name="arguments">The names of the arguments that should be passed to the handler.</param>
|
||||
<remarks><see langword="null"/> may be used as the name of the receiver in an instance method.</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute.Arguments">
|
||||
<summary>
|
||||
Gets the names of the arguments that should be passed to the handler.
|
||||
</summary>
|
||||
<remarks><see langword="null"/> may be used as the name of the receiver in an instance method.</remarks>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.InterpolatedStringHandlerAttribute">
|
||||
<summary>
|
||||
Indicates the attributed type is to be used as an interpolated string handler.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.IsExternalInit">
|
||||
<summary>
|
||||
Reserved to be used by the compiler for tracking metadata.
|
||||
This class should not be used by developers in source code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ModuleInitializerAttribute">
|
||||
<summary>
|
||||
Used to indicate to the compiler that a method should be called
|
||||
in its containing module's initializer.
|
||||
</summary>
|
||||
<remarks>
|
||||
When one or more valid methods
|
||||
with this attribute are found in a compilation, the compiler will
|
||||
emit a module initializer which calls each of the attributed methods.
|
||||
|
||||
Certain requirements are imposed on any method targeted with this attribute:
|
||||
- The method must be `static`.
|
||||
- The method must be an ordinary member method, as opposed to a property accessor, constructor, local function, etc.
|
||||
- The method must be parameterless.
|
||||
- The method must return `void`.
|
||||
- The method must not be generic or be contained in a generic type.
|
||||
- The method's effective accessibility must be `internal` or `public`.
|
||||
|
||||
The specification for module initializers in the .NET runtime can be found here:
|
||||
https://github.com/dotnet/runtime/blob/main/docs/design/specs/Ecma-335-Augments.md#module-initializer
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.RequiredMemberAttribute">
|
||||
<summary>
|
||||
Specifies that a type has required members or that a member is required.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.SkipLocalsInitAttribute">
|
||||
<summary>
|
||||
Used to indicate to the compiler that the <c>.locals init</c> flag should not be set in method headers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute"/> class with the specified message.
|
||||
</summary>
|
||||
<param name="message">An optional message associated with this attribute instance.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.Message">
|
||||
<summary>
|
||||
Returns the optional message associated with this attribute instance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.Url">
|
||||
<summary>
|
||||
Returns the optional URL associated with this attribute instance.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Reference in New Issue
Block a user