Skip to content
DovetailDovetailDovetail

DovetailHostBuilderExtensions Methods

ClassMethods20 members
Base convention extensions
AddIfMissing(DovetailContextBuilder, T)Section titled AddIfMissing(DovetailContextBuilder, T)extensionDovetailContextBuilder
Set key to the value if the type is missing 
public static class DovetailHostBuilderExtensions
{
    public static DovetailContextBuilder AddIfMissing<T>(
        this DovetailContextBuilder builder,
        T value)
    {
        // ...
    }
}

Parameters

builderDovetailContextBuilderThe builder
valueTThe value to save

Exceptions

ArgumentNullExceptionbuilder is null.
AddIfMissing(DovetailContextBuilder, Type, object)Section titled AddIfMissing(DovetailContextBuilder, Type, object)extensionDovetailContextBuilder
Set key to the value if the key is missing 
public static class DovetailHostBuilderExtensions
{
    public static DovetailContextBuilder AddIfMissing(
        this DovetailContextBuilder builder,
        Type key,
        object value)
    {
        // ...
    }
}

Parameters

builderDovetailContextBuilderThe builder
keyTypeThe key where the value is saved
valueobjectThe value to save

Exceptions

ArgumentNullExceptionbuilder is null.
AddIfMissing(DovetailContextBuilder, string, T)Section titled AddIfMissing(DovetailContextBuilder, string, T)extensionDovetailContextBuilder
Set key to the value if the key is missing 
public static class DovetailHostBuilderExtensions
{
    public static DovetailContextBuilder AddIfMissing<T>(
        this DovetailContextBuilder builder,
        string key,
        T value)
    {
        // ...
    }
}

Parameters

builderDovetailContextBuilderThe builder
keystringThe key where the value is saved
valueTThe value to save

Exceptions

ArgumentNullExceptionbuilder is null.
Get(DovetailContextBuilder)Section titled Get(DovetailContextBuilder)extensionnullableT?
Get a value by type from the context 
public static class DovetailHostBuilderExtensions
{
    public static T? Get<T>(
        this DovetailContextBuilder context)
    {
        // ...
    }
}

Parameters

contextDovetailContextBuilderThe context

Returns

T?T.

Exceptions

ArgumentNullExceptioncontext is null.
Get(DovetailContextBuilder, string)Section titled Get(DovetailContextBuilder, string)extensionnullableT?
Get a value by key from the context 
public static class DovetailHostBuilderExtensions
{
    public static T? Get<T>(
        this DovetailContextBuilder context,
        string key)
    {
        // ...
    }
}

Parameters

contextDovetailContextBuilderThe context
keystringThe key where the value is saved

Returns

T?T.

Exceptions

ArgumentNullExceptioncontext is null.
GetHostType(DovetailContextBuilder)Section titled GetHostType(DovetailContextBuilder)extensionDovetailHostType
Get the host type the builder is currently configured for 
public static class DovetailHostBuilderExtensions
{
    public static DovetailHostType GetHostType(
        this DovetailContextBuilder context)
    {
        // ...
    }
}

Parameters

contextDovetailContextBuilderThe context

Returns

DovetailHostTypeThe DovetailHostType for the builder, or DovetailHostType.Undefined if none was registered.
GetOrAdd(DovetailContextBuilder, Func<T>)Section titled GetOrAdd(DovetailContextBuilder, Func<T>)extensionT
Get a value by key from the context 
public static class DovetailHostBuilderExtensions
{
    public static T GetOrAdd<T>(
        this DovetailContextBuilder builder,
        Func<T> factory)
    {
        // ...
    }
}

Parameters

builderDovetailContextBuilderThe builder
factoryFunc<T>The factory method in the event the type is not found

Returns

TT.

Exceptions

ArgumentNullExceptionbuilder or factory is null.
GetOrAdd(DovetailContextBuilder, string, Func<T>)Section titled GetOrAdd(DovetailContextBuilder, string, Func<T>)extensionT
Get a value by key from the context 
public static class DovetailHostBuilderExtensions
{
    public static T GetOrAdd<T>(
        this DovetailContextBuilder builder,
        string key,
        Func<T> factory)
    {
        // ...
    }
}

Parameters

builderDovetailContextBuilderThe builder
keystringThe key where the value is saved
factoryFunc<T>The factory method in the event the type is not found

Returns

TT.

Exceptions

ArgumentNullExceptionbuilder or factory is null.
IsUnitTestHost(DovetailContextBuilder)Section titled IsUnitTestHost(DovetailContextBuilder)extensionbool
Check if this is a test host (to allow conventions to behave differently during unit tests) 
public static class DovetailHostBuilderExtensions
{
    public static bool IsUnitTestHost(
        this DovetailContextBuilder context)
    {
        // ...
    }
}

Parameters

contextDovetailContextBuilderThe context

Returns

booltrue if context is running under DovetailHostType.UnitTest; otherwise, false.

Exceptions

ArgumentNullExceptioncontext is null.
Require(DovetailContextBuilder)Section titled Require(DovetailContextBuilder)extensionT
Get a value by type from the context or throw 
public static class DovetailHostBuilderExtensions
{
    public static T Require<T>(
        this DovetailContextBuilder context)
    {
        // ...
    }
}

Parameters

contextDovetailContextBuilderThe context

Returns

TT.

Exceptions

ArgumentNullExceptioncontext is null.
KeyNotFoundExceptionNo value of type T was found in the context.
Require(DovetailContextBuilder, string)Section titled Require(DovetailContextBuilder, string)extensionT
Get a value by type from the context or throw 
public static class DovetailHostBuilderExtensions
{
    public static T Require<T>(
        this DovetailContextBuilder context,
        string key)
    {
        // ...
    }
}

Parameters

contextDovetailContextBuilderThe context
keystringThe key where the value is saved

Returns

TT.

Exceptions

ArgumentNullExceptioncontext is null.
KeyNotFoundExceptionNo value of type T was found at key.
Set(DovetailContextBuilder, T)Section titled Set(DovetailContextBuilder, T)extensionDovetailContextBuilder
Get a value by type from the context 
public static class DovetailHostBuilderExtensions
{
    public static DovetailContextBuilder Set<T>(
        this DovetailContextBuilder context,
        T value)
    {
        // ...
    }
}

Parameters

contextDovetailContextBuilderThe context
valueTThe value to save

Exceptions

ArgumentNullExceptioncontext is null.
Set(DovetailContextBuilder, Type, object)Section titled Set(DovetailContextBuilder, Type, object)extensionDovetailContextBuilder
Get a value by type from the context 
public static class DovetailHostBuilderExtensions
{
    public static DovetailContextBuilder Set(
        this DovetailContextBuilder context,
        Type key,
        object value)
    {
        // ...
    }
}

Parameters

contextDovetailContextBuilderThe context
keyTypeThe key where the value is saved
valueobjectThe value to save

Exceptions

ArgumentNullExceptioncontext is null.
Set(DovetailContextBuilder, string, T)Section titled Set(DovetailContextBuilder, string, T)extensionDovetailContextBuilder
Get a value by type from the context 
public static class DovetailHostBuilderExtensions
{
    public static DovetailContextBuilder Set<T>(
        this DovetailContextBuilder context,
        string key,
        T value)
    {
        // ...
    }
}

Parameters

contextDovetailContextBuilderThe context
keystringThe key where the value is saved
valueTThe value to save

Exceptions

ArgumentNullExceptioncontext is null.
UseServiceProviderFactory(DovetailContextBuilder, IServiceProviderFactory<TContainerBuilder>)Section titled UseServiceProviderFactory(DovetailContextBuilder, IServiceProviderFactory<TContainerBuilder>)extensionDovetailContextBuilder
Set the service provider factory to be used for hosting or other systems. 
public static class DovetailHostBuilderExtensions
{
    public static DovetailContextBuilder UseServiceProviderFactory<TContainerBuilder>(
        this DovetailContextBuilder builder,
        IServiceProviderFactory<TContainerBuilder> serviceProviderFactory)
    {
        // ...
    }
}

Parameters

builderDovetailContextBuilderThe context builder to configure.
serviceProviderFactoryIServiceProviderFactory<TContainerBuilder>The service provider factory to use.

Returns

DovetailContextBuilderThe builder, for chaining.

Exceptions

ArgumentNullExceptionbuilder is null.
UseServiceProviderFactory(DovetailContextBuilder, Func<IDovetailContext, IServiceCollection, CancellationToken, ValueTask<IServiceProviderFactory<TContainerBuilder>>>)Section titled UseServiceProviderFactory(DovetailContextBuilder, Func<IDovetailContext, IServiceCollection, CancellationToken, ValueTask<IServiceProviderFactory<TContainerBuilder>>>)extensionDovetailContextBuilder
Set the service provider factory to be used for hosting or other systems. 
public static class DovetailHostBuilderExtensions
{
    public static DovetailContextBuilder UseServiceProviderFactory<TContainerBuilder>(
        this DovetailContextBuilder builder,
        Func<IDovetailContext, IServiceCollection, CancellationToken, ValueTask<IServiceProviderFactory<TContainerBuilder>>> serviceProviderFactory)
    {
        // ...
    }
}

Parameters

builderDovetailContextBuilderThe context builder to configure.
serviceProviderFactoryFunc<IDovetailContext, IServiceCollection, CancellationToken, ValueTask<IServiceProviderFactory<TContainerBuilder>>>A factory method that asynchronously produces the service provider factory to use.

Returns

DovetailContextBuilderThe builder, for chaining.

Exceptions

ArgumentNullExceptionbuilder is null.
UseServiceProviderFactory(DovetailContextBuilder, Func<IDovetailContext, IServiceCollection, ValueTask<IServiceProviderFactory<TContainerBuilder>>>)Section titled UseServiceProviderFactory(DovetailContextBuilder, Func<IDovetailContext, IServiceCollection, ValueTask<IServiceProviderFactory<TContainerBuilder>>>)extensionDovetailContextBuilder
Set the service provider factory to be used for hosting or other systems. 
public static class DovetailHostBuilderExtensions
{
    public static DovetailContextBuilder UseServiceProviderFactory<TContainerBuilder>(
        this DovetailContextBuilder builder,
        Func<IDovetailContext, IServiceCollection, ValueTask<IServiceProviderFactory<TContainerBuilder>>> serviceProviderFactory)
    {
        // ...
    }
}

Parameters

builderDovetailContextBuilderThe context builder to configure.
serviceProviderFactoryFunc<IDovetailContext, IServiceCollection, ValueTask<IServiceProviderFactory<TContainerBuilder>>>A factory method that asynchronously produces the service provider factory to use.

Returns

DovetailContextBuilderThe builder, for chaining.

Exceptions

ArgumentNullExceptionbuilder is null.
UseServiceProviderFactory(IDovetailContext, IServiceProviderFactory<TContainerBuilder>)Section titled UseServiceProviderFactory(IDovetailContext, IServiceProviderFactory<TContainerBuilder>)extensionIDovetailContext
Set the service provider factory to be used for hosting or other systems. 
public static class DovetailHostBuilderExtensions
{
    public static IDovetailContext UseServiceProviderFactory<TContainerBuilder>(
        this IDovetailContext builder,
        IServiceProviderFactory<TContainerBuilder> serviceProviderFactory)
    {
        // ...
    }
}

Parameters

builderIDovetailContextThe context to configure.
serviceProviderFactoryIServiceProviderFactory<TContainerBuilder>The service provider factory to use.

Returns

IDovetailContextThe builder, for chaining.

Exceptions

ArgumentNullExceptionbuilder is null.
UseServiceProviderFactory(IDovetailContext, Func<IDovetailContext, IServiceCollection, CancellationToken, ValueTask<IServiceProviderFactory<TContainerBuilder>>>)Section titled UseServiceProviderFactory(IDovetailContext, Func<IDovetailContext, IServiceCollection, CancellationToken, ValueTask<IServiceProviderFactory<TContainerBuilder>>>)extensionIDovetailContext
Set the service provider factory to be used for hosting or other systems. 
public static class DovetailHostBuilderExtensions
{
    public static IDovetailContext UseServiceProviderFactory<TContainerBuilder>(
        this IDovetailContext builder,
        Func<IDovetailContext, IServiceCollection, CancellationToken, ValueTask<IServiceProviderFactory<TContainerBuilder>>> serviceProviderFactory)
    {
        // ...
    }
}

Parameters

builderIDovetailContextThe context to configure.
serviceProviderFactoryFunc<IDovetailContext, IServiceCollection, CancellationToken, ValueTask<IServiceProviderFactory<TContainerBuilder>>>A factory method that asynchronously produces the service provider factory to use.

Returns

IDovetailContextThe builder, for chaining.

Exceptions

ArgumentNullExceptionbuilder is null.
UseServiceProviderFactory(IDovetailContext, Func<IDovetailContext, IServiceCollection, ValueTask<IServiceProviderFactory<TContainerBuilder>>>)Section titled UseServiceProviderFactory(IDovetailContext, Func<IDovetailContext, IServiceCollection, ValueTask<IServiceProviderFactory<TContainerBuilder>>>)extensionIDovetailContext
Set the service provider factory to be used for hosting or other systems. 
public static class DovetailHostBuilderExtensions
{
    public static IDovetailContext UseServiceProviderFactory<TContainerBuilder>(
        this IDovetailContext builder,
        Func<IDovetailContext, IServiceCollection, ValueTask<IServiceProviderFactory<TContainerBuilder>>> serviceProviderFactory)
    {
        // ...
    }
}

Parameters

builderIDovetailContextThe context to configure.
serviceProviderFactoryFunc<IDovetailContext, IServiceCollection, ValueTask<IServiceProviderFactory<TContainerBuilder>>>A factory method that asynchronously produces the service provider factory to use.

Returns

IDovetailContextThe builder, for chaining.

Exceptions

ArgumentNullExceptionbuilder is null.