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: 1 Imported by: 0

Documentation

Overview

Package types catalogs github.com/compose-spec/compose-go/v2/template 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/template

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config = template.Config

Config wraps template.Config.

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

type InvalidTemplateError

type InvalidTemplateError = template.InvalidTemplateError

InvalidTemplateError wraps template.InvalidTemplateError.

InvalidTemplateError is returned when a variable template is not in a valid format

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

type Mapping

type Mapping = template.Mapping

Mapping wraps template.Mapping.

Mapping is a user-supplied function which maps from variable names to values. Returns the value as a string and a bool indicating whether the value is present, to distinguish between an empty string and the absence of a value.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/template#Mapping GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/template/template.go Kind: func Underlying: func(string) (string, bool) Usecase: wrap compose-go template machinery used while loading a Project.

type MissingRequiredError

type MissingRequiredError = template.MissingRequiredError

MissingRequiredError wraps template.MissingRequiredError.

MissingRequiredError is returned when a variable template is missing

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

type Option

type Option = template.Option

Option wraps template.Option.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/template#Option GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/template/template.go Kind: func Underlying: func(*Config) Usecase: wrap compose-go template machinery used while loading a Project.

type ReplacementFunc

type ReplacementFunc = template.ReplacementFunc

ReplacementFunc wraps template.ReplacementFunc.

ReplacementFunc is a user-supplied function that is apply to the matching substring. Returns the value as a string and an error.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/template#ReplacementFunc GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/template/template.go Kind: func Underlying: func(string, Mapping, *Config) (string, error) Usecase: wrap compose-go template machinery used while loading a Project.

type SubstituteFunc

type SubstituteFunc = template.SubstituteFunc

SubstituteFunc wraps template.SubstituteFunc.

SubstituteFunc is a user-supplied function that apply substitution. Returns the value as a string, a bool indicating if the function could apply the substitution and an error.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/template#SubstituteFunc GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/template/template.go Kind: func Underlying: func(string, Mapping) (string, bool, error) Usecase: wrap compose-go template machinery used while loading a Project.

type Variable

type Variable = template.Variable

Variable wraps template.Variable.

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

Jump to

Keyboard shortcuts

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