types

package
v0.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 16, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package types catalogs github.com/compose-spec/compose-go/v2/loader for wrapping by containerkit.

Code generated by go run ./tools/gencatalog; DO NOT EDIT.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/loader

Each identifier keeps the exact upstream type name. Domain isolation lives in the import path (internal/compose/loader/types), not in renamed aliases.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func LoadWithContext

func LoadWithContext(ctx context.Context, configDetails composetypes.ConfigDetails, options ...func(*Options)) (*composetypes.Project, error)

LoadWithContext reads Compose YAML from ConfigDetails and returns a Project.

Types

type Listener

type Listener = loader.Listener

Listener wraps loader.Listener.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/loader#Listener GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/loader/loader.go Kind: func Underlying: func(event string, metadata map[string]any) Usecase: wrap compose-go loader machinery used while loading a Project.

type NoopPostProcessor

type NoopPostProcessor = loader.NoopPostProcessor

NoopPostProcessor wraps loader.NoopPostProcessor.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/loader#NoopPostProcessor GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/loader/loader.go Kind: struct Usecase: wrap compose-go loader machinery used while loading a Project.

type Options

type Options = loader.Options

Options wraps loader.Options.

Options supported by Load

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/loader#Options GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/loader/loader.go Kind: struct References: github.com/compose-spec/compose-go/v2/interpolation.Options Usecase: wrap compose-go loader machinery used while loading a Project.

type PostProcessor

type PostProcessor = loader.PostProcessor

PostProcessor wraps loader.PostProcessor.

PostProcessor is used to tweak compose model based on metadata extracted during yaml Unmarshal phase that hardly can be implemented using go-yaml and mapstructure

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/loader#PostProcessor GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/loader/loader.go Kind: interface Usecase: wrap compose-go loader machinery used while loading a Project.

type ResetProcessor

type ResetProcessor = loader.ResetProcessor

ResetProcessor wraps loader.ResetProcessor.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/loader#ResetProcessor GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/loader/reset.go Kind: struct References: github.com/compose-spec/compose-go/v2/tree.Path, go.yaml.in/yaml/v4.Node Usecase: wrap compose-go loader machinery used while loading a Project.

type ResourceLoader

type ResourceLoader = loader.ResourceLoader

ResourceLoader wraps loader.ResourceLoader.

ResourceLoader is a plugable remote resource resolver

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/loader#ResourceLoader GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/loader/loader.go Kind: interface References: context.Context Usecase: wrap compose-go loader machinery used while loading a Project.

type UnsupportedAttribute

type UnsupportedAttribute = loader.UnsupportedAttribute

UnsupportedAttribute wraps loader.UnsupportedAttribute.

UnsupportedAttribute is a single instance of a caller-supplied UnsupportedAttributePattern matching the loaded compose model.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/loader#UnsupportedAttribute GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/loader/unsupported_attributes.go Kind: struct References: github.com/compose-spec/compose-go/v2/tree.Path Usecase: wrap compose-go loader machinery used while loading a Project.

type UnsupportedAttributePattern

type UnsupportedAttributePattern = loader.UnsupportedAttributePattern

UnsupportedAttributePattern wraps loader.UnsupportedAttributePattern.

UnsupportedAttributePattern identifies a compose-file attribute that is schema-valid but not honored by the caller's runtime. compose-go does not know what any given runtime supports: the list of patterns is supplied by the caller.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/loader#UnsupportedAttributePattern GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/loader/unsupported_attributes.go Kind: struct References: github.com/compose-spec/compose-go/v2/tree.Path Usecase: wrap compose-go loader machinery used while loading a Project.

type UnsupportedAttributesCheck

type UnsupportedAttributesCheck = loader.UnsupportedAttributesCheck

UnsupportedAttributesCheck wraps loader.UnsupportedAttributesCheck.

UnsupportedAttributesCheck bundles the detection rules with the callback invoked once, after loading, with every match found (possibly empty).

Detection combines two complementary rule sets over one walk:

  • Patterns is a denylist: attributes the caller knows it does not honor, with optional value predicates for cases like `ports[].mode: host`.
  • Supported is an allowlist: when non-empty, every attribute matching none of its paths is reported too. It makes the screening fail-closed — an attribute the specification gains later is reported until the runtime deliberately declares it. schema.AttributePaths returns the full specification inventory to build it from (remove what the runtime does not implement); extension keys (x-*) are never reported by this rule set.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/loader#UnsupportedAttributesCheck GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/loader/unsupported_attributes.go Kind: struct References: github.com/compose-spec/compose-go/v2/tree.Path Usecase: wrap compose-go loader machinery used while loading a Project.

Jump to

Keyboard shortcuts

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