FSharp.Core


ResumableCode Module

Contains functions for composing resumable code blocks

Functions and values

Function or value Description

ResumableCode.Combine (code1, code2)

Full Usage: ResumableCode.Combine (code1, code2)

Parameters:
Returns: ResumableCode<'Data, 'T>
Modifiers: inline
Type parameters: 'Data, 'T

Sequences one section of resumable code after another

code1 : ResumableCode<'Data, unit>
code2 : ResumableCode<'Data, 'T>
Returns: ResumableCode<'Data, 'T>

ResumableCode.CombineDynamic (sm, code1, code2)

Full Usage: ResumableCode.CombineDynamic (sm, code1, code2)

Parameters:
Returns: bool

The dynamic implementation of the corresponding operation. This operation should not be used directly.

sm : byref<ResumableStateMachine<'Data>>
code1 : ResumableCode<'Data, unit>
code2 : ResumableCode<'Data, 'T>
Returns: bool

ResumableCode.Delay f

Full Usage: ResumableCode.Delay f

Parameters:
Returns: ResumableCode<'Data, 'T>
Modifiers: inline
Type parameters: 'Data, 'T

Creates resumable code whose definition is a delayed function

f : unit -> ResumableCode<'Data, 'T>
Returns: ResumableCode<'Data, 'T>

ResumableCode.For (sequence, body)

Full Usage: ResumableCode.For (sequence, body)

Parameters:
Returns: ResumableCode<'Data, unit>
Modifiers: inline
Type parameters: 'T, 'Data

Specifies resumable code which iterates an input sequence

sequence : seq<'T>
body : 'T -> ResumableCode<'Data, unit>
Returns: ResumableCode<'Data, unit>

ResumableCode.TryFinally (body, compensation)

Full Usage: ResumableCode.TryFinally (body, compensation)

Parameters:
Returns: ResumableCode<'Data, 'T>
Modifiers: inline
Type parameters: 'Data, 'T

Specifies resumable code which executes with try/finally semantics

body : ResumableCode<'Data, 'T>
compensation : ResumableCode<'Data, unit>
Returns: ResumableCode<'Data, 'T>

ResumableCode.TryFinallyAsync (body, compensation)

Full Usage: ResumableCode.TryFinallyAsync (body, compensation)

Parameters:
Returns: ResumableCode<'Data, 'T>
Modifiers: inline
Type parameters: 'Data, 'T

Specifies resumable code which executes with try/finally semantics

body : ResumableCode<'Data, 'T>
compensation : ResumableCode<'Data, unit>
Returns: ResumableCode<'Data, 'T>

ResumableCode.TryFinallyAsyncDynamic (sm, body, compensation)

Full Usage: ResumableCode.TryFinallyAsyncDynamic (sm, body, compensation)

Parameters:
Returns: bool

The dynamic implementation of the corresponding operation. This operation should not be used directly.

sm : byref<ResumableStateMachine<'Data>>
body : ResumableCode<'Data, 'T>
compensation : ResumableCode<'Data, unit>
Returns: bool

ResumableCode.TryWith (body, catch)

Full Usage: ResumableCode.TryWith (body, catch)

Parameters:
Returns: ResumableCode<'Data, 'T>
Modifiers: inline
Type parameters: 'Data, 'T

Specifies resumable code which executes with try/with semantics

body : ResumableCode<'Data, 'T>
catch : exn -> ResumableCode<'Data, 'T>
Returns: ResumableCode<'Data, 'T>

ResumableCode.TryWithDynamic (sm, body, handler)

Full Usage: ResumableCode.TryWithDynamic (sm, body, handler)

Parameters:
Returns: bool

The dynamic implementation of the corresponding operation. This operation should not be used directly.

sm : byref<ResumableStateMachine<'Data>>
body : ResumableCode<'Data, 'T>
handler : exn -> ResumableCode<'Data, 'T>
Returns: bool

ResumableCode.Using (resource, body)

Full Usage: ResumableCode.Using (resource, body)

Parameters:
    resource : 'Resource
    body : 'Resource -> ResumableCode<'Data, 'T>

Returns: ResumableCode<'Data, 'T>
Modifiers: inline
Type parameters: 'Resource, 'Data, 'T

Specifies resumable code which executes with 'use' semantics

resource : 'Resource
body : 'Resource -> ResumableCode<'Data, 'T>
Returns: ResumableCode<'Data, 'T>

ResumableCode.While (condition, body)

Full Usage: ResumableCode.While (condition, body)

Parameters:
Returns: ResumableCode<'Data, unit>
Modifiers: inline
Type parameters: 'Data

Specifies resumable code which executes a loop

condition : unit -> bool
body : ResumableCode<'Data, unit>
Returns: ResumableCode<'Data, unit>

ResumableCode.WhileDynamic (sm, condition, body)

Full Usage: ResumableCode.WhileDynamic (sm, condition, body)

Parameters:
Returns: bool

The dynamic implementation of the corresponding operation. This operation should not be used directly.

sm : byref<ResumableStateMachine<'Data>>
condition : unit -> bool
body : ResumableCode<'Data, unit>
Returns: bool

ResumableCode.Yield ()

Full Usage: ResumableCode.Yield ()

Parameters:
Returns: ResumableCode<'Data, unit>
Modifiers: inline
Type parameters: 'Data

Specifies resumable code which iterates yields

() : unit
Returns: ResumableCode<'Data, unit>

ResumableCode.YieldDynamic sm

Full Usage: ResumableCode.YieldDynamic sm

Parameters:
Returns: bool

The dynamic implementation of the corresponding operation. This operation should not be used directly.

sm : byref<ResumableStateMachine<'Data>>
Returns: bool

ResumableCode.Zero ()

Full Usage: ResumableCode.Zero ()

Parameters:
Returns: ResumableCode<'Data, unit>
Modifiers: inline
Type parameters: 'Data

Specifies resumable code which does nothing

() : unit
Returns: ResumableCode<'Data, unit>