CauseModule
PackageAxial
Summary
| Name | Signature | Synopsis |
|---|---|---|
| map | Cause.map mapper cause | Transforms the error value of a failure cause using the provided function. |
| thenCause | Cause.thenCause left right | Combines causes that happened sequentially. |
| both | Cause.both left right | Combines causes that happened concurrently. |
| traced | Cause.traced trace cause | Attaches diagnostic trace text to a cause. |
| failures | Cause.failures cause | Returns every typed failure value contained in a cause tree. |
| defects | Cause.defects cause | Returns every defect exception contained in a cause tree. |
| isInterrupted | Cause.isInterrupted cause | Returns whether the cause tree contains an interruption signal. |
| prettyPrint | Cause.prettyPrint formatError cause | Pretty prints a cause tree for diagnostics. |
Transforms the error value of a failure cause using the provided function.
Parameters
| Name | Type | Description |
|---|---|---|
| mapper | 'e -> 'f | The function to transform the error value. |
| cause | Cause<'e> | The original cause to transform. |
Returns
Cause<'f>
Combines causes that happened sequentially.
Parameters
| Name | Type | Description |
|---|---|---|
| left | Cause<'error> | |
| right | Cause<'error> |
Returns
Cause<'error>
Combines causes that happened concurrently.
Parameters
| Name | Type | Description |
|---|---|---|
| left | Cause<'error> | |
| right | Cause<'error> |
Returns
Cause<'error>
Attaches diagnostic trace text to a cause.
Parameters
| Name | Type | Description |
|---|---|---|
| trace | string | |
| cause | Cause<'error> |
Returns
Cause<'error>
Returns every typed failure value contained in a cause tree.
Parameters
| Name | Type | Description |
|---|---|---|
| cause | Cause<'error> |
Returns
'error list
Returns every defect exception contained in a cause tree.
Parameters
| Name | Type | Description |
|---|---|---|
| cause | Cause<'error> |
Returns
exn list
Returns whether the cause tree contains an interruption signal.
Parameters
| Name | Type | Description |
|---|---|---|
| cause | Cause<'error> |
Returns
bool