ImageGeneratorBuilder class

Builds a pipeline of image generator middleware.

The pipeline is composed by calling use one or more times, then calling build to produce the final ImageGenerator. Middleware factories are applied in reverse order so that the first call to use produces the outermost wrapper.

This is an experimental feature.

Available extensions

• ConfigureOptionsImageGeneratorBuilderExtensions
• LoggingImageGeneratorBuilderExtensions
• OpenTelemetryImageGeneratorBuilderExtensions

Constructors

ImageGeneratorBuilder(ImageGenerator innerGenerator)

Creates a new ImageGeneratorBuilder wrapping innerGenerator.

ImageGeneratorBuilder.fromFactory(InnerImageGeneratorFactory innerFactory)

Creates a new ImageGeneratorBuilder from a factory function.

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

build([ServiceProvider? services]) → ImageGenerator

Builds the pipeline and returns the outermost ImageGenerator.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

use(ImageGenerator factory(ImageGenerator)) → ImageGeneratorBuilder

Adds a middleware factory to the pipeline.

useConfigureOptions(ImageGenerationOptions configure(ImageGenerationOptions options)) → ImageGeneratorBuilder

Available on ImageGeneratorBuilder, provided by the ConfigureOptionsImageGeneratorBuilderExtensions extension

Adds a callback that configures the ImageGenerationOptions passed to each request.

useLogging({LoggerFactory? loggerFactory, void configure(LoggingImageGenerator generator)?}) → ImageGeneratorBuilder

Available on ImageGeneratorBuilder, provided by the LoggingImageGeneratorBuilderExtensions extension

Adds logging around image generation operations.

useOpenTelemetry({String? modelId, String? system}) → ImageGeneratorBuilder

Available on ImageGeneratorBuilder, provided by the OpenTelemetryImageGeneratorBuilderExtensions extension

Adds an OpenTelemetryImageGenerator to the pipeline.

useWithServices(ImageGenerator factory(ImageGenerator inner, ServiceProvider services)) → ImageGeneratorBuilder

Adds a middleware factory that also receives the active ServiceProvider.

Operators

operator ==(Object other) → bool

The equality operator.

inherited