Few minor improvements

- Remove the reference to non-existing `createPipeline` from the docs.

- Added check whether async_backend is set when `asynctools_adapters `is
imported. Without this change the compile error is very unclear (Future not
defined).
This commit is contained in:
Ivan Yonchovski 2021-11-16 21:11:05 +02:00 • committed by zah
commit e56e9c71e1
2 changed files with 7 additions and 4 deletions

View file

@ -517,9 +517,9 @@ type PipelineResultProc*[T] = proc (i: InputStream): T
Please note that `stream.getOutput` is an example of such a function. Please note that `stream.getOutput` is an example of such a function.
Pipelnes can be created with the `cretePipeline` API or executed in place with Pipelnes executed in place with `executePipeline` API. If the first input source is
`executePipeline`. If the first input source is async, then the whole pipeline async, then the whole pipeline with be executing asynchronously which can result
with be executing asynchronously which can result in a much lower memory usage. in a much lower memory usage.
The pipeline transformation steps are usually employing the `fsMultiSync` The pipeline transformation steps are usually employing the `fsMultiSync`
pragma to make them usable in both synchronous and asynchronous scenarios. pragma to make them usable in both synchronous and asynchronous scenarios.

View file

@ -1,6 +1,9 @@
import import
asynctools/asyncpipe, asynctools/asyncpipe,
inputs, outputs, buffers, multisync inputs, outputs, buffers, multisync, async_backend
when (not fsAsyncSupport):
{.fatal: "`-d:async_backend` has be to set".}
export export
inputs, outputs, asyncpipe, fsMultiSync inputs, outputs, asyncpipe, fsMultiSync