Skip to main content

Module path

Module path 

Source
Expand description

Path domain types: S3Location and DisplayPath.

S3Location is the canonical “where am I” domain type consumed by every other module. DisplayPath is the breadcrumb-friendly view shown in the UI. Encoding between these forms and external URI/clipboard strings lives in encode.

§OCP contract

  • S3Location is the stable domain type — adding a field (e.g. version_id) is non-breaking.
  • No other module should percent-encode keys; all encoding is centralised in path::encode.
  • Three explicit views: canonical (brows3r://), display, and clipboard (s3://). Future views (presigned URL, CloudFront URL) are new functions in encode.

Modules§

encode
Encoding and decoding between S3Location and its various string forms.

Structs§

DisplayPath
Breadcrumb-friendly view of an S3Location.
S3Location
The canonical domain type for “where am I in S3”.