Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Framer = jsonFramer{}
Framer is the default JSON framing behavior, with newlines delimiting individual objects.
var YAMLFramer = yamlFramer{}
YAMLFramer is the default JSON framing behavior, with newlines delimiting individual objects.
Functions ¶
func CaseSensitiveJSONIterator ¶
CaseSensitiveJSONIterator returns a jsoniterator API that's configured to be case-sensitive when unmarshalling, and otherwise compatible with the encoding/json standard library.
func IsJSONBuffer ¶
IsJSONBuffer scans the provided buffer, looking for an open brace indicating this is JSON.
func StrictCaseSensitiveJSONIterator ¶
StrictCaseSensitiveJSONIterator returns a jsoniterator API that's configured to be case-sensitive, but also disallows unknown fields when unmarshalling. It is compatible with the encoding/json standard library.
Types ¶
type Serializer ¶
type Serializer struct {
// contains filtered or unexported fields
}
Serializer handles encoding versioned objects into the proper JSON form
func NewSerializer ¶
func NewSerializer(pretty bool) *Serializer
NewSerializer creates a JSON serializer that handles encoding versioned objects into the proper JSON form. If typer is not nil, the object has the group, version, and kind fields set. Deprecated: use NewSerializerWithOptions instead.
func NewSerializerWithOptions ¶
func NewSerializerWithOptions(options SerializerOptions) *Serializer
NewSerializerWithOptions creates a JSON/YAML serializer that handles encoding versioned objects into the proper JSON/YAML form. If typer is not nil, the object has the group, version, and kind fields set. Options are copied into the Serializer and are immutable.
func NewYAMLSerializer ¶
func NewYAMLSerializer() *Serializer
NewYAMLSerializer creates a YAML serializer that handles encoding versioned objects into the proper YAML form. If typer is not nil, the object has the group, version, and kind fields set. This serializer supports only the subset of YAML that matches JSON, and will error if constructs are used that do not serialize to JSON. Deprecated: use NewSerializerWithOptions instead.
func (*Serializer) Decode ¶
Decode attempts to convert the provided data into YAML or JSON, extract the stored schema kind, apply the provided default gvk, and then load that data into an object matching the desired schema kind or the provided into. If into is *runtime.Unknown, the raw data will be extracted and no decoding will be performed. If into is not registered with the typer, then the object will be straight decoded using normal JSON/YAML unmarshalling. If into is provided and the original data is not fully qualified with kind/version/group, the type of the into will be used to alter the returned gvk. If into is nil or data's gvk different from into's gvk, it will generate a new Object with ObjectCreater.New(gvk) On success or most errors, the method will return the calculated schema kind. The gvk calculate priority will be originalData > default gvk > into
func (*Serializer) Identifier ¶
func (s *Serializer) Identifier() runtime.Identifier
Identifier implements runtime.Encoder interface.
func (*Serializer) RecognizesData ¶
func (s *Serializer) RecognizesData(data []byte) (ok, unknown bool, err error)
RecognizesData implements the RecognizingDecoder interface.
type SerializerOptions ¶
type SerializerOptions struct {
// Yaml: configures the Serializer to work with JSON(false) or YAML(true).
// When `Yaml` is enabled, this serializer only supports the subset of YAML that
// matches JSON, and will error if constructs are used that do not serialize to JSON.
Yaml bool
// Pretty: configures a JSON enabled Serializer(`Yaml: false`) to produce human-readable output.
// This option is silently ignored when `Yaml` is `true`.
Pretty bool
// Strict: configures the Serializer to return strictDecodingError's when duplicate fields are present decoding JSON or YAML.
// Note that enabling this option is not as performant as the non-strict variant, and should not be used in fast paths.
Strict bool
}
SerializerOptions holds the options which are used to configure a JSON/YAML serializer. example: (1) To configure a JSON serializer, set `Yaml` to `false`. (2) To configure a YAML serializer, set `Yaml` to `true`. (3) To configure a strict serializer that can return strictDecodingError, set `Strict` to `true`.
Source Files