IOptionsSnapshot<TOptions> Interface

Definition

Namespace:

Microsoft.Extensions.Options

Assembly:

Microsoft.Extensions.Options.dll

Package:

Microsoft.Extensions.Options v11.0.0-rc.1.26425.128

Source:

IOptionsSnapshot.cs

Used to access the value of TOptions for the lifetime of a request.

generic <typename TOptions>
 where TOptions : classpublic interface class IOptionsSnapshot : Microsoft::Extensions::Options::IOptions<TOptions>

public interface IOptionsSnapshot<out TOptions> : Microsoft.Extensions.Options.IOptions<out TOptions> where TOptions : class

type IOptionsSnapshot<'Options (requires 'Options : null)> = interface
    interface IOptions<'Options (requires 'Options : null)>

Public Interface IOptionsSnapshot(Of Out TOptions)
Implements IOptions(Of Out TOptions)

Type Parameters

TOptions

Options type.

This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics.

Derived

Microsoft.Extensions.Options.OptionsManager<TOptions>

Implements

IOptions<TOptions>

Remarks

The default implementation, OptionsManager<TOptions>, has a separate options cache in each scope. Startup validation does not populate this cache, and the default implementation creates and validates options synchronously. Validators with a usable synchronous Validate(String, TOptions) implementation continue to work. Validators that require asynchronous validation fail through their synchronous validation result because the default implementation cannot execute or await ValidateAsync(String, TOptions, CancellationToken).

Properties

Name	Description
Value	Gets the default configured TOptions instance. (Inherited from IOptions<TOptions>)

Methods

Name	Description
Get(String)	Returns a configured TOptions instance with the given name.