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.

function libtmux-fsharp latest

Query.where

Namespace LibTmux.FSharp.Query.where LibTmux.FSharp

Adds a portable filter every result satisfies.

View as Markdown

Source and package
Module
LibTmux.FSharp
Declared in
Query
Package
LibTmux.FSharp
Source
src/LibTmux.FSharp/Query.fsi
F# value signatures Declares the name and type of a value or function in a signature. Language documentation where: filter: Filter<'T> -> query: Query<'T> -> Query<'T>
function [source]

Examples#

Read sessions, windows and panes through one query vocabulary. tmux drops rows a filter cannot keep, every returned row is rechecked, and a screen search finds the pane showing a line. atMostOne finds an object or reports it absent, and refuses several. Use Linux or macOS with Git, tmux 3.2a or newer, .NET SDK 10.0.303, and the .NET 8 and 10 runtimes. In an empty directory, fetch the documented library revision:

Terminal window
$ git clone https://github.com/libtmux/libtmux-dotnet.git libtmux-source && \
git -C libtmux-source checkout --detach cf34b255c896d19a97e7d7fabea58609c916012d

Save this complete consumer setup as global.json: View source

{
"sdk": {
"version": "10.0.303",
"rollForward": "disable",
"allowPrerelease": false
},
"test": {
"runner": "Microsoft.Testing.Platform"
}
}

Save this complete consumer setup as NuGet.config: View source

<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<clear />
<add key="libtmux-source" value="libtmux-source/artifacts/api-example-packages" />
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
</packageSources>
<packageSourceMapping>
<clear />
<packageSource key="libtmux-source">
<package pattern="LibTmux" />
<package pattern="LibTmux.*" />
</packageSource>
<packageSource key="nuget.org">
<package pattern="*" />
</packageSource>
</packageSourceMapping>
</configuration>

Save this complete consumer setup as Example.fsproj: View source

<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFrameworks>net8.0;net10.0</TargetFrameworks>
<LangVersion>10.0</LangVersion>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
<DisableImplicitFSharpCoreReference>true</DisableImplicitFSharpCoreReference>
<DisableImplicitLibraryPacksFolder>true</DisableImplicitLibraryPacksFolder>
</PropertyGroup>
<ItemGroup>
<Compile Include="Program.fs" />
<PackageReference Include="FSharp.Core" Version="[10.1.303]" />
<PackageReference Include="LibTmux.FSharp" Version="[0.0.0-alpha.20]" />
</ItemGroup>
</Project>

Save this complete program as Program.fs. It creates a private server with LibTmux.Server.CreateOwnedAsync; use! disposes owned scopes after success, cancellation or failure. The F# facade has no separate server constructor. View source

// fsharp-snippet: Queries
open System
open System.Threading
open LibTmux
open LibTmux.FSharp
let runAsync () =
task {
use deadline = new CancellationTokenSource(TimeSpan.FromSeconds 10.)
let token = deadline.Token
let options =
ServerConnectionOptions(
SocketName = "fsharp-queries-" + Guid.NewGuid().ToString("N"),
ConfigurationFile = "/dev/null"
)
use! owned = options |> Server.createOwned token
let! build =
owned.Value.CreateSessionAsync(
NewSessionRequest(Name = "build", WindowName = "make", Command = "/bin/sh"),
token
)
let! _ =
owned.Value.CreateSessionAsync(
NewSessionRequest(
Name = "logs",
WindowName = "tail",
Command = "printf 'ERROR: disk full\\n'; exec sleep 60"
),
token
)
let server = owned.Value
let! logs =
server
|> Server.sessions
|> Query.where (SessionFields.name |> Filter.eq "logs")
|> Query.list token
let! logPane = logs[0] |> Session.panes |> Query.list token
let! logged = logPane[0] |> Pane.waitForText token (TimeSpan.FromSeconds 5.) "ERROR:"
// tmux narrows each listing itself; every row is then rechecked.
let! named =
server
|> Server.sessions
|> Query.where (SessionFields.name |> Filter.startsWith "bu")
|> Query.exactlyOne token
// A relation filter reads only the sessions whose windows can match.
let! tailing =
server
|> Server.sessions
|> Query.where (WindowFields.name |> Filter.eq "tail" |> Filter.any SessionFields.windows)
|> Query.list token
// Session and window scopes use the same functions.
let! make =
build
|> Session.windows
|> Query.where (WindowFields.name |> Filter.eq "make")
|> Query.tryExactlyOne token
// tryExactlyOne is None when no window, or several, matched.
let! makePanes =
task {
match make with
| Some window ->
let! panes = window |> Window.panes |> Query.list token
return Some panes.Count
| None -> return None
}
// tmux searches each pane's visible rows, as find-window does.
let! showingErrors =
server
|> Server.panes
|> Query.showing (ScreenSearch.Text "ERROR:")
|> Query.list token
let! errorRow =
showingErrors[0] |> Pane.findOnScreen token (ScreenSearch.Text "disk full")
// A raw tmux filter is the escape hatch; nothing rechecks it.
let! active =
server
|> Server.panes
|> Query.whereUnsafe (UnsafeTmuxFilter "#{pane_active}")
|> Query.list token
// Find a session or create it: atMostOne is None only when nothing
// matched, and raises when several do.
let deploy =
server
|> Server.sessions
|> Query.where (SessionFields.name |> Filter.eq "deploy")
let! existing = deploy |> Query.atMostOne token
if existing.IsNone then
let! _ =
owned.Value
|> Server.newSession token (SessionSpec.running "deploy" "exec sleep 60")
()
let! found = deploy |> Query.atMostOne token
let! several =
task {
try
let! _ = server |> Server.sessions |> Query.atMostOne token
return "one or none"
with :? InvalidOperationException ->
return "refused"
}
printfn "logged: %b" logged.Found
printfn "named: %A" (named |> Result.map (fun session -> session.Name))
printfn "tailing: %A" [ for session in tailing -> session.Name ]
printfn "make panes: %A" makePanes
printfn "error row: %A" errorRow
printfn "active panes: %d" active.Count
printfn "deploy: absent %b, then found %b" existing.IsNone found.IsSome
printfn "at most one of every session: %s" several
}
runAsync().GetAwaiter().GetResult()
// endfsharp-snippet

Build the exact source packages and the saved consumer, then run both supported frameworks. The local package feed prevents an unrelated published package from satisfying the restore. Each program checks its result and exits unsuccessfully after an unhandled error:

Terminal window
$ export NUGET_PACKAGES="$PWD/packages" && \
dotnet restore libtmux-source/src/LibTmux.FSharp/LibTmux.FSharp.fsproj --locked-mode && \
dotnet pack libtmux-source/src/LibTmux/LibTmux.csproj \
--configuration Release --no-restore -p:ContinuousIntegrationBuild=true \
--output "$PWD/libtmux-source/artifacts/api-example-packages" && \
dotnet pack libtmux-source/src/LibTmux.FSharp/LibTmux.FSharp.fsproj \
--configuration Release --no-restore -p:ContinuousIntegrationBuild=true \
--output "$PWD/libtmux-source/artifacts/api-example-packages" && \
dotnet restore Example.fsproj --configfile NuGet.config && \
dotnet build Example.fsproj --configuration Release --no-restore --warnaserror && \
export LIBTMUX_TMUX="$(command -v tmux)" && \
export TMUX_TMPDIR=/tmp/libtmux-dotnet-dev && \
mkdir -p "$TMUX_TMPDIR" && \
unset TMUX TMUX_PANE && \
dotnet bin/Release/net8.0/Example.dll && \
dotnet bin/Release/net10.0/Example.dll

Expected program output from each framework:

logged: true
named: Ok "build"
tailing: ["logs"]
make panes: Some 1
error row: Some 1
active panes: 2
deploy: absent true, then found true
at most one of every session: refused
Parameters

Discussed in Querying and filtering

Esc

Type to search.