FilterSchema
The filtering vocabulary, as a document.
Source and package
- Qualified name
-
FilterSchema - Package
- libtmux-swift
- Source
- Sources/LibTmux/FilterSchema.swift
- struct FilterSchema : struct Filter
Schema -
Description#
A
FilterExprnames fields by wire id, which is only useful to another language if that language can learn what the ids are. This is that document: versioned,Codable, and generated from the same registry the Swift API lowers through, so a TypeScript, Rust, or CLI consumer reads the vocabulary rather than guessing it.
Members8#
- current: static var current: Filter
Schema property The vocabulary this build understands. - Field: struct Field struct One filterable field, and every name that reaches it.
- field(named:in:) method The field an id or alias names, within one model.
- Model: struct Model struct The filterable fields of one type.
- models: let models: [Model] property One entry per filterable type, named as a client would ask for it.
- schemaVersion: let schema
Version : Int property Theversionthis document was written with, so a reader can tell whether it understands the shape before trying to use it. - ValueType: enum Value
Type enum The kinds of value a field can hold. Deliberately three: tmux reports everything as text, and these are the only distinctions a filter has to make to compare correctly. - version: static let version: Int property Bumped when the document's shape changes. Adding a field or an alias does not bump it; those are additive and old readers keep working.
Inherited members2 members#
Reached through Equatable.!=(_:_:), Decodable.init(from:).
- !=(_:_:) function inherited Returns a Boolean value indicating whether two values are not equal.
- init(from:) method inherited Creates a new instance by decoding from the given decoder.