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

CapturedValue

Namespace LibTmux

Holds the one child a snapshot captured for a relation, if it read it.

View as Markdown

Source and package

Module: LibTmux
Package: LibTmux
Source: src/LibTmux/Snapshots/CapturedValue.cs

class LibTmux.CapturedValue class [source] ¶: Description#

A relation that holds at most one child says so in its type. An uncaptured value is not an absent one: reading Value when the snapshot never looked throws IncompleteSnapshotException rather than answering null, so a caller cannot mistake unread state for absent state.

Members6 members#

Common operations2 members#

IsCaptured property Gets whether the snapshot read this relation.
Value property Gets the captured child.

Other members4 members#

CapturedDepth property Gets the depth the owning snapshot reached.
OrNull method Gets the captured child, or null when the snapshot never read it.
Relation property Gets the relation name this instance carries.
TryGetValue method Tries to read the captured child.