BindSightGeneratorRunner

public sealed class BindSightGeneratorRunner

Namespace: RhoMicro.BindSight.Generators

Inheritance:

• DirectoryBindSightGeneratorRunner

  • Object

Summary

Runs options docs generators.

Constructors

BindSightGeneratorRunner(IBindSightRunnerOptions, IBindSightGeneratorOptionsProvider, IEnumerable<IBindSightGenerator>, ILogger<BindSightGeneratorRunner>, IHostApplicationLifetime)

public BindSightGeneratorRunner(IBindSightRunnerOptions options, IBindSightGeneratorOptionsProvider optionsProvider, IEnumerable<IBindSightGenerator> generators, ILogger<BindSightGeneratorRunner> logger, IHostApplicationLifetime hostLifetime)

Summary

Runs options docs generators.

Parameters

Name	Type	Description
generators	IEnumerable<IBindSightGenerator>	The generators to run.
hostLifetime	IHostApplicationLifetime	The lifetime of the service host, to be used when exiting with the ExitMode.Host mode.
logger	ILogger<BindSightGeneratorRunner>	The logger to use.
options	IBindSightRunnerOptions	The options to use when running generators.
optionsProvider	IBindSightGeneratorOptionsProvider	The the generator options provider to use when running generators.

Methods

Run(CancellationToken)

public Task<bool> Run([CancellationToken cancellationToken = default(CancellationToken)])

Summary

Runs the generator runner.

Parameters

Name	Type	Description
cancellationToken	CancellationToken	The cancellation token used to request the running of generators to be cancelled.

Returns

A task, which, upon completion, will contain information on whether the generators runner actually did run. The task will complete upon all generators having ran or the runner exiting early due to IBindSightRunnerOptions.ExitOnCancellation.