IteratorStateMachineAttribute Klasa

Definicja

Przestrzeń nazw:

System.Runtime.CompilerServices

Zestaw:

System.Runtime.dll

Źródło:

IteratorStateMachineAttribute.cs

Wskazuje, czy metoda w Visual Basic jest oznaczona modyfikatorem 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

Dziedziczenie

Object

Attribute

StateMachineAttribute

IteratorStateMachineAttribute

Atrybuty

AttributeUsageAttribute

Przykłady

W poniższym przykładzie pokazano, jak określić, czy metoda jest metodą iteratora. W tym przykładzie IsIteratorMethod wykonamy następujące kroki:

• MethodInfo Uzyskuje obiekt dla nazwy metody przy użyciu polecenia Type.GetMethod.

• Type Uzyskuje obiekt dla atrybutu przy użyciu operatora GetType.

• Uzyskuje obiekt atrybutu dla metody i typu atrybutu przy użyciu metody MethodInfo.GetCustomAttribute. Jeśli GetCustomAttribute funkcja zwraca Nothing (Visual Basic), metoda nie zawiera atrybutu.

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

Uwagi

Nie należy stosować atrybutu IteratorStateMachine do metod w kodzie. W przypadku metod w języku Visual Basic, które mają modyfikator iteratora , kompilator zastosuje IteratorStateMachine atrybut w elemecie IL, który emituje.

Gdy metoda (MethodName) w Visual Basic ma Iterator modyfikator, kompilator emituje il, który zawiera strukturę maszyny stanu. Ta struktura zawiera kod w metodzie . Ten il zawiera również metodę wycinkową (MethodName), która wywołuje maszynę stanu. Kompilator dodaje IteratorStateMachine atrybut do metody wycinkowej, aby narzędzia mogły zidentyfikować odpowiednią maszynę stanu. Szczegóły emitowanego il mogą ulec zmianie w przyszłych wersjach kompilatorów.

Metoda iteratora wykonuje niestandardową iterację w kolekcji przy użyciu Yield instrukcji (Visual Basic), aby zwrócić każdy element jeden naraz. Aby uzyskać więcej informacji, zobacz Iteratory.

Uwaga

Nie można użyć IteratorStateMachineAttribute polecenia , aby sprawdzić, czy metoda jest metodą iteratora w języku C#.

Konstruktory

IteratorStateMachineAttribute(Type)

Inicjuje nowe wystąpienie klasy IteratorStateMachineAttribute.

Właściwości

StateMachineType	Zwraca obiekt typu dla bazowego typu maszyny stanu, który został wygenerowany przez kompilator w celu zaimplementowania metody maszyny stanu. (Odziedziczone po StateMachineAttribute)
TypeId	Po zaimplementowaniu w klasie pochodnej pobiera unikatowy identyfikator dla tego elementu Attribute. (Odziedziczone po Attribute)

Metody

Equals(Object)	Zwraca wartość wskazującą, czy to wystąpienie jest równe podanemu obiektowi. (Odziedziczone po Attribute)
GetHashCode()	Zwraca wartość skrótu dla tego wystąpienia. (Odziedziczone po Attribute)
GetType()	Type Pobiera bieżące wystąpienie. (Odziedziczone po Object)
IsDefaultAttribute()	W przypadku zastąpienia w klasie pochodnej wskazuje, czy wartość tego wystąpienia jest wartością domyślną klasy pochodnej. (Odziedziczone po Attribute)
Match(Object)	W przypadku zastąpienia w klasie pochodnej zwraca wartość wskazującą, czy to wystąpienie jest równe określonemu obiektowi. (Odziedziczone po Attribute)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object)
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)

Zobacz też

• AsyncStateMachineAttribute
• StateMachineType