CreateHostOptions
NexusLabs.Needlr.Hosting¶
CreateHostOptions Class¶
Represents options for creating a host application with logging configuration.
public sealed record CreateHostOptions : System.IEquatable<NexusLabs.Needlr.Hosting.CreateHostOptions>
Inheritance System.Object 🡒 CreateHostOptions
Implements System.IEquatable<CreateHostOptions>
Constructors¶
CreateHostOptions(HostApplicationBuilderSettings) Constructor¶
Initializes a new instance of the CreateHostOptions record with a Microsoft.Extensions.Logging.Abstractions.NullLogger.
public CreateHostOptions(Microsoft.Extensions.Hosting.HostApplicationBuilderSettings? settings=null);
Parameters¶
settings Microsoft.Extensions.Hosting.HostApplicationBuilderSettings
The host application builder settings to use.
CreateHostOptions(HostApplicationBuilderSettings, ILogger) Constructor¶
Initializes a new instance with a logger.
public CreateHostOptions(Microsoft.Extensions.Hosting.HostApplicationBuilderSettings settings, Microsoft.Extensions.Logging.ILogger logger);
Parameters¶
settings Microsoft.Extensions.Hosting.HostApplicationBuilderSettings
The host application builder settings to use.
logger Microsoft.Extensions.Logging.ILogger
The logger instance to use for logging during host creation.
Exceptions¶
System.ArgumentNullException
Thrown when logger is null.
CreateHostOptions(HostApplicationBuilderSettings, Action<IServiceCollection>) Constructor¶
Initializes a new instance with a post-plugin registration callback.
public CreateHostOptions(Microsoft.Extensions.Hosting.HostApplicationBuilderSettings settings, System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection> postPluginRegistrationCallback);
Parameters¶
settings Microsoft.Extensions.Hosting.HostApplicationBuilderSettings
The host application builder settings 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 postPluginRegistrationCallback is null.
CreateHostOptions(HostApplicationBuilderSettings, Action<IServiceCollection>, ILogger) Constructor¶
Initializes a new instance with a post-plugin registration callback and logger.
public CreateHostOptions(Microsoft.Extensions.Hosting.HostApplicationBuilderSettings settings, System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection> postPluginRegistrationCallback, Microsoft.Extensions.Logging.ILogger logger);
Parameters¶
settings Microsoft.Extensions.Hosting.HostApplicationBuilderSettings
The host application builder settings 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 host creation.
Exceptions¶
System.ArgumentNullException
Thrown when postPluginRegistrationCallback or logger is null.
CreateHostOptions(HostApplicationBuilderSettings, IEnumerable<Action<IServiceCollection>>) Constructor¶
Initializes a new instance with pre-plugin registration callbacks.
public CreateHostOptions(Microsoft.Extensions.Hosting.HostApplicationBuilderSettings settings, System.Collections.Generic.IEnumerable<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>> prePluginRegistrationCallbacks);
Parameters¶
settings Microsoft.Extensions.Hosting.HostApplicationBuilderSettings
The host application builder settings to use.
prePluginRegistrationCallbacks System.Collections.Generic.IEnumerable<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>>
Callbacks to execute before plugin registration.
Exceptions¶
System.ArgumentNullException
Thrown when prePluginRegistrationCallbacks is null.
CreateHostOptions(HostApplicationBuilderSettings, IEnumerable<Action<IServiceCollection>>, ILogger) Constructor¶
Initializes a new instance with pre-plugin registration callbacks and logger.
public CreateHostOptions(Microsoft.Extensions.Hosting.HostApplicationBuilderSettings settings, System.Collections.Generic.IEnumerable<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>> prePluginRegistrationCallbacks, Microsoft.Extensions.Logging.ILogger logger);
Parameters¶
settings Microsoft.Extensions.Hosting.HostApplicationBuilderSettings
The host application builder settings 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 host creation.
Exceptions¶
System.ArgumentNullException
Thrown when a parameter is null.
CreateHostOptions(HostApplicationBuilderSettings, IEnumerable<Action<IServiceCollection>>, IEnumerable<Action<IServiceCollection>>) Constructor¶
Initializes a new instance with pre- and post-plugin registration callbacks.
public CreateHostOptions(Microsoft.Extensions.Hosting.HostApplicationBuilderSettings settings, System.Collections.Generic.IEnumerable<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>> prePluginRegistrationCallbacks, System.Collections.Generic.IEnumerable<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>> postPluginRegistrationCallbacks);
Parameters¶
settings Microsoft.Extensions.Hosting.HostApplicationBuilderSettings
The host application builder settings 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.
CreateHostOptions(HostApplicationBuilderSettings, IEnumerable<Action<IServiceCollection>>, IEnumerable<Action<IServiceCollection>>, ILogger) Constructor¶
Initializes a new instance with pre- and post-plugin registration callbacks and logger.
public CreateHostOptions(Microsoft.Extensions.Hosting.HostApplicationBuilderSettings settings, 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¶
settings Microsoft.Extensions.Hosting.HostApplicationBuilderSettings
The host application builder settings 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 host creation.
Exceptions¶
System.ArgumentNullException
Thrown when a parameter is null.
CreateHostOptions(HostApplicationBuilderSettings, IReadOnlyList<Action<IServiceCollection>>, ILogger) Constructor¶
Represents options for creating a host application with logging configuration.
public CreateHostOptions(Microsoft.Extensions.Hosting.HostApplicationBuilderSettings Settings, System.Collections.Generic.IReadOnlyList<System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>> PostPluginRegistrationCallbacks, Microsoft.Extensions.Logging.ILogger Logger);
Parameters¶
Settings Microsoft.Extensions.Hosting.HostApplicationBuilderSettings
The host application builder settings to use when creating the host.
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 host creation.
Properties¶
CreateHostOptions.Default Property¶
Gets the default instance of CreateHostOptions with empty settings and a Microsoft.Extensions.Logging.Abstractions.NullLogger.
Property Value¶
CreateHostOptions.Logger Property¶
The logger instance to use for logging during host creation.
Property Value¶
Microsoft.Extensions.Logging.ILogger
CreateHostOptions.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>>
CreateHostOptions.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>>
CreateHostOptions.Settings Property¶
The host application builder settings to use when creating the host.