StmBuilderType
PackageAxial
Computation expression builder for STM transactions.
Specification
Kind
Type
Members
7
Examples
0
``.ctor``Signature
StmBuilder()
BindSignature
this.Bind
CombineSignature
this.Combine
DelaySignature
this.Delay
ReturnSignature
this.Return
Summary
| Name | Signature | Synopsis |
|---|---|---|
| ``.ctor`` | StmBuilder() | No description available. |
| Bind | this.Bind | Binds the result of an STM transaction to a function that returns another STM transaction. |
| Combine | this.Combine | Combines two STM transactions, executing them in sequence. |
| Delay | this.Delay | Delays the execution of a transaction until it is run. |
| Return | this.Return | Wraps a value in an STM transaction. |
| ReturnFrom | this.ReturnFrom | Returns the result of another STM transaction. |
| Zero | this.Zero | Returns a transaction that does nothing and produces unit. |
Binds the result of an STM transaction to a function that returns another STM transaction.
Parameters
| Name | Type | Description |
|---|---|---|
| stm | STM<'T> | The first STM transaction. |
| f | 'T -> STM<'U> | A function that takes the result of the first transaction and returns a second transaction. |
Returns
STM<'U>
Combines two STM transactions, executing them in sequence.
Parameters
| Name | Type | Description |
|---|---|---|
| stm1 | STM<unit> | The first transaction to execute. |
| stm2 | STM<'T> | The second transaction to execute. |
Returns
STM<'T>
Delays the execution of a transaction until it is run.
Parameters
| Name | Type | Description |
|---|---|---|
| f | unit -> STM<'T> | A function that produces the transaction. |
Returns
STM<'T>
Wraps a value in an STM transaction.
Parameters
| Name | Type | Description |
|---|---|---|
| value | 'T | The value to return. |
Returns
STM<'T>
Returns the result of another STM transaction.
Parameters
| Name | Type | Description |
|---|---|---|
| stm | STM<'T> | The STM transaction to return from. |
Returns
STM<'T>