ColdTask (IcedTasks) | IcedTasks

ColdTask Module

Namespace: IcedTasks.ColdTasks
Assembly: IcedTasks.dll
Parent Module: ColdTasks

Contains functional helper functions for composing and converting ColdTask values.

Functions and values

Function or value	Description
`ColdTask.apply applicable cTask` Full Usage: `ColdTask.apply applicable cTask` Parameters: applicable : `ColdTask<('input -> 'output)>` - A function wrapped in a ColdTasks cTask : `ColdTask<'input>` - The value. Returns: `ColdTask<'output>` The result of the applicable. Modifiers: inline Type parameters: 'input, 'output	Allows chaining of ColdTasks. applicable : `ColdTask<('input -> 'output)>` A function wrapped in a ColdTasks cTask : `ColdTask<'input>` The value. Returns: `ColdTask<'output>` The result of the applicable.
`ColdTask.bind binder cTask` Full Usage: `ColdTask.bind binder cTask` Parameters: binder : `'input -> ColdTask<'output>` - The continuation. cTask : `ColdTask<'input>` - The value. Returns: `ColdTask<'output>` The result of the binder. Modifiers: inline Type parameters: 'input, 'output	Allows chaining of ColdTasks. binder : `'input -> ColdTask<'output>` The continuation. cTask : `ColdTask<'input>` The value. Returns: `ColdTask<'output>` The result of the binder.
`ColdTask.map mapper cTask` Full Usage: `ColdTask.map mapper cTask` Parameters: mapper : `'input -> 'output` - The continuation. cTask : `ColdTask<'input>` - The value. Returns: `ColdTask<'output>` The result of the mapper wrapped in a ColdTasks. Modifiers: inline Type parameters: 'input, 'output	Allows chaining of ColdTasks. mapper : `'input -> 'output` The continuation. cTask : `ColdTask<'input>` The value. Returns: `ColdTask<'output>` The result of the mapper wrapped in a ColdTasks.
`ColdTask.ofUnit unitColdTask` Full Usage: `ColdTask.ofUnit unitColdTask` Parameters: unitColdTask : `ColdTask` - The ColdTask to convert. Returns: `ColdTask<unit>` A ColdTask\ that completes when unitColdTask completes. Modifiers: inline	Converts a non-generic ColdTask to a ColdTask\. unitColdTask : `ColdTask` The ColdTask to convert. Returns: `ColdTask<unit>` A ColdTask\ that completes when unitColdTask completes.
`ColdTask.parallelZip left right` Full Usage: `ColdTask.parallelZip left right` Parameters: left : `ColdTask<'left>` - The left value. right : `ColdTask<'right>` - The right value. Returns: `ColdTask<'left * 'right>` A tuple of the parameters passed in. Modifiers: inline Type parameters: 'left, 'right	Takes two ColdTasks, starts them concurrently when the returned ColdTask is invoked, and returns a tuple of the pair. left : `ColdTask<'left>` The left value. right : `ColdTask<'right>` The right value. Returns: `ColdTask<'left * 'right>` A tuple of the parameters passed in. Example `let both = ColdTask.parallelZip firstOperation secondOperation let! left, right = both ()` val both: obj
`ColdTask.singleton result ()` Full Usage: `ColdTask.singleton result ()` Parameters: result : `'item` () : `unit` Returns: `Task<'item>` A ColdTask with the item as the result. Modifiers: inline Type parameters: 'item	Lifts an item to a ColdTask. result : `'item` () : `unit` Returns: `Task<'item>` A ColdTask with the item as the result.
`ColdTask.toUnit coldTask ()` Full Usage: `ColdTask.toUnit coldTask ()` Parameters: coldTask : `ColdTask<'a>` - The ColdTask to convert. () : `unit` Returns: `Task` A non-generic ColdTask that completes when coldTask completes. Modifiers: inline Type parameters: 'a	Converts a ColdTask\<_> to a non-generic ColdTask by discarding the result. coldTask : `ColdTask<'a>` The ColdTask to convert. () : `unit` Returns: `Task` A non-generic ColdTask that completes when coldTask completes.
`ColdTask.zip left right` Full Usage: `ColdTask.zip left right` Parameters: left : `ColdTask<'left>` - The left value. right : `ColdTask<'right>` - The right value. Returns: `ColdTask<'left * 'right>` A tuple of the parameters passed in Modifiers: inline Type parameters: 'left, 'right	Takes two ColdTasks, starts them serially in order of left to right, and returns a tuple of the pair. left : `ColdTask<'left>` The left value. right : `ColdTask<'right>` The right value. Returns: `ColdTask<'left * 'right>` A tuple of the parameters passed in