Documentation
¶
Overview ¶
Package tomlkit is used to interpret AppConfig/TOML configuration units.
Index ¶
- Constants
- Variables
- type TOMLResourceProviderType
- func (*TOMLResourceProviderType) ContextPath(contextField string) string
- func (*TOMLResourceProviderType) DataType() api.DataType
- func (*TOMLResourceProviderType) DefaultResourceCategory() api.ResourceCategory
- func (*TOMLResourceProviderType) GetPathRegistry() api.AttributeNameToResourceTypeToPathToVisitorInfoType
- func (*TOMLResourceProviderType) NameSeparator() string
- func (*TOMLResourceProviderType) NativeToYAML(data []byte) ([]byte, error)
- func (*TOMLResourceProviderType) NormalizeName(name string) string
- func (*TOMLResourceProviderType) RemoveScopeFromResourceName(resourceName api.ResourceName) api.ResourceName
- func (*TOMLResourceProviderType) ResourceAndCategoryTypeMaps(docs gaby.Container) (resourceMap yamlkit.ResourceNameToCategoryTypesMap, ...)
- func (*TOMLResourceProviderType) ResourceCategoryGetter(doc *gaby.YamlDoc) (api.ResourceCategory, error)
- func (*TOMLResourceProviderType) ResourceNameGetter(doc *gaby.YamlDoc) (api.ResourceName, error)
- func (*TOMLResourceProviderType) ResourceTypeGetter(doc *gaby.YamlDoc) (api.ResourceType, error)
- func (*TOMLResourceProviderType) ResourceTypesAreSimilar(resourceTypeA, resourceTypeB api.ResourceType) bool
- func (*TOMLResourceProviderType) ScopelessResourceNamePath() api.ResolvedPath
- func (*TOMLResourceProviderType) SetResourceName(doc *gaby.YamlDoc, name string) error
- func (*TOMLResourceProviderType) TypeDescription() string
- func (*TOMLResourceProviderType) YAMLToNative(yamlData []byte) ([]byte, error)
Constants ¶
View Source
const ( ResourceTypeNoSchema = api.ResourceType("NoSchema") ResourceNameNoName = api.ResourceName("NoName") ConfigSchemaPath = api.ResolvedPath("configHub.configSchema") ConfigNamePath = api.ResolvedPath("configHub.configName") )
Variables ¶
View Source
var TOMLResourceProvider = &TOMLResourceProviderType{}
TOMLResourceProvider implements the ResourceProvider interface for AppConfig/TOML.
Functions ¶
This section is empty.
Types ¶
type TOMLResourceProviderType ¶
type TOMLResourceProviderType struct{}
func (*TOMLResourceProviderType) ContextPath ¶
func (*TOMLResourceProviderType) ContextPath(contextField string) string
func (*TOMLResourceProviderType) DataType ¶
func (*TOMLResourceProviderType) DataType() api.DataType
func (*TOMLResourceProviderType) DefaultResourceCategory ¶
func (*TOMLResourceProviderType) DefaultResourceCategory() api.ResourceCategory
DefaultResourceCategory returns the default resource category to assume, which is AppConfig in this case.
func (*TOMLResourceProviderType) GetPathRegistry ¶
func (*TOMLResourceProviderType) GetPathRegistry() api.AttributeNameToResourceTypeToPathToVisitorInfoType
func (*TOMLResourceProviderType) NameSeparator ¶
func (*TOMLResourceProviderType) NameSeparator() string
func (*TOMLResourceProviderType) NativeToYAML ¶
func (*TOMLResourceProviderType) NativeToYAML(data []byte) ([]byte, error)
NativeToYAML converts TOML data to YAML format using native libraries.
func (*TOMLResourceProviderType) NormalizeName ¶
func (*TOMLResourceProviderType) NormalizeName(name string) string
func (*TOMLResourceProviderType) RemoveScopeFromResourceName ¶
func (*TOMLResourceProviderType) RemoveScopeFromResourceName(resourceName api.ResourceName) api.ResourceName
func (*TOMLResourceProviderType) ResourceAndCategoryTypeMaps ¶
func (*TOMLResourceProviderType) ResourceAndCategoryTypeMaps(docs gaby.Container) (resourceMap yamlkit.ResourceNameToCategoryTypesMap, categoryTypeMap yamlkit.ResourceCategoryTypeToNamesMap, err error)
ResourceAndCategoryTypeMaps returns maps of all resources in the provided list of parsed YAML documents, from from names to categories+types and categories+types to names.
func (*TOMLResourceProviderType) ResourceCategoryGetter ¶
func (*TOMLResourceProviderType) ResourceCategoryGetter(doc *gaby.YamlDoc) (api.ResourceCategory, error)
ResourceCategoryGetter just returns ResourceCategoryAppConfig for TOML documents.
func (*TOMLResourceProviderType) ResourceNameGetter ¶
func (*TOMLResourceProviderType) ResourceNameGetter(doc *gaby.YamlDoc) (api.ResourceName, error)
ResourceNameGetter extracts the property configHub.configName, and returns NoName if not present.
func (*TOMLResourceProviderType) ResourceTypeGetter ¶
func (*TOMLResourceProviderType) ResourceTypeGetter(doc *gaby.YamlDoc) (api.ResourceType, error)
ResourceTypeGetter extracts the property configHub.configSchema, and returns NoSchema if not present.
func (*TOMLResourceProviderType) ResourceTypesAreSimilar ¶
func (*TOMLResourceProviderType) ResourceTypesAreSimilar(resourceTypeA, resourceTypeB api.ResourceType) bool
func (*TOMLResourceProviderType) ScopelessResourceNamePath ¶
func (*TOMLResourceProviderType) ScopelessResourceNamePath() api.ResolvedPath
func (*TOMLResourceProviderType) SetResourceName ¶
func (*TOMLResourceProviderType) SetResourceName(doc *gaby.YamlDoc, name string) error
func (*TOMLResourceProviderType) TypeDescription ¶
func (*TOMLResourceProviderType) TypeDescription() string
func (*TOMLResourceProviderType) YAMLToNative ¶
func (*TOMLResourceProviderType) YAMLToNative(yamlData []byte) ([]byte, error)
YAMLToNative converts YAML data to TOML format using native libraries.
Source Files
Click to show internal directories.
Click to hide internal directories.