• Home
  • .NET
  • Unity
  • Godot
  • Design Overview
  • API Documentation
  • Changelog
  • GitHub
Show / Hide Table of Contents
  • Responsible
    • BddExtensions
    • IExternalResultSource
    • IFailureListener
    • IGlobalContextProvider
    • IOptionalTestResponder
    • ITestInstruction<T>
    • ITestOperation<T>
    • ITestResponder<T>
    • ITestScheduler
    • ITestWaitCondition<T>
    • LinqSupport
    • OptionalTestResponder
    • RepetitionLimitExceededException
    • Responsibly
    • TestFailureException
    • TestInstruction
    • TestInstructionExecutor
    • TestInstructionExecutor.StateNotificationCallback
    • TestOperationState
    • TestResponder
    • TestWaitCondition
  • Responsible.Bdd
    • IBddStep
    • Keywords
    • ScenarioBuilder
  • Responsible.Context
    • RunContext
  • Responsible.Docs
    • Inherit
  • Responsible.State
    • ITestOperationState
    • ITestOperationState<T>
    • StateStringBuilder
    • TestOperationStateTransition
    • TestOperationStatus
  • Responsible.Unity
    • TestOperationYieldInstruction<T>
    • UnhandledLogMessageException
    • UnityErrorLogInterceptor
    • UnityFailureListener
    • UnityTestInstructionExecutor
    • UnityTestScheduler
  • Responsible.Utilities
    • IMultipleTaskAwaiter<T>
    • IMultipleTaskSource<T>
    • IndentedStringBuilder<T>
    • RetryingPoller

Class TestOperationYieldInstruction<T>

A UnityEngine.CustomYieldInstruction that can be yielded from a [UnityTest] playmode test.

Inheritance
object
CustomYieldInstruction
TestOperationYieldInstruction<T>
Implements
IEnumerator
Inherited Members
CustomYieldInstruction.MoveNext()
CustomYieldInstruction.Reset()
CustomYieldInstruction.Current
Namespace: Responsible.Unity
Assembly: Responsible.dll
Syntax
public class TestOperationYieldInstruction<T> : CustomYieldInstruction, IEnumerator
Type Parameters
Name Description
T

Result type of the test operation being run.

Properties

CompletedSuccessfully

Indicates if the test operation has completed successfully.

Declaration
public bool CompletedSuccessfully { get; }
Property Value
Type Description
bool

True if the test operation completed successfully, false otherwise.

CompletedWithError

Indicates if the test operation has completed with an error.

Declaration
public bool CompletedWithError { get; }
Property Value
Type Description
bool

True if the test operation completed with an error, false otherwise.

Error

Gets the TestFailureException that caused the test operation to fail. Will throw an error if the task has not failed or was not canceled.

Declaration
public TestFailureException Error { get; }
Property Value
Type Description
TestFailureException

The exception that caused the test operation to fail.

Result

Indicates if the test operation completed with an error.

Declaration
public T Result { get; }
Property Value
Type Description
T

True if the test operation completed with an error, false otherwise.

Exceptions
Type Condition
InvalidOperationException

The test operation was not completed successfully.

WasCanceled

Indicates if the test operation was canceled.

Declaration
public bool WasCanceled { get; }
Property Value
Type Description
bool

True if the test operation was canceled, false otherwise.

keepWaiting

Implementation of UnityEngine.CustomYieldInstruction, not to be used for other purposes.

Declaration
public override bool keepWaiting { get; }
Property Value
Type Description
bool
Overrides
UnityEngine.CustomYieldInstruction.keepWaiting

Implements

IEnumerator
In this article
Back to top Generated by DocFX