Core LibraryAPI Reference

Choose documentation 1

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

module libtmux-fsharp latest

TmuxAsync

Namespace LibTmux.FSharp.TmuxAsync LibTmux.FSharp

Awaits tasks in an <c>async</c> workflow without losing whether tmux may have acted.

View as Markdown

Source and package
Module
LibTmux.FSharp
Package
LibTmux.FSharp
Source
src/LibTmux.FSharp/Library.fsi
module TmuxAsync
module [source]

Description#

<c>Async.AwaitTask</c> turns a <c>TmuxOperationCanceledException</c> into a bare <c>TaskCanceledException</c>, losing <c>CommandMayHaveExecuted</c>, and wraps a failure in an <c>AggregateException</c>. These raise a tmux client cancelled after it may have acted as itself, so <c>TmuxFailure.MayHaveRun</c> matches it in <c>try ... with</c>; any other cancellation cancels the workflow, and a failure is raised as the task raised it.

Discussed in .NET interoperation

Members2 members#

Common operations2 members#

  • awaitTask function Awaits a task that returns a value.
  • awaitUnitTask function Awaits a task that returns nothing.
Esc

Type to search.