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

Filter

Namespace LibTmux.FSharp.Filter LibTmux.FSharp

Describes a validated portable predicate over one entity type.

View as Markdown

Source and package
Module
LibTmux.FSharp
Package
LibTmux.FSharp
Source
src/LibTmux.FSharp/Query.fsi
type Filtermodule Filter
class [source]

Discussed in Filtering and queries · Query fields

Members26 members#

Common operations24 members#

  • all function Requires every child to match, returning true for an empty captured relation.
  • any function Requires a matching child, returning false for an empty captured relation.
  • matches function Matches a string against a culture-invariant .NET regular expression.
  • none function Requires no matching child, returning true for an empty captured relation.
  • allOf function Requires every predicate in order; an empty list matches everything.
  • anyOf function Requires at least one predicate in order; an empty list matches nothing.
  • contains function Matches a string containing a substring.
  • containsIgnoreCase function Matches a string containing a substring ignoring case.
  • endsWith function Matches a string suffix.
  • endsWithIgnoreCase function Matches a string suffix ignoring case.
  • eq function Matches a field equal to a constant.
  • eqIgnoreCase function Matches a string equal to a constant ignoring case.
  • ge function Matches a count at least a constant.
  • gt function Matches a count above a constant.
  • isNull function Matches a captured null string without treating an uncaptured field as absent.
  • le function Matches a count at most a constant.
  • lt function Matches a count below a constant.
  • matchesIgnoreCase function Matches a string against a culture-invariant .NET regular expression ignoring case.
  • ne function Matches a field not equal to a constant.
  • negate function Negates a portable predicate.
  • notOneOf function Matches no constant in a list; an empty list matches everything.
  • oneOf function Matches any constant in a list; an empty list matches nothing.
  • startsWith function Matches a string prefix.
  • startsWithIgnoreCase function Matches a string prefix ignoring case.

Other members2 members#

  • toDocument function Returns the core document validated when the filter was constructed.
  • toPredicate function Returns a predicate compiled once for native lazy filtering.
Esc

Type to search.