Header menu logo IcedTasks

MethodBuilder Type

Represents a builder for asynchronous methods.

Static members

Static member Description

MethodBuilder.AwaitOnCompleted(builder, awaiter, stateMachine)

Full Usage: MethodBuilder.AwaitOnCompleted(builder, awaiter, stateMachine)

Parameters:
    builder : byref<^Builder>
    awaiter : byref<'TAwaiter> - The awaiter.
    stateMachine : byref<'TStateMachine> - The state machine.

Modifiers: inline
Type parameters: ^Builder, 'TAwaiter, 'TStateMachine

Schedules the state machine to proceed to the next action when the specified awaiter completes.

builder : byref<^Builder>
awaiter : byref<'TAwaiter>

The awaiter.

stateMachine : byref<'TStateMachine>

The state machine.

MethodBuilder.AwaitUnsafeOnCompleted(builder, awaiter, stateMachine)

Full Usage: MethodBuilder.AwaitUnsafeOnCompleted(builder, awaiter, stateMachine)

Parameters:
    builder : byref<^Builder>
    awaiter : byref<'TAwaiter> - The awaiter.
    stateMachine : byref<'TStateMachine> - The state machine.

Modifiers: inline
Type parameters: ^Builder, 'TAwaiter, 'TStateMachine

Schedules the state machine to proceed to the next action when the specified awaiter completes.

builder : byref<^Builder>
awaiter : byref<'TAwaiter>

The awaiter.

stateMachine : byref<'TStateMachine>

The state machine.

MethodBuilder.SetException(builder, ex)

Full Usage: MethodBuilder.SetException(builder, ex)

Parameters:
    builder : byref<^Builder>
    ex : exn - The exception to bind to the task.

Modifiers: inline
Type parameters: ^Builder

Marks the task as failed and binds the specified exception to the task.

builder : byref<^Builder>
ex : exn

The exception to bind to the task.

MethodBuilder.SetResult(builder, result)

Full Usage: MethodBuilder.SetResult(builder, result)

Parameters:
    builder : byref<^Builder>
    result : 'TResult - The result to use to complete the task.

Modifiers: inline
Type parameters: ^Builder, 'TResult

Marks the task as successfully completed.

builder : byref<^Builder>
result : 'TResult

The result to use to complete the task.

MethodBuilder.SetResult(builder)

Full Usage: MethodBuilder.SetResult(builder)

Parameters:
    builder : byref<^Builder>

Modifiers: inline
Type parameters: ^Builder, 'TResult

Marks the task as successfully completed.

builder : byref<^Builder>

MethodBuilder.SetStateMachine(builder, stateMachine)

Full Usage: MethodBuilder.SetStateMachine(builder, stateMachine)

Parameters:
    builder : byref<^Builder>
    stateMachine : 'TStateMachine - The state machine instance to associate with the builder.

Modifiers: inline
Type parameters: ^Builder, 'TStateMachine

Associates the builder with the specified state machine.

builder : byref<^Builder>
stateMachine : 'TStateMachine

The state machine instance to associate with the builder.

MethodBuilder.Start(builder, stateMachine)

Full Usage: MethodBuilder.Start(builder, stateMachine)

Parameters:
    builder : byref<^Builder>
    stateMachine : byref<'TStateMachine> - The state machine instance, passed by reference.

Modifiers: inline
Type parameters: ^Builder, 'TStateMachine

Begins running the builder with the associated state machine.

builder : byref<^Builder>
stateMachine : byref<'TStateMachine>

The state machine instance, passed by reference.

MethodBuilder.get_Task builder

Full Usage: MethodBuilder.get_Task builder

Parameters:
    builder : byref<^Builder>

Returns: 'TResult The task for this builder.
Modifiers: inline
Type parameters: ^Builder, 'TResult

Gets the task for this builder.

builder : byref<^Builder>
Returns: 'TResult

The task for this builder.

Type something to start searching.