Class ImageSharpBuilderExtensions

Extension methods for IImageSharpBuilder that allow configuration of services.

Inheritance

Object

ImageSharpBuilderExtensions

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: SixLabors.ImageSharp.Web.DependencyInjection

Assembly: SixLabors.ImageSharp.Web.dll

Syntax

public static class ImageSharpBuilderExtensions

Methods

AddConverter<TConverter>(IImageSharpBuilder)

Adds the given ICommandConverter to the converter collection within the service collection.

Declaration

public static IImageSharpBuilder AddConverter<TConverter>(this IImageSharpBuilder builder)
    where TConverter : class, ICommandConverter

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

Type Parameters

Name	Description
TConverter	The type of class implementing ICommandConverterto add.

AddConverter<TConverter>(IImageSharpBuilder, Func<IServiceProvider, TConverter>)

Adds the given ICommandConverter to the converter collection within the service collection.

Declaration

public static IImageSharpBuilder AddConverter<TConverter>(this IImageSharpBuilder builder, Func<IServiceProvider, TConverter> implementationFactory)
    where TConverter : class, ICommandConverter

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.
Func<IServiceProvider, TConverter>	implementationFactory	The factory method for returning a ICommandConverter.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

Type Parameters

Name	Description
TConverter	The type of class implementing ICommandConverterto add.

AddProcessor<TProcessor>(IImageSharpBuilder)

Adds the given IImageWebProcessor to the processor collection within the service collection.

Declaration

public static IImageSharpBuilder AddProcessor<TProcessor>(this IImageSharpBuilder builder)
    where TProcessor : class, IImageWebProcessor

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

Type Parameters

Name	Description
TProcessor	The type of class implementing IImageWebProcessorto add.

AddProcessor<TProcessor>(IImageSharpBuilder, Func<IServiceProvider, TProcessor>)

Adds the given IImageWebProcessor to the processor collection within the service collection.

Declaration

public static IImageSharpBuilder AddProcessor<TProcessor>(this IImageSharpBuilder builder, Func<IServiceProvider, TProcessor> implementationFactory)
    where TProcessor : class, IImageWebProcessor

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.
Func<IServiceProvider, TProcessor>	implementationFactory	The factory method for returning a IImageProvider.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

Type Parameters

Name	Description
TProcessor	The type of class implementing IImageWebProcessorto add.

AddProvider<TProvider>(IImageSharpBuilder)

Adds the given IImageProvider to the provider collection within the service collection.

Declaration

public static IImageSharpBuilder AddProvider<TProvider>(this IImageSharpBuilder builder)
    where TProvider : class, IImageProvider

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

Type Parameters

Name	Description
TProvider	The type of class implementing IImageProviderto add.

AddProvider<TProvider>(IImageSharpBuilder, Func<IServiceProvider, TProvider>)

Adds the given IImageProvider to the provider collection within the service collection.

Declaration

public static IImageSharpBuilder AddProvider<TProvider>(this IImageSharpBuilder builder, Func<IServiceProvider, TProvider> implementationFactory)
    where TProvider : class, IImageProvider

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.
Func<IServiceProvider, TProvider>	implementationFactory	The factory method for returning a IImageProvider.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

Type Parameters

Name	Description
TProvider	The type of class implementing IImageProviderto add.

ClearConverters(IImageSharpBuilder)

Removes all ICommandConverter instances from the converter collection within the service collection.

Declaration

public static IImageSharpBuilder ClearConverters(this IImageSharpBuilder builder)

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

ClearProcessors(IImageSharpBuilder)

Removes all IImageWebProcessor instances from the processor collection within the service collection.

Declaration

public static IImageSharpBuilder ClearProcessors(this IImageSharpBuilder builder)

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

ClearProviders(IImageSharpBuilder)

Removes all IImageProvider instances from the provider collection within the service collection.

Declaration

public static IImageSharpBuilder ClearProviders(this IImageSharpBuilder builder)

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

Configure<TOptions>(IImageSharpBuilder, IConfiguration)

Registers an action used to configure a particular type of options.

Declaration

public static IImageSharpBuilder Configure<TOptions>(this IImageSharpBuilder builder, IConfiguration configuration)
    where TOptions : class

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.
IConfiguration	configuration	The configuration being bound.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

Type Parameters

Name	Description
TOptions	The options type to be configured.

Configure<TOptions>(IImageSharpBuilder, Action<TOptions>)

Registers an action used to configure a particular type of options.

Declaration

public static IImageSharpBuilder Configure<TOptions>(this IImageSharpBuilder builder, Action<TOptions> configureOptions)
    where TOptions : class

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.
Action<TOptions>	configureOptions	The action used to configure the options.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

Type Parameters

Name	Description
TOptions	The options type to be configured.

RemoveConverter<TConverter>(IImageSharpBuilder)

Removes the given ICommandConverter from the converter collection within the service collection.

Declaration

public static IImageSharpBuilder RemoveConverter<TConverter>(this IImageSharpBuilder builder)
    where TConverter : class, ICommandConverter

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

Type Parameters

Name	Description
TConverter	The type of class implementing ICommandConverterto add.

RemoveProcessor<TProcessor>(IImageSharpBuilder)

Removes the given IImageWebProcessor from the processor collection within the service collection.

Declaration

public static IImageSharpBuilder RemoveProcessor<TProcessor>(this IImageSharpBuilder builder)
    where TProcessor : class, IImageWebProcessor

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

Type Parameters

Name	Description
TProcessor	The type of class implementing IImageWebProcessorto add.

RemoveProvider<TProvider>(IImageSharpBuilder)

Removes the given IImageProvider from the provider collection within the service collection.

Declaration

public static IImageSharpBuilder RemoveProvider<TProvider>(this IImageSharpBuilder builder)
    where TProvider : class, IImageProvider

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

Type Parameters

Name	Description
TProvider	The type of class implementing IImageProviderto add.

SetCache(IImageSharpBuilder, Func<IServiceProvider, IImageCache>)

Sets the given IImageCache adding it to the service collection.

Declaration

public static IImageSharpBuilder SetCache(this IImageSharpBuilder builder, Func<IServiceProvider, IImageCache> implementationFactory)

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.
Func<IServiceProvider, IImageCache>	implementationFactory	The factory method for returning a IImageCache.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

SetCache<TCache>(IImageSharpBuilder)

Sets the given IImageCache adding it to the service collection.

Declaration

public static IImageSharpBuilder SetCache<TCache>(this IImageSharpBuilder builder)
    where TCache : class, IImageCache

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

Type Parameters

Name	Description
TCache	The type of class implementing IImageCacheto add.

SetCacheHash(IImageSharpBuilder, Func<IServiceProvider, ICacheHash>)

Sets the given ICacheHash adding it to the service collection.

Declaration

public static IImageSharpBuilder SetCacheHash(this IImageSharpBuilder builder, Func<IServiceProvider, ICacheHash> implementationFactory)

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.
Func<IServiceProvider, ICacheHash>	implementationFactory	The factory method for returning a ICacheHash.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

SetCacheHash<TCacheHash>(IImageSharpBuilder)

Sets the given ICacheHash adding it to the service collection.

Declaration

public static IImageSharpBuilder SetCacheHash<TCacheHash>(this IImageSharpBuilder builder)
    where TCacheHash : class, ICacheHash

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

Type Parameters

Name	Description
TCacheHash	The type of class implementing ICacheHashto add.

SetMemoryAllocator(IImageSharpBuilder, Func<IServiceProvider, MemoryAllocator>)

Sets the given adding it to the service collection.

Declaration

[Obsolete("Use ImageSharp.Configuration.MemoryAllocator. This will be removed in a future version.", true)]
public static IImageSharpBuilder SetMemoryAllocator(this IImageSharpBuilder builder, Func<IServiceProvider, MemoryAllocator> implementationFactory)

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.
Func<IServiceProvider, MemoryAllocator>	implementationFactory	The factory method for returning a .

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

SetMemoryAllocator<TMemoryAllocator>(IImageSharpBuilder)

Sets the given adding it to the service collection.

Declaration

[Obsolete("Use ImageSharp.Configuration.MemoryAllocator. This will be removed in a future version.", true)]
public static IImageSharpBuilder SetMemoryAllocator<TMemoryAllocator>(this IImageSharpBuilder builder)
    where TMemoryAllocator : MemoryAllocator

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

Type Parameters

Name	Description
TMemoryAllocator	The type of class implementing to add.

SetRequestParser(IImageSharpBuilder, Func<IServiceProvider, IRequestParser>)

Sets the given IRequestParser adding it to the service collection.

Declaration

public static IImageSharpBuilder SetRequestParser(this IImageSharpBuilder builder, Func<IServiceProvider, IRequestParser> implementationFactory)

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.
Func<IServiceProvider, IRequestParser>	implementationFactory	The factory method for returning a IRequestParser.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

SetRequestParser<TParser>(IImageSharpBuilder)

Sets the given IRequestParser adding it to the service collection.

Declaration

public static IImageSharpBuilder SetRequestParser<TParser>(this IImageSharpBuilder builder)
    where TParser : class, IRequestParser

Parameters

Type	Name	Description
IImageSharpBuilder	builder	The core builder.

Returns

Type	Description
IImageSharpBuilder	The IImageSharpBuilder.

Type Parameters

Name	Description
TParser	The type of class implementing IRequestParserto add.