Metalama 1.0 / / Metalama Documentation / Aspect API / Metalama.​Framework.​Advising / Method­Template­Selector / Method­Template­Selector

Constructor MethodTemplateSelector

MethodTemplateSelector(String, String, String, String, String, String, Boolean, Boolean)

Initializes a new instance of the MethodTemplateSelector struct by specifying the name of the template methods to be applied. The named passed to this constructor must be the name of methods of the current aspect class, and these methods must be annotated with the TemplateAttribute custom attribute. You can define several templates by passing a value to optional parameters. The appropriate template will be automatically selected according to the method to which the advice is applied. If several templates are eligible for a method, the template that is the last in the list of parameters is selected.

Declaration
public MethodTemplateSelector(string defaultTemplate, string asyncTemplate = null, string enumerableTemplate = null, string enumeratorTemplate = null, string asyncEnumerableTemplate = null, string asyncEnumeratorTemplate = null, bool useAsyncTemplateForAnyAwaitable = false, bool useEnumerableTemplateForAnyEnumerable = false)
Parameters
Type Name Description
String defaultTemplate

Name of the template that must be applied if no other template is applicable. This parameter is required. See DefaultTemplate for details.

String asyncTemplate

Name of the template that must be applied to async methods, including async iterators unless specified otherwise. See AsyncTemplate for details.

String enumerableTemplate

Name of the template that must be applied to iterator methods returning an an IEnumerable<T> or IEnumerable. See EnumerableTemplate for details.

String enumeratorTemplate

Name of the template that must be applied to an iterator method returning an an IEnumerator<T> or IEnumerator. See EnumeratorTemplate for details.

String asyncEnumerableTemplate

Name of the template that must be applied to an async iterator method returning an IAsyncEnumerable. See AsyncEnumerableTemplate for details.

String asyncEnumeratorTemplate

Name of the template that must be applied to an async iterator method returning an IAsyncEnumerator. See AsyncEnumeratorTemplate for details.

Boolean useAsyncTemplateForAnyAwaitable

Indicates whether the AsyncTemplate must be applied to all methods returning an awaitable type (including IAsyncEnumerable and IAsyncEnumerator), instead of only to methods that have the async modifier. See UseAsyncTemplateForAnyAwaitable for details.

Boolean useEnumerableTemplateForAnyEnumerable

Indicates whether the EnumerableTemplate, EnumeratorTemplate, AsyncEnumerableTemplate, AsyncEnumeratorTemplate must be applied to all methods returning a compatible return type (if set to true), instead of only to methods using the yield statement. See UseEnumerableTemplateForAnyEnumerable for details.

Remarks

Note that this type has also an implicit conversion from String. If you only want to specify a default template, you can pass a string, without calling the constructor.