Auto Light Dark

Core LibraryAPI Reference

Choose documentation 3

latest

Current version

English

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

C# API

class libtmux-dotnet latest

QueryFieldDescriptor

Namespace L.Query LibTmux.Query

Describes one field accepted by the current portable query schema.

View as Markdown

Source and package

Module: LibTmux.Query
Package: LibTmux
Source: src/LibTmux/Query/QueryFieldDescriptor.cs

class LibTmux.Query.QueryFieldDescriptor class [source] ¶: Description#

Property paths describe built-in entity bindings. A schema-only field has no property path. Uncaptured state still throws; it is not a nullable field value.

Members10 members#

Other members10 members#

Cardinality property Gets the relation cardinality, or null for a scalar-only field.
IsNullable property Gets whether the captured native scalar can be null, or null without a scalar binding.
MinimumSnapshotDepth property Gets the field's minimum hierarchy capture depth, or null outside that hierarchy.
Operators property Gets the accepted wire operation names for this field.
RelatedTarget property Gets the related target kind, or null for a scalar-only field.
RelationPropertyPath property Gets the native relation property path, or null without a relation binding.
ScalarPropertyPath property Gets the native scalar property path, or null without a scalar binding.
Target property Gets the target that owns this field.
ValueKind property Gets the scalar type, or null for a to-one relation.
WireName property Gets the field name used in query JSON.