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.

class libtmux-fsharp latest

Query

Namespace LibTmux.FSharp.Query LibTmux.FSharp

Describes a tmux listing: a scope, filters and text panes must show.

View as Markdown

Source and package
Module
LibTmux.FSharp
Package
LibTmux.FSharp
Source
src/LibTmux.FSharp/Query.fsi
type Query<'T>module Query
class [source]

Description#

Building a query reads nothing; each run reads tmux again. tmux narrows the listing with its own filter where it can evaluate one exactly, and every row is then checked against the portable filters.

Members8 members#

Common operations8 members#

  • atMostOne function Reads the sole match, or None when nothing matches; several matches raise.
  • exactlyOne function Reads the sole match, or why there is not exactly one.
  • list function Reads the matching objects in tmux's listing order.
  • matching function Filters captured objects locally, preserving input order and multiplicity.
  • tryExactlyOne function Reads the sole match, or None when there are none or several.
  • whereUnsafe function Adds a raw tmux filter, which tmux evaluates and nothing rechecks.
  • showing function Keeps panes whose visible rows show the searched text.
  • where function Adds a portable filter every result satisfies.
Esc

Type to search.