Skip to content

CreateWebApplicationOptions

NexusLabs.Needlr.AspNet

CreateWebApplicationOptions Class

Represents options for creating a web application with logging configuration.

public sealed record CreateWebApplicationOptions : System.IEquatable<NexusLabs.Needlr.AspNet.CreateWebApplicationOptions>

Inheritance System.Object 🡒 CreateWebApplicationOptions

Implements System.IEquatable<CreateWebApplicationOptions>

Constructors

CreateWebApplicationOptions(WebApplicationOptions) Constructor

Initializes a new instance of the CreateWebApplicationOptions record with a Microsoft.Extensions.Logging.Abstractions.NullLogger.

public CreateWebApplicationOptions(Microsoft.AspNetCore.Builder.WebApplicationOptions options);

Parameters

options Microsoft.AspNetCore.Builder.WebApplicationOptions

The web application options to use.

Exceptions

System.ArgumentNullException
Thrown when options is null.

CreateWebApplicationOptions(WebApplicationOptions, ILogger) Constructor

Initializes a new instance of the CreateWebApplicationOptions record with a Microsoft.Extensions.Logging.Abstractions.NullLogger.

public CreateWebApplicationOptions(Microsoft.AspNetCore.Builder.WebApplicationOptions options, Microsoft.Extensions.Logging.ILogger logger);

Parameters

options Microsoft.AspNetCore.Builder.WebApplicationOptions

The web application options to use.

logger Microsoft.Extensions.Logging.ILogger

The logger instance to use for logging during application creation.

Exceptions

System.ArgumentNullException
Thrown when options or logger is null.

CreateWebApplicationOptions(WebApplicationOptions, Action<IServiceCollection>) Constructor

Initializes a new instance of the CreateWebApplicationOptions record with a Microsoft.Extensions.Logging.Abstractions.NullLogger.

public CreateWebApplicationOptions(Microsoft.AspNetCore.Builder.WebApplicationOptions options, System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection> postPluginRegistrationCallback);

Parameters

options Microsoft.AspNetCore.Builder.WebApplicationOptions

The web application options to use.

postPluginRegistrationCallback System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>

The callback to execute after plugin registration, allowing for additional service configuration.

Exceptions

System.ArgumentNullException
Thrown when options, or postPluginRegistrationCallback is null.

CreateWebApplicationOptions(WebApplicationOptions, Action<IServiceCollection>, ILogger) Constructor

Initializes a new instance of the CreateWebApplicationOptions record with a Microsoft.Extensions.Logging.Abstractions.NullLogger.

public CreateWebApplicationOptions(Microsoft.AspNetCore.Builder.WebApplicationOptions options, System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection> postPluginRegistrationCallback, Microsoft.Extensions.Logging.ILogger logger);

Parameters

options Microsoft.AspNetCore.Builder.WebApplicationOptions

The web application options to use.

postPluginRegistrationCallback System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>

The callback to execute after plugin registration, allowing for additional service configuration.

logger Microsoft.Extensions.Logging.ILogger

The logger instance to use for logging during application creation.

Exceptions

System.ArgumentNullException
Thrown when options, postPluginRegistrationCallback, or logger is null.

CreateWebApplicationOptions(WebApplicationOptions, IEnumerable<Action<IServiceCollection>>) Constructor

Initializes a new instance with pre-plugin registration callbacks.

public CreateWebApplicationOptions(Microsoft.AspNetCore.Builder.WebApplicationOptions options, System.Collections.Generic.IEnumerable<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>> prePluginRegistrationCallbacks);

Parameters

options Microsoft.AspNetCore.Builder.WebApplicationOptions

The web application options to use.

prePluginRegistrationCallbacks System.Collections.Generic.IEnumerable<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>>

Callbacks to execute before plugin registration.

Exceptions

System.ArgumentNullException
Thrown when options or prePluginRegistrationCallbacks is null.

CreateWebApplicationOptions(WebApplicationOptions, IEnumerable<Action<IServiceCollection>>, ILogger) Constructor

Initializes a new instance with pre-plugin registration callbacks and logger.

public CreateWebApplicationOptions(Microsoft.AspNetCore.Builder.WebApplicationOptions options, System.Collections.Generic.IEnumerable<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>> prePluginRegistrationCallbacks, Microsoft.Extensions.Logging.ILogger logger);

Parameters

options Microsoft.AspNetCore.Builder.WebApplicationOptions

The web application options to use.

prePluginRegistrationCallbacks System.Collections.Generic.IEnumerable<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>>

Callbacks to execute before plugin registration.

logger Microsoft.Extensions.Logging.ILogger

The logger instance to use for logging during application creation.

Exceptions

System.ArgumentNullException
Thrown when a parameter is null.

CreateWebApplicationOptions(WebApplicationOptions, IEnumerable<Action<IServiceCollection>>, IEnumerable<Action<IServiceCollection>>) Constructor

Initializes a new instance with pre- and post-plugin registration callbacks.

public CreateWebApplicationOptions(Microsoft.AspNetCore.Builder.WebApplicationOptions options, System.Collections.Generic.IEnumerable<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>> prePluginRegistrationCallbacks, System.Collections.Generic.IEnumerable<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>> postPluginRegistrationCallbacks);

Parameters

options Microsoft.AspNetCore.Builder.WebApplicationOptions

The web application options to use.

prePluginRegistrationCallbacks System.Collections.Generic.IEnumerable<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>>

Callbacks to execute before plugin registration.

postPluginRegistrationCallbacks System.Collections.Generic.IEnumerable<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>>

Callbacks to execute after plugin registration.

Exceptions

System.ArgumentNullException
Thrown when a parameter is null.

CreateWebApplicationOptions(WebApplicationOptions, IEnumerable<Action<IServiceCollection>>, IEnumerable<Action<IServiceCollection>>, ILogger) Constructor

Initializes a new instance with pre- and post-plugin registration callbacks and logger.

public CreateWebApplicationOptions(Microsoft.AspNetCore.Builder.WebApplicationOptions options, System.Collections.Generic.IEnumerable<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>> prePluginRegistrationCallbacks, System.Collections.Generic.IEnumerable<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>> postPluginRegistrationCallbacks, Microsoft.Extensions.Logging.ILogger logger);

Parameters

options Microsoft.AspNetCore.Builder.WebApplicationOptions

The web application options to use.

prePluginRegistrationCallbacks System.Collections.Generic.IEnumerable<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>>

Callbacks to execute before plugin registration.

postPluginRegistrationCallbacks System.Collections.Generic.IEnumerable<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>>

Callbacks to execute after plugin registration.

logger Microsoft.Extensions.Logging.ILogger

The logger instance to use for logging during application creation.

Exceptions

System.ArgumentNullException
Thrown when a parameter is null.

CreateWebApplicationOptions(WebApplicationOptions, IReadOnlyList<Action<IServiceCollection>>, ILogger) Constructor

Represents options for creating a web application with logging configuration.

public CreateWebApplicationOptions(Microsoft.AspNetCore.Builder.WebApplicationOptions Options, System.Collections.Generic.IReadOnlyList<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>> PostPluginRegistrationCallbacks, Microsoft.Extensions.Logging.ILogger Logger);

Parameters

Options Microsoft.AspNetCore.Builder.WebApplicationOptions

The web application options to use when creating the application.

PostPluginRegistrationCallbacks System.Collections.Generic.IReadOnlyList<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>>

The callbacks to execute after plugin registration, allowing for additional service configuration.

Logger Microsoft.Extensions.Logging.ILogger

The logger instance to use for logging during application creation.

Properties

CreateWebApplicationOptions.Default Property

Gets the default instance of CreateWebApplicationOptions with empty Microsoft.AspNetCore.Builder.WebApplicationOptions and a Microsoft.Extensions.Logging.Abstractions.NullLogger.

public static NexusLabs.Needlr.AspNet.CreateWebApplicationOptions Default { get; }

Property Value

CreateWebApplicationOptions

CreateWebApplicationOptions.Logger Property

The logger instance to use for logging during application creation.

public Microsoft.Extensions.Logging.ILogger Logger { get; init; }

Property Value

Microsoft.Extensions.Logging.ILogger

CreateWebApplicationOptions.Options Property

The web application options to use when creating the application.

public Microsoft.AspNetCore.Builder.WebApplicationOptions Options { get; init; }

Property Value

Microsoft.AspNetCore.Builder.WebApplicationOptions

CreateWebApplicationOptions.PostPluginRegistrationCallbacks Property

The callbacks to execute after plugin registration, allowing for additional service configuration.

public System.Collections.Generic.IReadOnlyList<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>> PostPluginRegistrationCallbacks { get; init; }

Property Value

System.Collections.Generic.IReadOnlyList<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>>

CreateWebApplicationOptions.PrePluginRegistrationCallbacks Property

Callbacks to execute before plugin registration to allow configuring the service collection.

public System.Collections.Generic.IReadOnlyList<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>> PrePluginRegistrationCallbacks { get; init; }

Property Value

System.Collections.Generic.IReadOnlyList<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>>