layout

package

v0.51.0 Latest Latest Go to latest Published: Sep 25, 2026 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/open-rails/contentkit

Links

Open Source Insights

Documentation ¶

Overview ¶

Package layout defines media object keys, dependency-free so the access worker can classify paths without importing the media runtime:

{tenant}/{kind}/{content_id}/manifest.json         the item's one manifest; never served
                            /originals/sha256-{hex} uploads; never served
                            /staging/u-{uuid}       multipart uploads until placed; never served
                            /private/sha256-{hex}   every rendition; token-gated
                            /public/sha256-{hex}    copies of the exposed renditions; anyone

Every name but staging's is the SHA-256 of the object, so objects are immutable: a change writes a new name.

Index ¶

Constants
func ParseSHA256Name(name string) ([]byte, bool)
func SourceArea(name string) string
func ValidHashName(name string) bool
func ValidInlineName(name string) bool
func ValidSegment(s string) bool
func ValidSourceName(name string) bool
func ValidStagedName(name string) bool
type Key
- func Parse(key string) (Key, bool)

Constants ¶

View Source

const (
	AreaManifest  = "manifest"
	AreaOriginals = "originals"
	AreaStaging   = "staging"
	AreaPrivate   = "private"
	AreaPublic    = "public"
)

Folder areas.

View Source

const (
	SHA256Prefix = "sha256-"
	UploadPrefix = "u-"
	InlinePrefix = "i-"
)

View Source

const ManifestName = "manifest.json"

ManifestName is the manifest's key within the folder.

Variables ¶

This section is empty.

Functions ¶

func ParseSHA256Name ¶

func ParseSHA256Name(name string) ([]byte, bool)

ParseSHA256Name returns the digest of a "sha256-{hex}" name.

func SourceArea ¶ added in v0.40.0

func SourceArea(name string) string

SourceArea is where an uploaded file named name lives: staging/ for a "u-{uuid}" not yet placed, originals/ for a "sha256-{hex}".

func ValidHashName ¶ added in v0.48.0

func ValidHashName(name string) bool

ValidHashName accepts "sha256-{64 lowercase hex}".

func ValidInlineName ¶ added in v0.17.0

func ValidInlineName(name string) bool

ValidInlineName accepts "i-{uuid}", an inline image's id.

func ValidSegment ¶

func ValidSegment(s string) bool

ValidSegment keeps keys stable ASCII: [A-Za-z0-9._-]{1,128}, no leading dot.

func ValidSourceName ¶ added in v0.48.0

func ValidSourceName(name string) bool

ValidSourceName accepts an uploaded file's name: a hash, or "u-{uuid}" until the worker places it.

func ValidStagedName ¶ added in v0.40.0

func ValidStagedName(name string) bool

ValidStagedName accepts "u-{uuid}", an upload whose hash is not yet known.

Types ¶

type Key ¶

type Key struct {
	Tenant, Kind, ID string
	Area             string
	Name             string // file name within the area; "" for the manifest
}

Key is a parsed object key.

func Parse ¶

func Parse(key string) (Key, bool)

Parse classifies an object key; ok is false for anything outside the layout.

Source Files ¶

View all Source files

layout.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL