converter

Documentation

Overview

Package converter provides utilities for converting between various types.

Index

• func SanitizeName(name string) string
• type ContentType
• type Decoder
  • func FromContentType(ctype string, contents []byte) *Decoder
  • func FromFileName(fname string, contents []byte) *Decoder
  • func FromJSON(b []byte) *Decoder
  • func FromJSONString(s string) *Decoder
  • func FromYAML(b []byte) *Decoder
  • func FromYAMLString(s string) *Decoder
  • func (m *Decoder) AllowUnknownFields(allow bool) *Decoder
  • func (m *Decoder) ToBundle() (*bundle.Bundle, error)
  • func (m *Decoder) ToBundleBuilder() (*bundle.BundleBuilder, error)
  • func (m *Decoder) ToComponent() (*bundle.Component, error)
  • func (m *Decoder) ToComponentBuilder() (*bundle.ComponentBuilder, error)
  • func (m *Decoder) ToComponentSet() (*bundle.ComponentSet, error)
  • func (m *Decoder) ToJSONMap() (map[string]interface{}, error)
  • func (m *Decoder) ToObject(obj interface{}) error
  • func (m *Decoder) ToUnstructured() (*unstructured.Unstructured, error)
• type Encoder
  • func FromObject(obj interface{}) *Encoder
  • func (m *Encoder) ToContentType(ctype string) ([]byte, error)
  • func (m *Encoder) ToJSON() ([]byte, error)
  • func (m *Encoder) ToJSONString() (string, error)
  • func (m *Encoder) ToYAML() ([]byte, error)
  • func (m *Encoder) ToYAMLString() (string, error)
• type ObjectExporter
  • func (e *ObjectExporter) ExportAsMultiYAML() ([]string, error)
  • func (e *ObjectExporter) ExportAsYAML() (string, error)
• type UnstructuredConverter
  • func FromUnstructured(o *unstructured.Unstructured) *UnstructuredConverter
  • func (c *UnstructuredConverter) ExtractObjectMeta() *metav1.ObjectMeta
  • func (c *UnstructuredConverter) ToObject(obj interface{}) error

Functions

func SanitizeName

func SanitizeName(name string) string

SanitizeName sanitizes a metadata.name field, replacing unsafe characters with _ and truncating if it's longer than 253 characters.

Types

type ContentType

type ContentType string

ContentType for conversion.

var (
	// UnknownContent indicates content of unknown type.
	UnknownContent ContentType

	// YAML indicates YAML content.
	YAML ContentType = "yaml"

	// JSON indicates JSON content.
	JSON ContentType = "json"
)

type Decoder

type Decoder struct {
	// contains filtered or unexported fields
}

Decoder converts from an object's serialized format to an actual instance of the object. By default, the Decoder does not allow unknown fields.

func FromContentType

func FromContentType(ctype string, contents []byte) *Decoder

FromContentType takes an explicit content type to use for creating a conversion Decoder.

func FromFileName

func FromFileName(fname string, contents []byte) *Decoder

FromFileName creates a Decoder instance by guessing the type based on the file extension.

func FromJSON

func FromJSON(b []byte) *Decoder

FromJSON creates a Decoder instance from a JSON byte array.

func FromJSONString

func FromJSONString(s string) *Decoder

FromJSONString creates a Decoder instance from a JSON string.

func FromYAML

func FromYAML(b []byte) *Decoder

FromYAML creates a Decoder instance from a YAML byte array.

func FromYAMLString

func FromYAMLString(s string) *Decoder

FromYAMLString creates a Decoder instance from a YAML string.

func (*Decoder) AllowUnknownFields

func (m *Decoder) AllowUnknownFields(allow bool) *Decoder

AllowUnknownFields indicates whether to allow unknown fields during decoding.

func (*Decoder) ToBundle

func (m *Decoder) ToBundle() (*bundle.Bundle, error)

ToBundle converts input data to the Bundle type.

func (*Decoder) ToBundleBuilder

func (m *Decoder) ToBundleBuilder() (*bundle.BundleBuilder, error)

ToBundleBuilder converts input data to the BundleBuilder type.

func (*Decoder) ToComponent

func (m *Decoder) ToComponent() (*bundle.Component, error)

ToComponent converts input data to the Component type.

func (*Decoder) ToComponentBuilder

func (m *Decoder) ToComponentBuilder() (*bundle.ComponentBuilder, error)

ToComponentBuilder converts input data to the ComponentBuilder type.

func (*Decoder) ToComponentSet

func (m *Decoder) ToComponentSet() (*bundle.ComponentSet, error)

ToComponentSet converts input data to the ComponentSet type.

func (*Decoder) ToJSONMap

func (m *Decoder) ToJSONMap() (map[string]interface{}, error)

ToJSONMap converts from json/yaml data to a map of string-to-interface.

func (*Decoder) ToObject

func (m *Decoder) ToObject(obj interface{}) error

ToObject converts to an arbitrary object via standard YAML / JSON serialization.

func (*Decoder) ToUnstructured

func (m *Decoder) ToUnstructured() (*unstructured.Unstructured, error)

ToUnstructured converts input data to the Unstructured type.

type Encoder

type Encoder struct {
	// contains filtered or unexported fields
}

Encoder converts from an object to some serialized format for the object.

func FromObject

func FromObject(obj interface{}) *Encoder

FromObject creates a converting encodeer from an object.

func (*Encoder) ToContentType

func (m *Encoder) ToContentType(ctype string) ([]byte, error)

ToContentType converts to a custom content type.

func (*Encoder) ToJSON

func (m *Encoder) ToJSON() ([]byte, error)

ToJSON converts an object to JSON bytes slice

func (*Encoder) ToJSONString

func (m *Encoder) ToJSONString() (string, error)

ToJSONString converts an object to JSON string

func (*Encoder) ToYAML

func (m *Encoder) ToYAML() ([]byte, error)

ToYAML converts an object to YAML bytes slice

func (*Encoder) ToYAMLString

func (m *Encoder) ToYAMLString() (string, error)

ToYAMLString converts an object to YAML string

type ObjectExporter

type ObjectExporter struct {
	Objects []*unstructured.Unstructured
}

ObjectExporter exports cluster objects

func (*ObjectExporter) ExportAsMultiYAML

func (e *ObjectExporter) ExportAsMultiYAML() ([]string, error)

ExportAsMultiYAML converts cluster objects into multiple YAML files.

func (*ObjectExporter) ExportAsYAML

func (e *ObjectExporter) ExportAsYAML() (string, error)

ExportAsYAML converts cluster objects into single YAML file.

type UnstructuredConverter

type UnstructuredConverter struct {
	// contains filtered or unexported fields
}

UnstructuredConverter is a converter between unstructured.Unstructured and other types.

func FromUnstructured

func FromUnstructured(o *unstructured.Unstructured) *UnstructuredConverter

FromUnstructured creates an UnstructuredConverter.

func (*UnstructuredConverter) ExtractObjectMeta

func (c *UnstructuredConverter) ExtractObjectMeta() *metav1.ObjectMeta

ExtractObjectMeta creates an ObjectMeta object from an Unstructured object.

func (*UnstructuredConverter) ToObject

func (c *UnstructuredConverter) ToObject(obj interface{}) error

ToObject converts an Unstructured object to an arbitrary interface via JSON.