Auto Light Dark

Core LibraryAPI Reference

Choose documentation 1

latest

Current version

English

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

F# API

function libtmux-fsharp latest

Mirror.tryWaitUntil

Namespace L.FSharp LibTmux.FSharp

Waits until a view satisfies a condition, or returns None when none did in time.

View as Markdown

Source and package

Module: LibTmux.FSharp
Declared in: Mirror
Package: LibTmux.FSharp
Source: src/LibTmux.FSharp/Control.fsi

F# value signatures Declares the name and type of a value or function in a signature. Language documentation tryWaitUntil: cancellationToken: CancellationToken -> timeout: TimeSpan -> condition: (ServerMirrorView -> bool) -> mirror: ServerMirror -> Task<ServerMirrorView option>

function [source] ¶

Description#

As <c>waitUntil</c>, for a caller to whom running out of time is an ordinary outcome.

Parameters

cancellationToken ( CancellationToken )
timeout ( TimeSpan )
condition ( (ServerMirrorView -> bool) )
mirror ( ServerMirror )

Raises

System.InvalidOperationException – The mirror ended first.

Discussed in Quick start