Skip to main content

Module path

Module path 

Source
Expand description

The paths that address things in the data model (Core §10.6.2, §10.6.7, §10.6.8, §10.6.11).

A path names an attribute, event or command somewhere in a node’s tree of endpoints and clusters. Three of the four are wildcardable: omitting a field means “all of them”, which is how a client reads a whole endpoint in one action instead of enumerating it.

§Why these are lists and not structures

Every other information block is a TLV structure. The paths are Lists, and the reason shows up in §10.6.2: ListIndex may repeat conceptually, and more importantly a list permits the tag-compression scheme where fields are omitted and inherited from an earlier path in the same action. A structure’s “unique tags, all present that the schema requires” reading does not fit that.

§Wildcards are absence, not a value

There is no “wildcard” marker. §10.6.2.1: “omission of any of the tags in question (with the exception of Node) indicates wildcard semantics”. So every wildcardable field here is an Option, and None means all, not unknown — which is why AttributePath::concrete exists to say whether a path names exactly one thing.

§Tag compression is provisional and not implemented

§10.6.2.1 defines an EnableTagCompression flag whose omitted fields inherit from “the last AttributePathIB that had EnableTagCompression not present or set to false … seen in a message that is part of the same interaction model Action”. The specification marks it provisional. It is decoded and preserved — a path that sets it round-trips — but this crate does not resolve it, and AttributePath::enable_tag_compression being true is something a caller must refuse rather than misread, because the alternative is silently treating an inherited field as a wildcard.

Structs§

AttributePath
AttributePathIB (§10.6.2).
ClusterPath
ClusterPathIB (§10.6.7) — a path with no attribute, used by data-version filters.
CommandPath
CommandPathIB (§10.6.11).
EventPath
EventPathIB (§10.6.8).
WildcardPathFlags
WildcardPathFlags — which kinds of attribute a wildcard expansion skips (§2.13.2).

Enums§

ListIndex
ListIndex when the path means “append to this list” (§10.6.4.3.1).

Type Aliases§

AttributeId
An attribute identifier (§7.5).
ClusterId
A cluster identifier (§7.5).
CommandId
A command identifier (§7.5).
EndpointId
An endpoint identifier (§7.5).
EventId
An event identifier (§7.5).