module libtmux-fsharp latest
Control
Namespace LibTmux.FSharp.Control
LibTmux.FSharp Opens control clients and reads their event streams.
Source and package
- Module
- LibTmux.FSharp
- Package
- LibTmux.FSharp
- Source
- src/LibTmux.FSharp/Control.fsi
-
Description#
Streams are cold: nothing is read until a consumer enumerates one, and the consumer supplies the cancellation token. Any <c>IAsyncEnumerable</c> library composes them, including FSharp.Control.TaskSeq.
Members10 members#
Common operations10 members#
- withSession function Opens a control client, runs work, and disposes the client after the returned task completes.
- events function Streams every event a control client reports.
- watchPane function Streams one pane's output from a borrowed control client.
- watchPanes function Streams several panes' output from one borrowed control client.
- cleanupFailure function Returns the cleanup failure attached to the exception a helper rethrew.
- enter function Opens a control client attached to the most recently used session.
- enterSession function Opens a control client attached to a session.
- foldWhile function Folds items until the stream ends or the folder returns Stop.
- iter function Awaits one handler at a time for each item until the stream ends.
- useSession function Runs work with an owned control client and disposes it after the returned task completes.