DataPathType
PackageReified.Data
Helpers for constructing, parsing, and rendering structured data paths.
Specification
Kind
Type
Members
10
Examples
0
emptySignature
DataPath.empty
nameSignature
DataPath.name name
indexSignature
DataPath.index index
appendNameSignature
DataPath.appendName name path
appendIndexSignature
DataPath.appendIndex index path
Summary
| Name | Signature | Synopsis |
|---|---|---|
| Operations | ||
| empty | DataPath.empty | The root structured data path. |
| name | DataPath.name name | Creates a one-segment path for a named source field. |
| index | DataPath.index index | Creates a one-segment path for a zero-based collection index. |
| appendName | DataPath.appendName name path | Appends a named source field segment to an input path. |
| appendIndex | DataPath.appendIndex index path | Appends a zero-based collection index segment to an input path. |
| ofSegments | DataPath.ofSegments segments | Creates a path from validated segments. |
| segments | DataPath.segments path | Returns the segments in an input path. |
| toString | DataPath.toString path | Renders a structured data path using names, dot separators, and bracketed indexes. |
| tryParse | DataPath.tryParse text | Attempts to parse a structured data path such as contacts[1].value. |
| parse | DataPath.parse text | Parses a structured data path or raises when the text is invalid. |