package yaml
import "k8s.io/apimachinery/pkg/util/yaml"
Index ¶
- func IsJSONBuffer(buf []byte) bool
- func NewDocumentDecoder(r io.ReadCloser) io.ReadCloser
- func ToJSON(data []byte) ([]byte, error)
- func Unmarshal(data []byte, v interface{}) error
- func UnmarshalStrict(data []byte, v interface{}) error
- type JSONSyntaxError
- type LineReader
- type Reader
- type StreamReader
- func GuessJSONStream(r io.Reader, size int) (*StreamReader, []byte, bool)
- func NewStreamReader(r io.Reader, size int) *StreamReader
- func (r *StreamReader) Consume(n int)
- func (r *StreamReader) Consumed() int
- func (r *StreamReader) Peek(n int) ([]byte, error)
- func (r *StreamReader) Read(p []byte) (n int, err error)
- func (r *StreamReader) ReadN(want int) ([]byte, error)
- func (r *StreamReader) Rewind()
- func (r *StreamReader) RewindN(n int)
- type YAMLDecoder
- type YAMLOrJSONDecoder
- func NewYAMLOrJSONDecoder(r io.Reader, bufferSize int) *YAMLOrJSONDecoder
- func (d *YAMLOrJSONDecoder) Decode(into interface{}) error
- type YAMLReader
- type YAMLSyntaxError
- type YAMLToJSONDecoder
Functions ¶
func IsJSONBuffer ¶
IsJSONBuffer scans the provided buffer, looking for an open brace indicating this is JSON.
func NewDocumentDecoder ¶
func NewDocumentDecoder(r io.ReadCloser) io.ReadCloser
NewDocumentDecoder decodes YAML documents from the provided stream in chunks by converting each document (as defined by the YAML spec) into its own chunk. io.ErrShortBuffer will be returned if the entire buffer could not be read to assist the caller in framing the chunk.
func ToJSON ¶
ToJSON converts a single YAML document into a JSON document or returns an error. If the document appears to be JSON the YAML decoding path is not used (so that error messages are JSON specific).
func Unmarshal ¶
Unmarshal unmarshals the given data If v is a *map[string]interface{}, *[]interface{}, or *interface{} numbers are converted to int64 or float64
func UnmarshalStrict ¶
UnmarshalStrict unmarshals the given data strictly (erroring when there are duplicate fields).
Types ¶
type JSONSyntaxError ¶
func (JSONSyntaxError) Error ¶
func (e JSONSyntaxError) Error() string
type LineReader ¶
type LineReader struct {
// contains filtered or unexported fields
}
func (*LineReader) Read ¶
func (r *LineReader) Read() ([]byte, error)
Read returns a single line (with '\n' ended) from the underlying reader. An error is returned iff there is an error with the underlying reader.
type Reader ¶
type StreamReader ¶
type StreamReader struct {
// contains filtered or unexported fields
}
StreamReader is a reader designed for consuming streams of variable-length messages. It buffers data until it is explicitly consumed, and can be rewound to re-read previous data.
func GuessJSONStream ¶
GuessJSONStream scans the provided reader up to size, looking for an open brace indicating this is JSON. It will return the bufio.Reader it creates for the consumer.
func NewStreamReader ¶
func NewStreamReader(r io.Reader, size int) *StreamReader
NewStreamReader creates a new StreamReader wrapping the provided io.Reader.
func (*StreamReader) Consume ¶
func (r *StreamReader) Consume(n int)
Consume discards up to n bytes of previously read data from the beginning of the buffer. Once consumed, that data is no longer available for rewinding. If n is greater than the current buffer, the buffer is cleared. Consume never consume data from the underlying reader.
func (*StreamReader) Consumed ¶
func (r *StreamReader) Consumed() int
Consumed returns the number of bytes consumed from the input reader.
func (*StreamReader) Peek ¶
func (r *StreamReader) Peek(n int) ([]byte, error)
Peek returns the next n bytes without advancing the reader. The returned bytes are valid until the next call to Consume.
func (*StreamReader) Read ¶
func (r *StreamReader) Read(p []byte) (n int, err error)
Read implements io.Reader. It first returns any buffered data after the current offset, and if that's exhausted, reads from the underlying reader and buffers the data. The returned data is not considered consumed until the Consume method is called.
func (*StreamReader) ReadN ¶
func (r *StreamReader) ReadN(want int) ([]byte, error)
ReadN reads exactly n bytes from the reader, blocking until all bytes are read or an error occurs. If an error occurs, the number of bytes read is returned along with the error. If EOF is hit before n bytes are read, this will return the bytes read so far, along with io.EOF. The returned data is not considered consumed until the Consume method is called.
func (*StreamReader) Rewind ¶
func (r *StreamReader) Rewind()
Rewind resets the reader to the beginning of the buffered data.
func (*StreamReader) RewindN ¶
func (r *StreamReader) RewindN(n int)
RewindN rewinds the reader by n bytes. If n is greater than the current buffer, the reader is rewound to the beginning of the buffer.
type YAMLDecoder ¶
type YAMLDecoder struct {
// contains filtered or unexported fields
}
YAMLDecoder reads chunks of objects and returns ErrShortBuffer if the data is not sufficient.
func (*YAMLDecoder) Close ¶
func (d *YAMLDecoder) Close() error
func (*YAMLDecoder) Read ¶
func (d *YAMLDecoder) Read(data []byte) (n int, err error)
Read reads the previous slice into the buffer, or attempts to read the next chunk. TODO: switch to readline approach.
type YAMLOrJSONDecoder ¶
type YAMLOrJSONDecoder struct {
// contains filtered or unexported fields
}
YAMLOrJSONDecoder attempts to decode a stream of JSON or YAML documents. While JSON is YAML, the way Go's JSON decode defines a multi-document stream is a series of JSON objects (e.g. {}{}), but YAML defines a multi-document stream as a series of documents separated by "---".
This decoder will attempt to decode the stream as JSON first, and if that fails, it will switch to YAML. Once it determines the stream is JSON (by finding a non-YAML-delimited series of objects), it will not switch to YAML. Once it switches to YAML it will not switch back to JSON.
func NewYAMLOrJSONDecoder ¶
func NewYAMLOrJSONDecoder(r io.Reader, bufferSize int) *YAMLOrJSONDecoder
NewYAMLOrJSONDecoder returns a decoder that will process YAML documents or JSON documents from the given reader as a stream. bufferSize determines how far into the stream the decoder will look to figure out whether this is a JSON stream (has whitespace followed by an open brace).
func (*YAMLOrJSONDecoder) Decode ¶
func (d *YAMLOrJSONDecoder) Decode(into interface{}) error
Decode unmarshals the next object from the underlying stream into the provide object, or returns an error.
type YAMLReader ¶
type YAMLReader struct {
// contains filtered or unexported fields
}
func NewYAMLReader ¶
func NewYAMLReader(r *bufio.Reader) *YAMLReader
func (*YAMLReader) Read ¶
func (r *YAMLReader) Read() ([]byte, error)
Read returns a full YAML document.
type YAMLSyntaxError ¶
type YAMLSyntaxError struct {
// contains filtered or unexported fields
}
func (YAMLSyntaxError) Error ¶
func (e YAMLSyntaxError) Error() string
type YAMLToJSONDecoder ¶
type YAMLToJSONDecoder struct {
// contains filtered or unexported fields
}
YAMLToJSONDecoder decodes YAML documents from an io.Reader by separating individual documents. It first converts the YAML body to JSON, then unmarshals the JSON.
func NewYAMLToJSONDecoder ¶
func NewYAMLToJSONDecoder(r io.Reader) *YAMLToJSONDecoder
NewYAMLToJSONDecoder decodes YAML documents from the provided stream in chunks by converting each document (as defined by the YAML spec) into its own chunk, converting it to JSON via yaml.YAMLToJSON, and then passing it to json.Decoder.
func (*YAMLToJSONDecoder) Decode ¶
func (d *YAMLToJSONDecoder) Decode(into interface{}) error
Decode reads a YAML document as JSON from the stream or returns an error. The decoding rules match json.Unmarshal, not yaml.Unmarshal.
func (*YAMLToJSONDecoder) InputOffset ¶
func (d *YAMLToJSONDecoder) InputOffset() int
Source Files ¶
decoder.go stream_reader.go
- Version
- v0.33.0-rc.1
- Published
- Apr 11, 2025
- Platform
- js/wasm
- Imports
- 11 packages
- Last checked
- 1 day ago –
Tools for package owners.