Skip to main content

Module layout

Module layout 

Source
Expand description

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.

Constants§

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.
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).
tag_provider
The tag provider directory a gateway-relative tags/<P>/... path sits in.