Axial

ResourceModule

Describes acquisition of a value together with registration of its release in the current Flow scope.

Summary

NameSignatureSynopsis
Operations
createResource.create acquire releaseDescribes acquisition together with a task-based release registered in the current Flow scope.
finalizerResource.finalizer cleanupDescribes a task-based finalizer as a unit-valued resource.
ofAsyncResource.ofAsync acquire releaseDescribes acquisition together with an F# async release registered in the current Flow scope.
asyncFinalizerResource.asyncFinalizer cleanupDescribes an F# async finalizer as a unit-valued resource.

Operations

kind:member

create

Resource.create acquire release
Member
Describes acquisition together with a task-based release registered in the current Flow scope.

Parameters

NameTypeDescription
acquireFlow<'env, 'error, 'value>
release'value -> CancellationToken -> Task

Returns

Resource<'env, 'error, 'value>
kind:member

finalizer

Resource.finalizer cleanup
Member
Describes a task-based finalizer as a unit-valued resource.

Parameters

NameTypeDescription
cleanupCancellationToken -> Task

Returns

Resource<'env, 'error, unit>
kind:member

ofAsync

Resource.ofAsync acquire release
Member
Describes acquisition together with an F# async release registered in the current Flow scope.

Parameters

NameTypeDescription
acquireFlow<'env, 'error, 'value>
release'value -> CancellationToken -> Async<unit>

Returns

Resource<'env, 'error, 'value>
kind:member

asyncFinalizer

Resource.asyncFinalizer cleanup
Member
Describes an F# async finalizer as a unit-valued resource.

Parameters

NameTypeDescription
cleanupCancellationToken -> Async<unit>

Returns

Resource<'env, 'error, unit>