Module layout 

Path vocabulary for declared trees: RelPath, collection paths and resource keys.

A repo-relative path is gateways/<g>/resources/<module>/<type>/...; its collection path drops the resources/ prefix and is what the gateway holds under its resource collection directory (<module>/<type>/...). All paths are /-separated UTF-8 and compare as raw bytes: no normalization, no case folding (DRND-01 encoding edge).

Structs

RelPath

A validated /-separated relative path.

ResourceKey

The identity of one gateway resource.

Enums

KeyCollection

The collection a write-half key names (split_key).

Constants

CORE_KEY_PREFIX

The prefix that names the core collection in the write half’s keys (quick 261102-cef, A2): .core/<collection path>.

PAIR_UNSYNCED_TAG_TYPES

The two tag types a redundant pair cannot carry in a mode collection (debug deploy-tag-redundancy-sync, captured on an 8.3.6 pair).

TAG_TYPES

The four tag types the gateway writes under ignition/ for a tag provider, in the order a provider is built (21-02 capture, decision CD5).

Functions

collection_path

Gateway-relative path to collection path.

core_key

The core key of the collection path path.

is_pair_unsynced_tag_path

Whether the collection path path is the type folder of one of the PAIR_UNSYNCED_TAG_TYPES (ignition/tag-definition) or below it. Exact bytes, as every collection path compares.

repo_path

Collection path to gateway-relative repo path: the exact inverse of collection_path (CD5), used by deploy pull to place live files.

resource_key

The resource a collection path belongs to: module and type from components 1 and 2, the name from component 3 only when a 4th exists (otherwise component 3 is a file of a singleton).

route

The write-half key of the collection path path on a target of redundancy (decision D1 of quick 261102-cef): its core_key when the target is a redundant pair and path is a PAIR_UNSYNCED_TAG_TYPES path (is_pair_unsynced_tag_path), else path itself. The one routing rule plan, apply and verify share.

split_key

The collection key names and its collection path: a CORE_KEY_PREFIX key is core and the rest after the prefix, any other key is the mode collection and the key itself.

tag_provider

The tag provider directory a gateway-relative tags/<P>/... path sits in.