IteratorStateMachineAttribute 類別

定義

命名空間:

System.Runtime.CompilerServices

組件:

netstandard.dll, System.Runtime.dll

來源:

IteratorStateMachineAttribute.cs

表示 Visual Basic 中的方法是否標示了修 Iterator 飾鍵。

public ref class IteratorStateMachineAttribute sealed : System::Runtime::CompilerServices::StateMachineAttribute

[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)]
public sealed class IteratorStateMachineAttribute : System.Runtime.CompilerServices.StateMachineAttribute

[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)>]
type IteratorStateMachineAttribute = class
    inherit StateMachineAttribute

Public NotInheritable Class IteratorStateMachineAttribute
Inherits StateMachineAttribute

繼承

Object

Attribute

StateMachineAttribute

IteratorStateMachineAttribute

屬性

AttributeUsageAttribute

範例

以下範例說明如何判斷一個方法是否為迭代方法。 在範例中， IsIteratorMethod 執行以下步驟：

• MethodInfo透過使用 Type.GetMethod。

• 透過使用 GetType 運算子取得Type該屬性的物件。

• 透過使用 MethodInfo.GetCustomAttribute。 如果 GetCustomAttribute 回傳 Nothing （Visual Basic），該方法就不包含該屬性。

Imports System.Collections.Generic
Imports System.Reflection
Imports System.Threading.Tasks
Imports System.Runtime.CompilerServices


Module Module1

    ' This class is used by the code below to discover method attributes.
    Public Class TheClass
        Public Async Function AsyncMethod() As Task(Of Integer)
            Await Task.Delay(5)
            Return 1
        End Function

        Public Iterator Function IteratorMethod() As IEnumerable(Of Integer)
            Yield 1
            Yield 2
        End Function

        Public Function RegularMethod() As Integer
            Return 0
        End Function
    End Class


    Private Function IsAsyncMethod(classType As Type, methodName As String)
        ' Obtain the method with the specified name.
        Dim method As MethodInfo = classType.GetMethod(methodName)

        Dim attType As Type = GetType(AsyncStateMachineAttribute)

        Dim attrib = CType(method.GetCustomAttribute(attType), AsyncStateMachineAttribute)
        ' The above variable contains the StateMachineType property.

        Return (attrib IsNot Nothing)
    End Function

    Private Function IsIteratorMethod(classType As Type, methodName As String)
        ' Obtain the method with the specified name.
        Dim method As MethodInfo = classType.GetMethod(methodName)

        Dim attType As Type = GetType(IteratorStateMachineAttribute)

        ' Obtain the custom attribute for the method.
        ' The value returned contains the StateMachineType property.
        ' Nothing is returned if the attribute isn't present for the method.
        Dim attrib = CType(method.GetCustomAttribute(attType), IteratorStateMachineAttribute)

        Return (attrib IsNot Nothing)
    End Function

    Private Sub ShowResult(classType As Type, methodName As String)
        Console.Write((methodName & ": ").PadRight(16))

        If IsAsyncMethod(classType, methodName) Then
            Console.WriteLine("Async method")
        ElseIf IsIteratorMethod(classType, methodName) Then
            Console.WriteLine("Iterator method")
        Else
            Console.WriteLine("Regular method")
        End If

        ' Note: The IteratorStateMachineAttribute applies to Visual Basic methods
        ' but not C# methods.
    End Sub

    Sub Main()
        ShowResult(GetType(TheClass), "AsyncMethod")
        ShowResult(GetType(TheClass), "IteratorMethod")
        ShowResult(GetType(TheClass), "RegularMethod")

        Console.ReadKey()
    End Sub

    '   AsyncMethod:    Async method
    '   IteratorMethod: Iterator method
    '   RegularMethod:  Regular method

End Module

備註

你不應該把屬性 IteratorStateMachine 套用到程式碼裡的方法上。 對於 Visual Basic 中帶有 迭代器 修飾符的方法，編譯器會套用 IteratorStateMachine 它所發出的 IL 屬性。

當 Visual Basic 中的方法（MethodName）帶有 Iterator 修飾符時，編譯器會輸出包含狀態機結構的 IL。 該結構包含了方法中的程式碼。 該 IL 也包含一個存根方法（MethodName），可呼叫狀態機。 編譯器會將屬性 IteratorStateMachine 加入存根方法，使工具能識別對應的狀態機。 未來編譯器的版本可能會對所發出的 IL 細節有所調整。

迭代器方法透過使用 Yield （Visual Basic） 語句逐一回傳每個元素，對集合進行自訂迭代。

Note

你無法用它 IteratorStateMachineAttribute 來測試 C# 中方法是否是迭代方法。

建構函式

名稱	Description
IteratorStateMachineAttribute(Type)	初始化 IteratorStateMachineAttribute 類別的新執行個體。

屬性

名稱	Description
StateMachineType	回傳編譯器為實作狀態機方法所產生的底層狀態機類型類型物件。 (繼承來源 StateMachineAttribute)
TypeId	在衍生類別中實作時，取得這個 Attribute的唯一標識碼。 (繼承來源 Attribute)

方法

名稱	Description
Equals(Object)	傳回值，這個值表示這個實例是否等於指定的物件。 (繼承來源 Attribute)
GetHashCode()	傳回這個實例的哈希碼。 (繼承來源 Attribute)
GetType()	取得目前實例的 Type。 (繼承來源 Object)
IsDefaultAttribute()	在衍生類別中覆寫時，指出這個實例的值是否為衍生類別的預設值。 (繼承來源 Attribute)
Match(Object)	在衍生類別中覆寫時，傳回值，指出這個實例是否等於指定的物件。 (繼承來源 Attribute)
MemberwiseClone()	建立目前 Object的淺層複本。 (繼承來源 Object)
ToString()	傳回表示目前 物件的字串。 (繼承來源 Object)

另請參閱

• AsyncStateMachineAttribute
• StateMachineType