# Packages

No description provided by the author

# Functions

FromBytes returns a ReadCloser from the given byte content.
FromFile returns a ReadCloser from the given file, or a ReadCloser which returns the given file open error when read.
GetCommentSource retrieves the YAML tree used as the source for transferring comments for the given runtime.Object.
No description provided by the author
NewCRDConversionError creates a new CRDConversionError error.
NewFrameReader returns a FrameReader for the given ContentType and data in the ReadCloser.
NewFrameWriter returns a new FrameWriter for the given Writer and ContentType.
NewJSONFrameReader returns a FrameReader that supports both JSON.
NewJSONFrameWriter returns a FrameWriter that writes JSON frames without separation (i.e.
NewSerializer constructs a new serializer based on a scheme, and optionally a codecfactory.
NewUnrecognizedGroupError returns information about that the encountered group was unknown.
NewUnrecognizedKindError returns information about that the encountered kind (in a known group & version) was unknown.
NewUnrecognizedVersionError returns information about that the encountered version (in a known group) was unknown.
NewYAMLFrameReader returns a FrameReader that supports both YAML and JSON.
NewYAMLFrameWriter returns a FrameWriter that writes YAML frames separated by "---\n" This call is the same as NewFrameWriter(ContentTypeYAML, w).
ReadFrameList is a convenience method that reads all available frames from the FrameReader into a returned FrameList.
SetCommentSource sets the given YAML tree as the source for transferring comments for the given runtime.Object.
ToBytes returns a Writer which can be passed to NewFrameWriter.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WriteFrameList is a convenience method that writes a set of frames to a FrameWriter.

# Constants

ContentTypeJSON specifies usage of JSON as the content type.
ContentTypeYAML specifies usage of YAML as the content type.
CRDConversionErrorCauseConvertTo describes an error that was caused by ConvertFrom failing.
CRDConversionErrorCauseConvertTo describes an error that was caused by ConvertTo failing.
CRDConversionErrorCauseInvalidArgs describes an error that was caused by that conversion targets weren't Hub and Convertible.
CRDConversionErrorCauseConvertTo describes an error that was caused by that the scheme wasn't properly set up.
UnrecognizedTypeErrorCauseUnknownGroup describes that an unknown API group was encountered.
UnrecognizedTypeErrorCauseUnknownKind describes that an unknown kind for a known group and version was encountered.
UnrecognizedTypeErrorCauseUnknownVersion describes that an unknown API version for a known group was encountered.

# Variables

TODO: Investigate if we can just depend on `metav1.Object` interface compliance instead of needing to explicitly embed the `metav1.ObjectMeta` struct.
No description provided by the author
ErrUnsupportedContentType is returned if the specified content type isn't supported.
FrameOverflowErr is returned from FrameReader.ReadFrame when one frame exceeds the maximum size of 16 MB.

# Structs

CRDConversionError describes an error that occurred when converting CRD types.
No description provided by the author
No description provided by the author
UnrecognizedTypeError describes that no such group, version and/or kind was registered in the scheme.

# Interfaces

ContentTyped is an interface for objects that are specific to a set ContentType.
Converter is an interface that allows access to object conversion capabilities.
Decoder is a high-level interface for decoding Kubernetes API Machinery objects read from a FrameWriter.
Defaulter is a high-level interface for accessing defaulting functions in a scheme.
Encoder is a high-level interface for encoding Kubernetes API Machinery objects and writing them to a FrameWriter.
FrameReader is a content-type specific reader of a given ReadCloser.
FrameWriter is a ContentType-specific io.Writer that writes given frames in an applicable way to an underlying io.Writer stream.
Serializer is an interface providing high-level decoding/encoding functionality for types registered in a *runtime.Scheme.

# Type aliases

ContentType specifies a content type for Encoders, Decoders, FrameWriters and FrameReaders.
CRDConversionErrorCause is a typed string, describing the error cause for.
No description provided by the author
No description provided by the author
FrameList is a list of frames (byte arrays), used for convenience functions.
ReadCloser in this package is an alias for io.ReadCloser.
UnrecognizedTypeErrorCause is a typed string, describing the error cause for.
Writer in this package is an alias for io.Writer.