Microsoft.Extensions.Logging.Console
For consoles which understand the ANSI escape code sequences to represent color
Parses a subset of display attributes
Set Display Attributes
Set Attribute Mode [{attr1};...;{attrn}m
Sets multiple display attribute settings. The following lists standard attributes that are getting parsed:
1 Bright
Foreground Colours
30 Black
31 Red
32 Green
33 Yellow
34 Blue
35 Magenta
36 Cyan
37 White
Background Colours
40 Black
41 Red
42 Green
43 Yellow
44 Blue
45 Magenta
46 Cyan
47 White
Allows custom log messages formatting
Gets the name associated with the console log formatter.
Writes the log message to the specified TextWriter.
if the formatter wants to write colors to the console, it can do so by embedding ANSI color codes into the string
The log entry.
The provider of scope data.
The string writer embedding ansi code for colors.
The type of the object to be written.
Reserved formatter names for the built-in console formatters.
Reserved name for simple console formatter
Reserved name for json console formatter
Reserved name for systemd console formatter
Options for the built-in console log formatter.
Includes scopes when .
Gets or sets format string used to format timestamp in logging messages. Defaults to null.
Gets or sets indication whether or not UTC timezone should be used to for timestamps in logging messages. Defaults to false.
Format of messages.
Produces messages in the default console format.
Produces messages in a format suitable for console output to the systemd journal.
Options for a .
Disables colors when .
Gets or sets log message format. Defaults to .
Name of the log message formatter to use. Defaults to "simple" />.
Includes scopes when .
Gets or sets value indicating the minimum level of messages that would get written to Console.Error.
Gets or sets format string used to format timestamp in logging messages. Defaults to null.
Gets or sets indication whether or not UTC timezone should be used to for timestamps in logging messages. Defaults to false.
A provider of instances.
Creates an instance of .
The options to create instances with.
Creates an instance of .
The options to create instances with.
Log formatters added for insteaces.
Options for the built-in json console log formatter.
Gets or sets JsonWriterOptions.
Determines when to use color when logging messages.
Use the default color behavior, enabling color except when the console output is redirected.
Enables color except when the console output is redirected.
Enable color for logging
Disable color for logging
Options for the built-in default console log formatter.
Determines when to use color when logging messages.
When , the entire message gets logged in a single line.
Adds a console logger named 'Console' to the factory.
The to use.
Adds a console logger named 'Console' to the factory.
The to use.
A delegate to configure the .
Add the default console log formatter named 'simple' to the factory with default properties.
The to use.
Add and configure a console log formatter named 'simple' to the factory.
The to use.
A delegate to configure the options for the built-in default log formatter.
Add a console log formatter named 'json' to the factory with default properties.
The to use.
Add and configure a console log formatter named 'json' to the factory.
The to use.
A delegate to configure the options for the built-in json log formatter.
Add and configure a console log formatter named 'systemd' to the factory.
The to use.
A delegate to configure the options for the built-in systemd log formatter.
Add a console log formatter named 'systemd' to the factory with default properties.
The to use.
Adds a custom console logger formatter 'TFormatter' to be configured with options 'TOptions'.
The to use.
Adds a custom console logger formatter 'TFormatter' to be configured with options 'TOptions'.
The to use.
A delegate to configure options 'TOptions' for custom formatter 'TFormatter'.
Scope provider that does nothing.
Returns a cached instance of .
An empty scope without any logic
Indicates that certain members on a specified are accessed dynamically,
for example through .
This allows tools to understand which members are being accessed during the execution
of a program.
This attribute is valid on members whose type is or .
When this attribute is applied to a location of type , the assumption is
that the string represents a fully qualified type name.
When this attribute is applied to a class, interface, or struct, the members specified
can be accessed dynamically on instances returned from calling
on instances of that class, interface, or struct.
If the attribute is applied to a method it's treated as a special case and it implies
the attribute should be applied to the "this" parameter of the method. As such the attribute
should only be used on instance methods of types assignable to System.Type (or string, but no methods
will use it there).
Initializes a new instance of the class
with the specified member types.
The types of members dynamically accessed.
Gets the which specifies the type
of members dynamically accessed.
Specifies the types of members that are dynamically accessed.
This enumeration has a attribute that allows a
bitwise combination of its member values.
Specifies no members.
Specifies the default, parameterless public constructor.
Specifies all public constructors.
Specifies all non-public constructors.
Specifies all public methods.
Specifies all non-public methods.
Specifies all public fields.
Specifies all non-public fields.
Specifies all public nested types.
Specifies all non-public nested types.
Specifies all public properties.
Specifies all non-public properties.
Specifies all public events.
Specifies all non-public events.
Specifies all interfaces implemented by the type.
Specifies all members.
Indicates that the specified method requires dynamic access to code that is not referenced
statically, for example through .
This allows tools to understand which methods are unsafe to call when removing unreferenced
code from an application.
Initializes a new instance of the class
with the specified message.
A message that contains information about the usage of unreferenced code.
Gets a message that contains information about the usage of unreferenced code.
Gets or sets an optional URL that contains more information about the method,
why it requries unreferenced code, and what options a consumer has to deal with it.
Suppresses reporting of a specific rule violation, allowing multiple suppressions on a
single code artifact.
is different than
in that it doesn't have a
. So it is always preserved in the compiled assembly.
Initializes a new instance of the
class, specifying the category of the tool and the identifier for an analysis rule.
The category for the attribute.
The identifier of the analysis rule the attribute applies to.
Gets the category identifying the classification of the attribute.
The property describes the tool or tool analysis category
for which a message suppression attribute applies.
Gets the identifier of the analysis tool rule to be suppressed.
Concatenated together, the and
properties form a unique check identifier.
Gets or sets the scope of the code that is relevant for the attribute.
The Scope property is an optional argument that specifies the metadata scope for which
the attribute is relevant.
Gets or sets a fully qualified path that represents the target of the attribute.
The property is an optional argument identifying the analysis target
of the attribute. An example value is "System.IO.Stream.ctor():System.Void".
Because it is fully qualified, it can be long, particularly for targets such as parameters.
The analysis tool user interface should be capable of automatically formatting the parameter.
Gets or sets an optional argument expanding on exclusion criteria.
The property is an optional argument that specifies additional
exclusion where the literal metadata target is not sufficiently precise. For example,
the cannot be applied within a method,
and it may be desirable to suppress a violation against a statement in the method that will
give a rule violation, but not against all statements in the method.
Gets or sets the justification for suppressing the code analysis message.
Specifies that null is allowed as an input even if the corresponding type disallows it.
Specifies that null is disallowed as an input even if the corresponding type allows it.
Specifies that an output may be null even if the corresponding type disallows it.
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.
Specifies that when a method returns , the parameter may be null even if the corresponding type disallows it.
Initializes the attribute with the specified return value condition.
The return value condition. If the method returns this value, the associated parameter may be null.
Gets the return value condition.
Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it.
Initializes the attribute with the specified return value condition.
The return value condition. If the method returns this value, the associated parameter will not be null.
Gets the return value condition.
Specifies that the output will be non-null if the named parameter is non-null.
Initializes the attribute with the associated parameter name.
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
Gets the associated parameter name.
Applied to a method that will never return under any circumstance.
Specifies that the method will not return if the associated Boolean parameter is passed the specified value.
Initializes the attribute with the specified parameter value.
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
the associated parameter matches this value.
Gets the condition parameter value.
Specifies that the method or property will ensure that the listed field and property members have not-null values.
Initializes the attribute with a field or property member.
The field or property member that is promised to be not-null.
Initializes the attribute with the list of field and property members.
The list of field and property members that are promised to be not-null.
Gets field or property member names.
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.
Initializes the attribute with the specified return value condition and a field or property member.
The return value condition. If the method returns this value, the associated parameter will not be null.
The field or property member that is promised to be not-null.
Initializes the attribute with the specified return value condition and list of field and property members.
The return value condition. If the method returns this value, the associated parameter will not be null.
The list of field and property members that are promised to be not-null.
Gets the return value condition.
Gets field or property member names.
Cannot allocate a buffer of size {0}.
Base type for all platform-specific API attributes.
Records the platform that the project targeted.
Records the operating system (and minimum version) that supports an API. Multiple attributes can be
applied to indicate support on multiple operating systems.
Callers can apply a
or use guards to prevent calls to APIs on unsupported operating systems.
A given platform should only be specified once.
Marks APIs that were removed in a given operating system version.
Primarily used by OS bindings to indicate APIs that are only available in
earlier versions.
Annotates a custom guard field, property or method with a supported platform name and optional version.
Multiple attributes can be applied to indicate guard for multiple supported platforms.
Callers can apply a to a field, property or method
and use that field, property or method in a conditional or assert statements in order to safely call platform specific APIs.
The type of the field or property should be boolean, the method return type should be boolean in order to be used as platform guard.
Annotates the custom guard field, property or method with an unsupported platform name and optional version.
Multiple attributes can be applied to indicate guard for multiple unsupported platforms.
Callers can apply a to a field, property or method
and use that field, property or method in a conditional or assert statements as a guard to safely call APIs unsupported on those platforms.
The type of the field or property should be boolean, the method return type should be boolean in order to be used as platform guard.